Class TradeApi

TradeApi - object-oriented interface TradeApi

Implements

VIPLoanRestAPI.TradeApiInterface

Index

Constructors

Methods

vipLoanBorrow vipLoanFixedRateBorrow vipLoanRenew vipLoanRepay

Constructors

constructor

new TradeApi(configuration: ConfigurationRestAPI): VIPLoanRestAPI.TradeApi
Parameters
- configuration: ConfigurationRestAPI
Returns VIPLoanRestAPI.TradeApi
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:595

Methods

vipLoanBorrow

vipLoanBorrow(
requestParameters: VipLoanBorrowRequest,
): Promise<RestApiResponse<VipLoanBorrowResponse>>
VIP loan is available for VIP users only.

Weight(UID): 6000

Security Type: TRADE

Notes:
- loanAccountId refers to the loan receiving account.
- Only master account applications are supported.
- loanAccountId and collateralAccountId must be under the same master account.
- loanTerm is mandatory if the user chooses a fixed rate (isFlexibleRate = FALSE).
- Every coin in collateralCoin is pledged from every account in collateralAccountId.
- To pledge a Simple Earn Flexible position, add <ASSET>-Earn (e.g. USDT-Earn) to collateralCoin together with its Spot asset (e.g. USDT,USDT-Earn). Sending <ASSET>-Earn without its Spot asset returns -10213.
- Rate limit: 1 request per 2 seconds per account.
Parameters
- requestParameters: VipLoanBorrowRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanBorrowResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.vipLoanBorrow
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:623

vipLoanFixedRateBorrow

vipLoanFixedRateBorrow(
requestParameters: VipLoanFixedRateBorrowRequest,
): Promise<RestApiResponse<VipLoanFixedRateBorrowResponse>>
Submit a fixed rate borrow request by matching market supply orders.

Weight(UID): 6000

Security Type: TRADE

Notes:
- Rate limit: 2 requests per second per account.
- When multiple supplyRequest entries are provided, all requestId values must correspond to the same borrowCoin and loanTerm (validated by collateral facade).
- Every coin in collateralCoin is pledged from every account in collateralAccountId.
- To pledge a Simple Earn Flexible position, add <ASSET>-Earn (e.g. BNB-Earn) to collateralCoin together with its Spot asset (e.g. BNB,BNB-Earn). Sending <ASSET>-Earn without its Spot asset returns -10213.
Parameters
- requestParameters: VipLoanFixedRateBorrowRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanFixedRateBorrowResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.vipLoanFixedRateBorrow
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:668

vipLoanRenew

vipLoanRenew(
requestParameters: VipLoanRenewRequest,
): Promise<RestApiResponse<VipLoanRenewResponse>>
VIP loan is available for VIP users only.

Weight(UID): 6000

Security Type: TRADE

Notes:
- Rate limit: 1 request per second per account.
Parameters
- requestParameters: VipLoanRenewRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanRenewResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.vipLoanRenew
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:710

vipLoanRepay

vipLoanRepay(
requestParameters: VipLoanRepayRequest,
): Promise<RestApiResponse<VipLoanRepayResponse>>
VIP loan is available for VIP users only.

Weight(UID): 6000

Security Type: TRADE
Parameters
- requestParameters: VipLoanRepayRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanRepayResponse>>
Throws
Memberof
TradeApi

See
Binance API Documentation
Implementation of TradeApiInterface.vipLoanRepay
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:744