A single, streaming WebSocket connection for real-time market data, account/position updates and order routing. Messages are encoded with Google Protocol Buffers.
Proto Files: the .proto files define every message and field. This wiki explains the connection model and the common flows. For message field details, see the proto files and the Message Catalog.
| Feature | Included | Description |
|---|---|---|
| Real-time Quotes | ✅ | Stream live bid/ask price updates for any instrument. |
| Level 1 Data | ✅ | Access top-of-book best bid and offer (BBO). |
| Level 2 (Market Depth) | ✅ | View up to 10 levels of bid/ask depth. |
| Market by Order (MBO) | ✅ | See individual resting orders in the order book. |
| Trade Feed (Ticker) | ✅ | Get a real-time execution stream of all trades. |
| Order Management | ✅ | Submit, modify, and cancel orders programmatically. |
| Position & Account Monitoring | ✅ | Track open positions, P&L, and margin usage. |
| Instrument Metadata | ✅ | Retrieve contract specs, tick sizes, and margin requirements. |
| Spread Trading | ✅ | Execute spread orders with complex multi-leg strategies. |
| Risk & Margin Data | ✅ | Get real-time margin requirements and risk exposure. |
| Historical Data Requests | ✅ | Fetch recent trade history and market activity. |
| Efficient Binary Encoding | ✅ | Uses Protobuf for low-bandwidth, high-speed messaging. |
| Secure Authentication | ✅ | Ensures safe access with API key-based authentication. |
| Robust Reconnection | ✅ | Auto-reconnect and resume subscriptions on disconnection. |
| Section | Description |
|---|---|
| Connecting and Authenticating | Instructions on establishing a connection and handling authentication. |
| Market Data & Definitions | How to retrieve market lists, subscribe to quotes, and understand market definition messages. |
| Account Feed | Receiving account, position, and order updates in real time. |
| Order Routing | Submitting orders, supported order types, and handling updates. |
| Pricing and Data Types | Understanding price formatting and how decimal values are represented. |
| Message Catalog | Every message, mapped to its proto definition. |
| Migrating from V1 | What changed from V1 and how to upgrade. |
| Certification and Testing | Development checklist and pre/post-certification requirements. |
| FAQ | Answers to common questions about the API. |