Developers
Three standard interfaces, one order model
Qubit speaks the protocols your systems already use. FIX 4.4 for order flow from OMSs and trading desks, REST for order entry and reference data, and WebSocket for streaming execution reports, positions and market data. All three share one order model and one set of identifiers, so an order entered over FIX can be followed over WebSocket and queried over REST.
The samples below show the shape of the APIs. Paths, field names and tags are confirmed in the API reference shipped with each release, which you receive with sandbox access.
FIX 4.4
For order entry, drop copies and execution reports between institutional systems.
- Order entry: NewOrderSingle (D), OrderCancelRequest (F), OrderCancelReplaceRequest (G), OrderStatusRequest (H)
- Execution reports (8) for every state change, including partial fills, with cumulative and average fill fields
- Drop copy sessions for compliance and back-office systems
- Session-level sequence number recovery and resend handling, per the FIX standard
- A rules of engagement document for each client describing supported tags, values and any custom fields
- Sessions over TLS, or over a private network link in self-hosted deployments
Sample: NewOrderSingle for a limit buy of 2.5 BTC/USDT, sent to the smart order router
The | character stands in for the SOH field delimiter. Fields are shown one per line for reading.
8=FIX.4.4|9=172|35=D|34=215|49=ACME_OMS|52=20261031-09:30:15.123|56=QUBIT|1=FUND-A|11=ACME-20261031-0001|21=1|38=2.5|40=2|44=64250.00|54=1|55=BTC/USDT|59=1|60=20261031-09:30:15.120|100=SOR|10=190|| Tag | Field | Value in this sample |
|---|---|---|
| 35 | MsgType | D (NewOrderSingle) |
| 1 | Account | FUND-A, the Qubit account the order books to |
| 11 | ClOrdID | Your unique order ID. Resending the same ClOrdID never creates a second order. |
| 21 | HandlInst | 1, automated execution |
| 38 | OrderQty | 2.5 |
| 40 | OrdType | 2, limit |
| 44 | Price | 64250.00, an illustrative price |
| 54 | Side | 1, buy |
| 55 | Symbol | BTC/USDT in Qubit's normalized symbology |
| 59 | TimeInForce | 1, good till cancel |
| 100 | ExDestination | SOR routes through the smart order router. A venue code routes directly to that venue. |
REST
For order entry, order and fill queries, positions, balances, reference data and configuration.
- JSON over HTTPS, with resource-oriented paths under a version prefix
- Authentication with scoped API keys, with request signing and IP allowlisting available
- An
Idempotency-Keyheader on every write, so a retried request is safe - Cursor-based pagination and consistent error objects with machine-readable codes
- Rate limits stated per endpoint and returned in response headers
Sample: place a limit order with curl
curl -s -X POST "https://qubit.example-broker.internal/api/v1/orders" \ -H "Authorization: Bearer $QUBIT_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: 7d0f4c2e-6b1a-4f6e-9a51-3c2d8e1b9f40" \ -d '{ "clientOrderId": "ACME-20261031-0002", "account": "FUND-A", "symbol": "ETH/USDT", "side": "sell", "type": "limit", "quantity": "40", "limitPrice": "3150.00", "timeInForce": "gtc", "execution": { "strategy": "sor" } }'Sample response: 201 Created
{ "orderId": "ord_01JBQ7X5N4K2M8R3T6V9W0Y1Z2", "clientOrderId": "ACME-20261031-0002", "account": "FUND-A", "symbol": "ETH/USDT", "side": "sell", "type": "limit", "quantity": "40", "limitPrice": "3150.00", "timeInForce": "gtc", "status": "accepted", "filledQuantity": "0", "riskCheck": { "result": "passed", "checkedAt": "2026-10-31T09:31:02.418Z" }, "createdAt": "2026-10-31T09:31:02.415Z"}Quantities and prices are strings so that no precision is lost in transit. If pre-trade risk rejects an order, the response is 422 with the rule that failed, for example {"error": {"code": "RISK_NOTIONAL_LIMIT", "message": "Order notional exceeds the account limit", "limit": "250000.00"}}.
WebSocket
For streaming execution reports, order status, positions, balances and market data.
- One connection carries many subscriptions, authenticated when the connection opens
- Every message on a channel carries a sequence number. After a reconnect, you resume from the last sequence you processed and receive what you missed.
- Heartbeats in both directions, so either side can detect a dead connection quickly
Sample: subscribe to execution reports in TypeScript (Node.js with the ws package)
import WebSocket from "ws";type ExecutionReport = { channel: "executions"; seq: number; orderId: string; clientOrderId: string; account: string; symbol: string; side: "buy" | "sell"; execType: "new" | "partial_fill" | "fill" | "canceled" | "replaced" | "rejected"; status: string; lastQuantity: string; lastPrice: string; cumQuantity: string; avgPrice: string; leavesQuantity: string; venue: string; fee: { amount: string; currency: string }; transactTime: string;};const url = "wss://qubit.example-broker.internal/ws/v1";let lastSeq = 0; // persist this in production so a restart resumes cleanlyfunction connect(): void { const ws = new WebSocket(url, { headers: { Authorization: `Bearer ${process.env.QUBIT_API_KEY}` }, }); ws.on("open", () => { ws.send( JSON.stringify({ op: "subscribe", channel: "executions", accounts: ["FUND-A"], fromSeq: lastSeq + 1, // replay anything missed while disconnected }), ); }); ws.on("message", (raw) => { const msg = JSON.parse(raw.toString()); if (msg.op === "error") { console.error(`Subscription error ${msg.code}: ${msg.message}`); return; } if (msg.channel !== "executions") return; const report = msg as ExecutionReport; if (report.seq <= lastSeq) return; // already processed lastSeq = report.seq; if (report.execType === "partial_fill" || report.execType === "fill") { console.log( `${report.clientOrderId} ${report.side} ${report.lastQuantity} ${report.symbol} ` + `@ ${report.lastPrice} on ${report.venue}, ` + `filled ${report.cumQuantity}, remaining ${report.leavesQuantity}`, ); } }); ws.on("close", () => setTimeout(connect, 1000)); // reconnect and resume from lastSeq ws.on("error", (err) => console.error("WebSocket error", err.message));}connect();Change policy
Versioning and change policy
- REST and WebSocket APIs carry a major version in the path (
/api/v1,/ws/v1). - Within a major version, changes are additive: new endpoints, new optional fields, new enum values. Write clients that ignore fields they do not recognize.
- Breaking changes ship only in a new major version. The previous version keeps working through a deprecation period stated in the release notes.
- FIX changes are recorded in your rules of engagement document and announced before the release that carries them.
- Every release lists API changes in its release notes.
Sandbox
Sandbox access
A sandbox with simulated venues and sample instruments is available on request, together with the full API reference, the FIX rules of engagement and test credentials. Ask for access through Contact and tell us which interfaces you plan to use.
SDKs
RoadmapTyped client libraries for TypeScript and Python are on the roadmap. Until they ship, the API reference includes an OpenAPI description for REST, which you can use to generate a client in your language.
Request sandbox access
Tell us which interfaces you will use and what you want to test. We will send credentials, the API reference and the FIX rules of engagement.