Class RestAPI

Index

Constructors

Methods

checkCollateralRepayRate flexibleLoanAdjustLtv flexibleLoanBorrow flexibleLoanRepay getCryptoLoansIncomeHistory getFlexibleLoanAssetsData getFlexibleLoanBorrowHistory getFlexibleLoanCollateralAssetsData getFlexibleLoanInterestRateHistory getFlexibleLoanLiquidationHistory getFlexibleLoanLtvAdjustmentHistory getFlexibleLoanOngoingOrders getFlexibleLoanRepaymentHistory getLoanBorrowHistory getLoanLtvAdjustmentHistory getLoanRepaymentHistory sendRequest sendSignedRequest

Constructors

constructor

new RestAPI(configuration: ConfigurationRestAPI): CryptoLoanRestAPI.RestAPI
Parameters
- configuration: ConfigurationRestAPI
Returns CryptoLoanRestAPI.RestAPI
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:65

Methods

checkCollateralRepayRate

checkCollateralRepayRate(
requestParameters: CheckCollateralRepayRateRequest,
): Promise<RestApiResponse<CheckCollateralRepayRateResponse>>
Get the latest rate of collateral coin/loan coin when using collateral repay.

Weight(IP): 6000

Security Type: USER_DATA
Parameters
- requestParameters: CheckCollateralRepayRateRequest
  Request parameters.
Returns Promise<RestApiResponse<CheckCollateralRepayRateResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:138

flexibleLoanAdjustLtv

flexibleLoanAdjustLtv(
requestParameters: FlexibleLoanAdjustLtvRequest,
): Promise<RestApiResponse<FlexibleLoanAdjustLtvResponse>>
Flexible Loan Adjust LTV

Weight(UID): 6000

Security Type: TRADE

Notes:
- API key needs Spot & Margin Trading permission for this endpoint.
Parameters
- requestParameters: FlexibleLoanAdjustLtvRequest
  Request parameters.
Returns Promise<RestApiResponse<FlexibleLoanAdjustLtvResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:161

flexibleLoanBorrow

flexibleLoanBorrow(
requestParameters: FlexibleLoanBorrowRequest,
): Promise<RestApiResponse<FlexibleLoanBorrowResponse>>
Borrow Flexible Loan

Weight(IP): 6000

Security Type: TRADE

Notes:
- This endpoint is available for both master and sub-accounts.
- You can customize LTV by entering loanAmount and collateralAmount.
Parameters
- requestParameters: FlexibleLoanBorrowRequest
  Request parameters.
Returns Promise<RestApiResponse<FlexibleLoanBorrowResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:185

flexibleLoanRepay

flexibleLoanRepay(
requestParameters: FlexibleLoanRepayRequest,
): Promise<RestApiResponse<FlexibleLoanRepayResponse>>
Flexible Loan Repay

Weight(IP): 6000

Security Type: TRADE

Notes:
- repayAmount is mandatory even when fullRepayment = FALSE.
Parameters
- requestParameters: FlexibleLoanRepayRequest
  Request parameters.
Returns Promise<RestApiResponse<FlexibleLoanRepayResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:208

getCryptoLoansIncomeHistory

getCryptoLoansIncomeHistory(
requestParameters?: GetCryptoLoansIncomeHistoryRequest,
): Promise<RestApiResponse<GetCryptoLoansIncomeHistoryResponse>>
Get Crypto Loans Income History

Weight(UID): 6000

Security Type: USER_DATA

Notes:
- If startTime and endTime are both omitted, the most recent 7 days of data are returned.
- The maximum interval between startTime and endTime is 30 days.
Parameters
- requestParameters: GetCryptoLoansIncomeHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetCryptoLoansIncomeHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:410

getFlexibleLoanAssetsData

getFlexibleLoanAssetsData(
requestParameters?: GetFlexibleLoanAssetsDataRequest,
): Promise<RestApiResponse<GetFlexibleLoanAssetsDataResponse>>
Get interest rate and borrow limit of flexible loanable assets. The borrow limit is shown in USD value.

Weight(IP): 400

Security Type: USER_DATA
Parameters
- requestParameters: GetFlexibleLoanAssetsDataRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanAssetsDataResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:228

getFlexibleLoanBorrowHistory

getFlexibleLoanBorrowHistory(
requestParameters?: GetFlexibleLoanBorrowHistoryRequest,
): Promise<RestApiResponse<GetFlexibleLoanBorrowHistoryResponse>>
Get Flexible Loan Borrow History. It can be used to check history before 2024-02-27 08:00.

Weight(IP): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 180 days.
Parameters
- requestParameters: GetFlexibleLoanBorrowHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanBorrowHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:252

getFlexibleLoanCollateralAssetsData

getFlexibleLoanCollateralAssetsData(
requestParameters?: GetFlexibleLoanCollateralAssetsDataRequest,
): Promise<RestApiResponse<GetFlexibleLoanCollateralAssetsDataResponse>>
Get LTV information and collateral limit of flexible loan's collateral assets. The collateral limit is shown in USD value.

Weight(IP): 400

Security Type: USER_DATA
Parameters
- requestParameters: GetFlexibleLoanCollateralAssetsDataRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanCollateralAssetsDataResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:273

getFlexibleLoanInterestRateHistory

getFlexibleLoanInterestRateHistory(
requestParameters: GetFlexibleLoanInterestRateHistoryRequest,
): Promise<RestApiResponse<GetFlexibleLoanInterestRateHistoryResponse>>
Check Flexible Loan interest rate history

