Class RestAPI

Index

Constructors

Methods

getC2CTradeHistory sendRequest sendSignedRequest

Constructors

constructor

new RestAPI(configuration: ConfigurationRestAPI): C2CRestAPI.RestAPI
Parameters
- configuration: ConfigurationRestAPI
Returns C2CRestAPI.RestAPI
- Defined in clients/c2c/src/rest-api/rest-api.ts:25

Methods

getC2CTradeHistory

getC2CTradeHistory(
requestParameters?: GetC2CTradeHistoryRequest,
): Promise<RestApiResponse<GetC2CTradeHistoryResponse>>
Get C2C Trade History

Weight(IP): 1

Security Type: USER_DATA

Notes:
- The max interval between startTimestamp and endTimestamp is 30 days.
- If startTimestamp and endTimestamp are not sent, the recent 30 days' data is returned.
- You can only view data from the past 6 months. For all C2C orders, check https://c2c.binance.com/en/fiatOrder.
Parameters
- requestParameters: GetC2CTradeHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetC2CTradeHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/c2c/src/rest-api/rest-api.ts:102

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/c2c/src/rest-api/rest-api.ts:39

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/c2c/src/rest-api/rest-api.ts:65