Skip to main content

PlaceOrderResp

orderIdstring

Server-assigned order identifier

clOrderIdstring

Echo of the client-supplied order identifier if one was provided

statusint32

Numeric status code reflecting the current state of the order (e.g. filled, cancelled, rejected)

marketstring

Trading pair, e.g. BTC-USDT

typeint32

Numeric code identifying the order type (e.g. LIMIT, MARKET, TWAP, PEG)

orderSidestring

BUY or SELL

orderPricedouble

Order price

postOnlyboolean

Whether the order was submitted as post-only

timestampint64

Server-side event timestamp in epoch milliseconds

orderDetailTypestring

Detailed order sub-type when applicable (e.g. TWAP for algo TWAP orders)

Possible values: [TWAP, PARTIAL_LIQUIDATION, FORCED_MARKET_BUY, FORCED_MARKET_SELL]

messagestring

Optional diagnostic message; present only when one is returned (e.g. rejection reason)

userQuoteCurrencystring

Quote currency configured for the user

orderCurrencystring

'quote' or 'base'; indicates whether the quote-size or base-size fields below are populated

originalOrderBaseSizedouble

Original size in base currency; populated when orderCurrency is 'base'

originalOrderQuoteSizedouble

Original size in quote currency; populated when orderCurrency is 'quote'

currentOrderBaseSizedouble

Currently active size in base currency; populated when orderCurrency is 'base'

currentOrderQuoteSizedouble

Currently active size in quote currency; populated when orderCurrency is 'quote'

remainingOrderBaseSizedouble

Remaining unfilled size in base currency; populated when orderCurrency is 'base'

remainingOrderQuoteSizedouble

Remaining unfilled size in quote currency; populated when orderCurrency is 'quote'

filledBaseSizedouble

Size filled by the most recent match, in base currency

totalFilledBaseSizedouble

Cumulative filled size across all matches, in base currency

avgFilledPricedouble

Volume-weighted average fill price

time_in_forcestring

Time-in-force policy (GTC, IOC, FOK); null when not applicable to the order type

PlaceOrderResp
{
"orderId": "string",
"clOrderId": "string",
"status": 0,
"market": "string",
"type": 0,
"orderSide": "string",
"orderPrice": 0,
"postOnly": true,
"timestamp": 0,
"orderDetailType": "TWAP",
"message": "string",
"userQuoteCurrency": "string",
"orderCurrency": "string",
"originalOrderBaseSize": 0,
"originalOrderQuoteSize": 0,
"currentOrderBaseSize": 0,
"currentOrderQuoteSize": 0,
"remainingOrderBaseSize": 0,
"remainingOrderQuoteSize": 0,
"filledBaseSize": 0,
"totalFilledBaseSize": 0,
"avgFilledPrice": 0,
"time_in_force": "string"
}