Class RestAPI

Index

Constructors

Methods

checkVIPLoanCollateralAccount getBorrowInterestRate getCollateralAssetData getLoanableAssetsData getVIPLoanOngoingOrders queryApplicationStatus sendRequest sendSignedRequest vipLoanBorrow vipLoanRenew vipLoanRepay

Constructors

constructor

new RestAPI(configuration: ConfigurationRestAPI): VIPLoanRestAPI.RestAPI
Parameters
- configuration: ConfigurationRestAPI
Returns VIPLoanRestAPI.RestAPI
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:53

Methods

checkVIPLoanCollateralAccount

checkVIPLoanCollateralAccount(
requestParameters?: CheckVIPLoanCollateralAccountRequest,
): Promise<RestApiResponse<CheckVIPLoanCollateralAccountResponse>>
VIP loan is available for VIP users only

If the login account is loan account, all collateral accounts under the loan account can be queried. If the login account is collateral account, only the current collateral account can be queried.

Weight: 6000
Parameters
- requestParameters: CheckVIPLoanCollateralAccountRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<CheckVIPLoanCollateralAccountResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:215

getBorrowInterestRate

getBorrowInterestRate(
requestParameters: GetBorrowInterestRateRequest,
): Promise<RestApiResponse<GetBorrowInterestRateResponse>>
Get Borrow Interest Rate

Weight: 400
Parameters
- requestParameters: GetBorrowInterestRateRequest
  Request parameters.
Returns Promise<RestApiResponse<GetBorrowInterestRateResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:105

getCollateralAssetData

getCollateralAssetData(
requestParameters?: GetCollateralAssetDataRequest,
): Promise<RestApiResponse<GetCollateralAssetDataResponse>>
Get Collateral Asset Data

Weight: 400
Parameters
- requestParameters: GetCollateralAssetDataRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetCollateralAssetDataResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:122

getLoanableAssetsData

getLoanableAssetsData(
requestParameters?: GetLoanableAssetsDataRequest,
): Promise<RestApiResponse<GetLoanableAssetsDataResponse>>
Get interest rate and borrow limit of loanable assets. The borrow limit is shown in USD value.

Weight: 400
Parameters
- requestParameters: GetLoanableAssetsDataRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetLoanableAssetsDataResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:139

getVIPLoanOngoingOrders

getVIPLoanOngoingOrders(
requestParameters?: GetVIPLoanOngoingOrdersRequest,
): Promise<RestApiResponse<GetVIPLoanOngoingOrdersResponse>>
VIP loan is available for VIP users only.

Weight: 400
Parameters
- requestParameters: GetVIPLoanOngoingOrdersRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<GetVIPLoanOngoingOrdersResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:232

queryApplicationStatus

queryApplicationStatus(
requestParameters?: QueryApplicationStatusRequest,
): Promise<RestApiResponse<QueryApplicationStatusResponse>>
Query Application Status

Weight: 400
Parameters
- requestParameters: QueryApplicationStatusRequest = {}
  Request parameters.
Returns Promise<RestApiResponse<QueryApplicationStatusResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:249

sendRequest

sendRequest<T>(
    endpoint: string,
    method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH",
    params?: 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.).
- params: Record<string, unknown> = {}
  Query parameters for the request.
Returns Promise<RestApiResponse<T>>
A promise resolving to the response data object.
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:68

sendSignedRequest

sendSignedRequest<T>(
    endpoint: string,
    method: "GET" | "POST" | "DELETE" | "PUT" | "PATCH",
    params?: 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.).
- params: Record<string, unknown> = {}
  Query parameters for the request.
Returns Promise<RestApiResponse<T>>
A promise resolving to the response data object.
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:84

vipLoanBorrow

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

loanAccountId refer to loan receiving account Only master account applications are supported loanAccountId and collateralAccountId under same master account loanTerm is mandatory if user choose stable rate

Weight: 0
Parameters
- requestParameters: VipLoanBorrowRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanBorrowResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:161

vipLoanRenew

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

Weight: 6000
Parameters
- requestParameters: VipLoanRenewRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanRenewResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:178

vipLoanRepay

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

Weight: 6000
Parameters
- requestParameters: VipLoanRepayRequest
  Request parameters.
Returns Promise<RestApiResponse<VipLoanRepayResponse>>
Throws
See
Binance API Documentation
- Defined in clients/vip-loan/src/rest-api/rest-api.ts:195

Class RestAPI

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns VIPLoanRestAPI.RestAPI

Methods

checkVIPLoanCollateralAccount

Parameters

Returns Promise<RestApiResponse<CheckVIPLoanCollateralAccountResponse>>

Throws

See

getBorrowInterestRate

Parameters

Returns Promise<RestApiResponse<GetBorrowInterestRateResponse>>

Throws

See

getCollateralAssetData

Parameters

Returns Promise<RestApiResponse<GetCollateralAssetDataResponse>>

Throws

See

getLoanableAssetsData

Parameters

Returns Promise<RestApiResponse<GetLoanableAssetsDataResponse>>

Throws

See

getVIPLoanOngoingOrders

Parameters

Returns Promise<RestApiResponse<GetVIPLoanOngoingOrdersResponse>>

Throws

See

queryApplicationStatus

Parameters

Returns Promise<RestApiResponse<QueryApplicationStatusResponse>>

Throws

See

sendRequest

Type Parameters

Parameters

Returns Promise<RestApiResponse<T>>

sendSignedRequest

Type Parameters

Parameters

Returns Promise<RestApiResponse<T>>

vipLoanBorrow

Parameters

Returns Promise<RestApiResponse<VipLoanBorrowResponse>>

Throws

See

vipLoanRenew

Parameters

Returns Promise<RestApiResponse<VipLoanRenewResponse>>

Throws

See

vipLoanRepay

Parameters

Returns Promise<RestApiResponse<VipLoanRepayResponse>>

Throws

See

Settings

On This Page