Skip to main content

Binary Order Entry

The binary order-entry surface is designed for low-overhead submission and deterministic acknowledgement.

Message types

TypePurpose
NewOrderSubmit a single order
CancelOrderCancel by client order id
ReplaceOrderAtomically amend price, quantity, or flags
BulkOrderRefresh many quotes in one message
MassCancelCancel by account, market, or side
HeartbeatKeep session alive

NewOrder fields

FieldNotes
client_order_idIdempotency key, equivalent to FIX ClOrdID
market_idNumeric market identifier negotiated at session start
sideBuy or sell
order_typeLimit, market, conditional, or algo extension
time_in_forceGTC, IOC, FOK, post-only extension
priceFixed-scale integer, omitted for market orders
quantityFixed-scale integer
flagsReduce-only, post-only, STP policy

Acknowledgement model

Ack confirms gateway acceptance. ExecReport confirms sequencer-visible order state. Clients should not treat gateway acknowledgement as a fill or final order state.

Failure model

Rejects use stable numeric reason codes that map to the public Error Model: tick-size violation, insufficient collateral, stale nonce, duplicate client order id, and account permission failures.