Skip to main content
POST

Authorizations

​
X-Auth-Client
string
header
required

Your workspace client id.

All calls must include four headers:

  • X-Auth-Client — your workspace client id
  • X-Auth-Timestamp — Unix seconds
  • X-Auth-Nonce — 16-byte random hex
  • X-Auth-Signature — hex(HMAC-SHA256( {client_id}:{timestamp}:{nonce}:{raw_body}, client_secret))

The playground computes the timestamp, nonce and signature for you.

​
X-Playground-Client-Secret
string
header
required

Your sandbox client secret. The playground uses it to sign the request in your browser and removes it before the request is sent. Never send your client secret as a header in your own integration.

Body

application/json
​
base_currency
string
required

Base currency of the pair, for example BTC.

Maximum string length: 10
Pattern: ^[A-Za-z]+$
Example:

"BTC"

​
quantity
string
required

Positive decimal amount of the base currency, in major units unless quantity_in_base_units is true

Example:

"0.01"

​
quote_currency
string
required

Quote currency of the pair, for example NGN.

Maximum string length: 10
Pattern: ^[A-Za-z]+$
Example:

"USDT"

​
side
enum<string>
required

Relative to the base currency; upper-cased by the server

Available options:
BUY,
SELL,
buy,
sell
​
quantity_in_base_units
boolean
default:false

When true, quantity is in the base currency's smallest unit (for example satoshis)

Response

OK

Successful responses are wrapped in this envelope, and so are errors a handler answers itself (request body and field validation, some not-found and conflict cases, ORG_NOT_ACTIVE): success is false and error carries a code and message. Errors raised by authentication and by the services behind a handler are a Problem instead.

​
success
boolean
required

true on success

​
timestamp
string<date-time>
required

When the response was written.

​
data
object

The payload; its shape is given per operation. Omitted when there is none.

​
error
object
​
message
string

Human-readable summary; omitted when empty.

​
metadata
object

List metadata. Page lists set page, per_page, total and total_pages; offset and cursor lists set limit, offset, has_more and next_cursor. Zero and empty fields are omitted, and metadata is absent when nothing is set.

​
request_id
string

Set on error envelopes: the request's correlation id (req_ followed by a UUID), the same value as the X-Correlation-ID response header. Quote it to support.