Weight(IP): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 90 days.
- Time is based on UTC+0.
Parameters
- requestParameters: GetFlexibleLoanInterestRateHistoryRequest
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanInterestRateHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:298

getFlexibleLoanLiquidationHistory

getFlexibleLoanLiquidationHistory(
requestParameters?: GetFlexibleLoanLiquidationHistoryRequest,
): Promise<RestApiResponse<GetFlexibleLoanLiquidationHistoryResponse>>
Get Flexible Loan Liquidation History

Weight(IP): 400

Security Type: USER_DATA
Parameters
- requestParameters: GetFlexibleLoanLiquidationHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanLiquidationHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:318

getFlexibleLoanLtvAdjustmentHistory

getFlexibleLoanLtvAdjustmentHistory(
requestParameters?: GetFlexibleLoanLtvAdjustmentHistoryRequest,
): Promise<RestApiResponse<GetFlexibleLoanLtvAdjustmentHistoryResponse>>
Get Flexible Loan LTV Adjustment History. It can be used to check history before 2024-02-27 08:00.

Weight(UID): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 180 days.
Parameters
- requestParameters: GetFlexibleLoanLtvAdjustmentHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanLtvAdjustmentHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:342

getFlexibleLoanOngoingOrders

getFlexibleLoanOngoingOrders(
requestParameters?: GetFlexibleLoanOngoingOrdersRequest,
): Promise<RestApiResponse<GetFlexibleLoanOngoingOrdersResponse>>
Get Flexible Loan Ongoing Orders

Weight(IP): 300

Security Type: USER_DATA
Parameters
- requestParameters: GetFlexibleLoanOngoingOrdersRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanOngoingOrdersResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:362

getFlexibleLoanRepaymentHistory

getFlexibleLoanRepaymentHistory(
requestParameters?: GetFlexibleLoanRepaymentHistoryRequest,
): Promise<RestApiResponse<GetFlexibleLoanRepaymentHistoryResponse>>
Get Flexible Loan Repayment History. It can be used to check history before 2024-02-27 08:00.

Weight(IP): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 180 days.
Parameters
- requestParameters: GetFlexibleLoanRepaymentHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetFlexibleLoanRepaymentHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:386

getLoanBorrowHistory

getLoanBorrowHistory(
requestParameters?: GetLoanBorrowHistoryRequest,
): Promise<RestApiResponse<GetLoanBorrowHistoryResponse>>
Get Loan Borrow History

Weight(IP): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 180 days.
Parameters
- requestParameters: GetLoanBorrowHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetLoanBorrowHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:434

getLoanLtvAdjustmentHistory

getLoanLtvAdjustmentHistory(
requestParameters?: GetLoanLtvAdjustmentHistoryRequest,
): Promise<RestApiResponse<GetLoanLtvAdjustmentHistoryResponse>>
Get Loan LTV Adjustment History

Weight(IP): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 180 days.
Parameters
- requestParameters: GetLoanLtvAdjustmentHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetLoanLtvAdjustmentHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:458

getLoanRepaymentHistory

getLoanRepaymentHistory(
requestParameters?: GetLoanRepaymentHistoryRequest,
): Promise<RestApiResponse<GetLoanRepaymentHistoryResponse>>
Get Loan Repayment History

Weight(IP): 400

Security Type: USER_DATA

Notes:
- If startTime and endTime are not sent, the recent 90-day data is returned.
- The max interval between startTime and endTime is 180 days.
Parameters
- requestParameters: GetLoanRepaymentHistoryRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetLoanRepaymentHistoryResponse>>
Throws
See
Binance API Documentation
- Defined in clients/crypto-loan/src/rest-api/rest-api.ts:482

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/crypto-loan/src/rest-api/rest-api.ts:80

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/crypto-loan/src/rest-api/rest-api.ts:106

Class RestAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CryptoLoanRestAPI.RestAPI

Methods

checkCollateralRepayRate

Parameters

Returns Promise<RestApiResponse<CheckCollateralRepayRateResponse>>

Throws

See

flexibleLoanAdjustLtv

Parameters

Returns Promise<RestApiResponse<FlexibleLoanAdjustLtvResponse>>

Throws

See

flexibleLoanBorrow

Parameters

Returns Promise<RestApiResponse<FlexibleLoanBorrowResponse>>

Throws

See

flexibleLoanRepay

Parameters

Returns Promise<RestApiResponse<FlexibleLoanRepayResponse>>

Throws

See

getCryptoLoansIncomeHistory

Parameters

Returns Promise<RestApiResponse<GetCryptoLoansIncomeHistoryResponse>>

Throws

See

getFlexibleLoanAssetsData

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanAssetsDataResponse>>

Throws

See

getFlexibleLoanBorrowHistory

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanBorrowHistoryResponse>>

Throws

See

getFlexibleLoanCollateralAssetsData

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanCollateralAssetsDataResponse>>

Throws

See

getFlexibleLoanInterestRateHistory

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanInterestRateHistoryResponse>>

Throws

See

getFlexibleLoanLiquidationHistory

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanLiquidationHistoryResponse>>

Throws

See

getFlexibleLoanLtvAdjustmentHistory

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanLtvAdjustmentHistoryResponse>>

Throws

See

getFlexibleLoanOngoingOrders

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanOngoingOrdersResponse>>

Throws

See

getFlexibleLoanRepaymentHistory

Parameters

Returns Promise<RestApiResponse<GetFlexibleLoanRepaymentHistoryResponse>>

Throws

See

getLoanBorrowHistory

Parameters

Returns Promise<RestApiResponse<GetLoanBorrowHistoryResponse>>

Throws

See

getLoanLtvAdjustmentHistory