Getting Started with Broker API

This guide takes you from a sandbox credential to a testable customer-investing workflow.

Before you start

• Create a partner session in the sandbox portal.
• Keep the sandbox key server-side.
• Install the TypeScript or Python SDK, or use curl.
• Read authentication, errors, and idempotency.

Build the golden path

1. Create a sub-account with an idempotent POST /users request.
2. Deposit virtual funds with a unique Idempotency-Key.
3. Assert the required KYC status.
4. Request a quote immediately before the trade.
5. Place the trade with the matching quoteId and the same idempotency key if retrying.
6. Consume the order, execution, wallet, and portfolio state through REST, webhooks, or SSE.
7. Run the reconciliation workflow before requesting production access.

The complete copyable workflow is in the Broker API quickstart. Use the API Tester to run individual operations and the API Reference for schemas.

Production transition

Sandbox success does not grant production access. Attach evidence for concurrency/idempotency, webhook retry handling, failover, reconciliation, security controls, and data governance through Going Live.