Skip to main content
POST
Place an order

Authorizations

DX-ACCESS-KEY
string
header
required

The API key id (decimal string).

DX-ACCESS-TIMESTAMP
string
header
required

Request timestamp, Unix milliseconds (decimal). ±5000 ms replay window.

DX-ACCESS-SIGNATURE
string
header
required

base64(HMAC-SHA256(secret, "timestamp\nMETHOD\npath?query\nbody")). For the WS handshake the body is empty and the path is /v1/ws.

Body

application/json

Closed schema (api.md §6.5) — unknown field ⇒ 400.

client_order_id
string
required

idempotency key

Pattern: ^[0-9]+$
Example:

"182390"

market_id
integer
required
side
enum<string>
required
Available options:
buy,
sell
outcome
enum<string>
required
Available options:
yes,
no
type
enum<string>
required
Available options:
limit,
market
qty
integer
required
Required range: x >= 1
tick
integer

limit only

Required range: 1 <= x <= 99
worst_tick
integer

market only, optional; marketable-limit bound (default 99 buy / 1 sell)

Required range: 1 <= x <= 99
tif
enum<string>

limit only; market ⇒ forced ioc

Available options:
gtc,
gtt,
ioc,
fok
expiry_ts
string

ns; gtt only

Pattern: ^[0-9]+$
Example:

"182390"

max_cost
string

cents; required for market buys

Pattern: ^[0-9]+$
Example:

"182390"

group_id
integer
default:0
post_only
boolean
default:false
reduce_only
boolean
default:false
cancel_on_pause
boolean
default:false
stp_maker
boolean
default:false

Response

The sequenced placement outcome (api.md §6.5).

The sequenced placement outcome (api.md §6.5).

order_id
string
required

A u64-domain value rendered as a decimal string (api.md §1).

Pattern: ^[0-9]+$
Example:

"182390"

client_order_id
string
required

A u64-domain value rendered as a decimal string (api.md §1).

Pattern: ^[0-9]+$
Example:

"182390"

status
enum<string>
required
Available options:
resting,
partially_filled,
executed,
canceled
seq
string
required

the NEW_ORDER's stamp

Pattern: ^[0-9]+$
Example:

"182390"

filled_qty
integer
required
resting_qty
integer
required
fills
object[]
required
reason
string | null

present when status is canceled (execution outcome