Skip to navigation

Get max redeemable collateral

Retrieve the maximum amount of collateral that can be redeemed (withdrawn) without breaching the loan’s liquidation threshold.

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.

Query parameters

ccystringOptional
Collateral currency, e.g. BTC. Returns all collateral currencies if omitted.
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