Skip to navigation
API ReferenceFlexible Loan

Get maximum loan

Calculate the maximum amount that can be borrowed for a given currency, optionally accounting for supplementary collateral to be added.

Authentication

OK-ACCESS-KEYstring
Your API key.
OK-ACCESS-SIGNstring

Base64-encoded HMAC-SHA256 signature of the prehash string.

OK-ACCESS-TIMESTAMPstring

ISO 8601 UTC timestamp, e.g. 2020-12-08T09:08:57.715Z.

OK-ACCESS-PASSPHRASEstring
The passphrase you set when creating the API key.

Request

This endpoint expects an object.
borrowCcystringRequired
Currency to borrow, e.g. USDT.
supCollaterallist of objectsOptional

Supplementary collateral to include in the maximum-loan calculation.

ordIdstringOptional
Loan order ID. Used when multiple active loans exist.

Response

Successful response
codestringOptional

Result code. 0 means success; any other value is an error code.

msgstringOptional
Error message. Empty on success.
datalist of objectsOptional