API capabilities
Find the public operations and integration topics for market data, orders, account access and funding.
Choose a capability
Use this directory to find the product API operations and integration guidance for your application. REST provides initial reads and explicit commands; WebSockets provide supported ongoing market and account updates. Availability and permissions depend on the target environment.
The REST API reference and realtime API reference define request, response and message fields. Use the linked topics below for lifecycle behavior, exact values, authentication and recovery.
Order and account operations
Preview, placement and cancellation serve distinct purposes. A preview estimates an order without reserving funds. Placement submits a command, while the account stream confirms resulting fills and position changes. Closing a position uses a reduce-only order.
| Capability | Operation or access | Integration guidance |
|---|---|---|
| Place an order | POST /v1/orders | Preserve clientOrderId and Idempotency-Key; orderId is returned by the venue. |
| Preview an order | POST /v1/orders/preview | Estimate only; the result does not reserve funds or execute a trade. |
| Cancel an order | POST /v1/orders/{orderId}/cancel | Cancel remaining quantity; reconcile fills that arrive during cancellation. |
| Read account state | Authenticated account operations | Use snapshots for initial state and documented recovery; streams deliver supported live updates. |
| Authenticate a private stream | Realtime ticket issuance and rotation | After rotation, authenticate the socket with the new ticket and wait for auth_ok. |
| Withdraw funds | Owner-approved withdrawal workflow | Follow documented custody approval and payout status. |
Market data and order integration
Build exact, market-aware order handling and a validated live-data flow. These topics cover the values and lifecycle rules a trading interface or automated client needs.
| Topic | Use it for | Reference |
|---|---|---|
| Market discovery | Available instruments, trading rules and capability checks | Market data |
| Market streams | Subscription acceptance, snapshots and market updates | WebSockets |
| Order requests | Order fields, decimal precision, preview and placement | Order API |
| Order outcomes | Commitment, fills, cancellation and unresolved outcomes | Order lifecycle |
| Account streams | Authenticated order, balance and position updates | Account streams |
| Client architecture | Separate commands, streaming state and presentation | Trading client architecture |
Execution and settlement concepts
These topics explain how product-level results relate to off-chain execution and later Canton settlement. Applications access the documented product interfaces; the architecture diagrams explain the processing behind those interfaces.
| Topic | What it explains | Reference |
|---|---|---|
| Product services | The API, execution core, live delivery and query views | Execution services |
| Execution commitment | Ordered replies, durable evidence and recovery | Commitment and replay |
| Settlement | Balanced effects, ordered batches and Canton confirmation | Settlement model |
| Data freshness | Connection health, query completeness and replay limits | Monitoring and data freshness |
| Integration validation | Permissions, precision, retries and stream continuity | Integration testing |
Connect the complete lifecycle
For each capability, identify the initial read, explicit command, live update and supported recovery path. Keep the same account and market scope across those stages, and preserve command identities when a result is unknown.
Start with the order request fields and public subscription example. Market makers can continue to market-maker integration, while agent builders can explore the Markets agent overview.