Class RestAPI

Index

Constructors

Methods

getFuturesLeadTraderStatus getFuturesLeadTradingSymbolWhitelist sendRequest sendSignedRequest

Constructors

constructor

new RestAPI(configuration: ConfigurationRestAPI): CopyTradingRestAPI.RestAPI
Parameters
- configuration: ConfigurationRestAPI
Returns CopyTradingRestAPI.RestAPI
- Defined in clients/copy-trading/src/rest-api/rest-api.ts:31

Methods

getFuturesLeadTraderStatus

getFuturesLeadTraderStatus(
requestParameters?: GetFuturesLeadTraderStatusRequest,
): Promise<RestApiResponse<GetFuturesLeadTraderStatusResponse>>
Get Futures Lead Trader Status Weight: 20
Parameters
- requestParameters: GetFuturesLeadTraderStatusRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFuturesLeadTraderStatusResponse>>
Throws
See
Binance API Documentation
- Defined in clients/copy-trading/src/rest-api/rest-api.ts:98

getFuturesLeadTradingSymbolWhitelist

getFuturesLeadTradingSymbolWhitelist(
requestParameters?: GetFuturesLeadTradingSymbolWhitelistRequest,
): Promise<RestApiResponse<GetFuturesLeadTradingSymbolWhitelistResponse>>
Get Futures Lead Trading Symbol Whitelist Weight: 20
Parameters
- requestParameters: GetFuturesLeadTradingSymbolWhitelistRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFuturesLeadTradingSymbolWhitelistResponse>>
Throws
See
Binance API Documentation
- Defined in clients/copy-trading/src/rest-api/rest-api.ts:115

sendRequest

sendRequest<T>(
    endpoint: string,
    method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH",
    queryParams?: Record<string, unknown>,
    bodyParams?: Record<string, unknown>,
): Promise<RestApiResponse<T>>
Generic function to send a request.
Type Parameters
- T
Parameters
- endpoint: string
  The API endpoint to call.
- method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"
  HTTP method to use (GET, POST, DELETE, etc.).
- queryParams: Record<string, unknown> = {}
  Query parameters for the request.
- bodyParams: Record<string, unknown> = {}
  Body parameters for the request.
Returns Promise<RestApiResponse<T>>
A promise resolving to the response data object.
- Defined in clients/copy-trading/src/rest-api/rest-api.ts:45

sendSignedRequest

sendSignedRequest<T>(
    endpoint: string,
    method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH",
    queryParams?: Record<string, unknown>,
    bodyParams?: Record<string, unknown>,
): Promise<RestApiResponse<T>>
Generic function to send a signed request.
Type Parameters
- T
Parameters
- endpoint: string
  The API endpoint to call.
- method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH"
  HTTP method to use (GET, POST, DELETE, etc.).
- queryParams: Record<string, unknown> = {}
  Query parameters for the request.
- bodyParams: Record<string, unknown> = {}
  Body parameters for the request.
Returns Promise<RestApiResponse<T>>
A promise resolving to the response data object.
- Defined in clients/copy-trading/src/rest-api/rest-api.ts:70