Class RestAPI

Index

Constructors

Methods

getSpotRebateHistoryRecords sendRequest sendSignedRequest

Constructors

constructor

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

Methods

getSpotRebateHistoryRecords

getSpotRebateHistoryRecords(
requestParameters?: GetSpotRebateHistoryRecordsRequest,
): Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>
Get Spot Rebate History Records

Weight(UID): 12000

Security Type: USER_DATA

Notes:
- The max interval between startTime and endTime is 30 days.
- If startTime and endTime are not sent, the recent 7 days' data will be returned.
- The earliest supported startTime is June 10, 2020.
- Return up to 200 records per request.
Parameters
- requestParameters: GetSpotRebateHistoryRecordsRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetSpotRebateHistoryRecordsResponse>>
Throws
See
Binance API Documentation
- Defined in clients/rebate/src/rest-api/rest-api.ts:103

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