Skip to navigation
API ReferenceAccount

Get VIP loan orders

Retrieve the list of VIP loan orders for the account, filterable by state and currency.

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

ordIdstringOptional
Loan order ID.
stateenumOptional

Order state: 1 borrowing, 2 borrowed, 3 repaying, 4 repaid, 5 borrow failed.

Allowed values:
ccystringOptional
Loan currency, e.g. BTC.
afterstringOptional
Pagination of data to return records earlier than the requested timestamp in milliseconds.
beforestringOptional
Pagination of data to return records newer than the requested timestamp in milliseconds.
limitstringOptional
Number of results per request. Maximum 100, default 100.

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