Skip to navigation
API ReferenceConvert

Estimate quote

Request a firm quote for a convert trade. The returned quoteId is valid for a short window and can be used to execute the trade.

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.
baseCcystringRequired

Base currency, e.g. BTC in BTC-USDT.

quoteCcystringRequired

Quote currency, e.g. USDT in BTC-USDT.

sideenumRequired

Trade side based on the base currency. buy: buy base currency; sell: sell base currency.

Allowed values:
rfqSzstringRequired
RFQ amount.
rfqSzCcystringRequired
RFQ currency, must be either the base or quote currency.
clQReqIdstringOptional

Client-supplied order ID for the quote request. A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 32 characters.

tagstringOptional

Order tag. A combination of case-sensitive alphanumerics, all numbers, or all letters of up to 16 characters.

convertModeenumOptional

Convert mode. 0: standard convert (default); 1: large order convert for VIP.

Allowed values:

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