Skip to main content

Query Parameters

grant_type
enum<string>
required

Method of authentication

Available options:
client_credentials,
client_signature,
refresh_token
Example:

"client_credentials"

client_id
string

Required for grant types client_credentials and client_signature. Maximum length is 16 bytes.

Example:

"fo7WAPRm4P"

client_secret
string

Required for grant type client_credentials.

Example:

"W0H6FJW4IRPZ1MOQ8FP6KMC5RZDUUKXS"

refresh_token
string

Required for grant type refresh_token. The token pair it belongs to is replaced by the new tokens returned (see above).

timestamp
integer

Required for grant type client_signature.

Time when the request was generated, in milliseconds since the UNIX epoch. Must be within ±60 seconds (±60,000 ms) of the server time, otherwise the request is rejected with error 13009 (unauthorized).

signature
string

Required for grant type client_signature.

Signature calculated over <timestamp>\n<nonce>\n<data>:

  • Shared-secret API keys: HMAC-SHA256 with the client secret as key, encoded as hexadecimal (letter case is ignored).
  • Asymmetric (RSA / Ed25519) API keys: digital signature made with your private key (SHA-256), encoded as URL-safe base64 without padding.

An invalid signature is rejected with error 13004 (invalid_credentials).

nonce
string

Optional for grant type client_signature, but strongly recommended. Defaults to an empty string.

User-generated random string, up to 128 bytes. A non-empty nonce can be used only once for the same client_id and timestamp (a repeat is rejected with 13009). With an empty or omitted nonce the timestamp window is still enforced but replay detection is not.

data
string

Optional for grant type client_signature. Defaults to an empty string.

Contains any user specific value; it is part of the signed string.

state
string

Will be passed back in the response.

scope
string

Describes type of the access for assigned token. Ignored for grant type refresh_token.

Possible values:

  • connection
  • session:name (names longer than 64 bytes are truncated)
  • trade:[read, read_write, none]
  • wallet:[read, read_write, none]
  • account:[read, read_write, none]
  • block_trade:[read, read_write, none]
  • block_rfq:[read, read_write, none]
  • expires:NUMBER
  • ip:ADDR

connection and session:name are mutually exclusive. Permission scopes cannot exceed the permissions of the API key.

Details are elucidated in Access scope

Example:

"connection"

Response

200 - application/json

Success response

jsonrpc
enum<string>
required

The JSON-RPC version (2.0)

Available options:
2.0
result
object
required
id
integer

The id that was sent in the request