Skip to main content
POST

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your API secret.

API-Timestamp
string
header
required

Time the request was signed, as Unix milliseconds. Included in the request signature. Requests signed too far from the server's time are rejected.

Path Parameters

account_id
string
required

Globally unique public identifier for an account.

Required string length: 14 - 42

Body

application/json

Parameters for an order in the selected asset type.

type
enum<string>
required

Order type.

Available options:
market
symbol
string
required

Instrument symbol.

Required string length: 1 - 64
Pattern: ^\S+$
Example:

"PBTCUCZ0.BTNL"

side
enum<string>
required

Direction of the order.

Available options:
buy,
sell
Example:

"buy"

quantity
string
required

Quantity to trade, in contracts. The US offering requires whole numbers. Must align with the instrument's quantity_precision.

Required string length: 1 - 256
Pattern: ^(?:[0-9]*[1-9][0-9]*(?:\.[0-9]+)?|0+\.[0-9]*[1-9][0-9]*)$
Example:

"2"

asset_type
enum<string>
default:perpetual

Classification of the trading instrument.

Available options:
perpetual
Example:

"perpetual"

client_order_id
string<uuid>

Available for the International/EEA offering.

Optional partner-provided reference for tracking the order. Use a lowercase, hyphenated UUID.

Two active orders or pending triggers in the same account cannot use the same ID. Reusing an ID that is still in use returns 409.

Once the original order or trigger is no longer active, the ID can be reused. A retry with that ID can then create another order. This is not an idempotency key.

Example:

"550e8400-e29b-41d4-a716-446655440000"

reduce_only
boolean
default:false

Available only for the International/EEA offering.

Whether execution is restricted to reducing an existing position. When enabled, the order cannot open or increase a position.

An order larger than the open position may be accepted with a reduced quantity. The excess quantity will not execute or open a position in the opposite direction.

Example:

true

Response

The order request was processed.

data
object
required

Result returned after processing a create request.