Skip to main content
Error

Authorizations

​
X-API-KEY
string
header
required

HMAC-SHA256 authentication. Sign every request and send X-API-KEY, X-API-SIGNATURE, X-API-TIMESTAMP and X-API-NONCE (see the Authentication guide). Each route also requires a specific claim on your API key (e.g. read:orders, write:orders, read:account, read:market-data).

Path Parameters

​
symbol
string
required

Coin symbol (e.g. BTC, ETH).

Example:

"BTC"

​
user
string
required

Platform user id this address is bound to.

Response

​
statusCode
number
required

HTTP status code echoed in the body.

Example:

200

​
success
boolean
required

True for success responses.

Example:

true

​
message
string

Human-readable status message.

Example:

"Request processed successfully"

​
data
object