Interface TradeApiInterface

TradeApi - interface TradeApi

interface TradeApiInterface {
    vipLoanBorrow(
        requestParameters: VipLoanBorrowRequest,
    ): Promise<RestApiResponse<VipLoanBorrowResponse>>;
    vipLoanFixedRateBorrow(
        requestParameters: VipLoanFixedRateBorrowRequest,
    ): Promise<RestApiResponse<VipLoanFixedRateBorrowResponse>>;
    vipLoanRenew(
        requestParameters: VipLoanRenewRequest,
    ): Promise<RestApiResponse<VipLoanRenewResponse>>;
    vipLoanRepay(
        requestParameters: VipLoanRepayRequest,
    ): Promise<RestApiResponse<VipLoanRepayResponse>>;
}

Implemented by

VIPLoanRestAPI.TradeApi

Index

Methods

vipLoanBorrow vipLoanFixedRateBorrow vipLoanRenew vipLoanRepay

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).
Parameters
- requestParameters: VipLoanBorrowRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanBorrowResponse>>
Throws
Memberof
TradeApiInterface
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:336

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).
Parameters
- requestParameters: VipLoanFixedRateBorrowRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanFixedRateBorrowResponse>>
Throws
Memberof
TradeApiInterface
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:356

vipLoanRenew

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

Weight(UID): 6000

Security Type: TRADE
Parameters
- requestParameters: VipLoanRenewRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanRenewResponse>>
Throws
Memberof
TradeApiInterface
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:372

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
TradeApiInterface
- Defined in clients/vip-loan/src/rest-api/modules/trade-api.ts:388