API Reference
210 operations verified against production and sandbox route handlers. Handler coverage is not production acceptance.
166 operations appear in the tester; 132 are eligible for Sandbox execution before account and instrument checks. Public utilities, portal operations, streaming and production-only functions have separate execution paths. The Postman collection is a curated subset, not the complete operation inventory.
Browse the canonical API contract below. Use the sandbox tester for authenticated scenarios. Portal sign-in, production-only operations and sandbox helpers are labeled on each operation page.
All operation pages and environment availability
- GET /assets — Sandbox available
- GET /companies — Sandbox available
- GET /companies/{symbol} — Sandbox available
- GET /companies/{symbol}/chart — Sandbox available
- GET /companies/{symbol}/news — Sandbox available
- GET /companies/tickers — Sandbox available
- GET /etfs — Sandbox available
- GET /etfs/{symbol} — Sandbox available
- GET /etfs/{symbol}/chart — Sandbox available
- GET /etfs/{symbol}/history — Sandbox available
- GET /fx/rates — Sandbox unsupported
- GET /market-data/exchanges — Sandbox available
- GET /market-data/movers — Sandbox available
- GET /market-data/ohlcv — Sandbox available
- GET /market-data/quotes — Sandbox available
- GET /market-intel — Sandbox available
- GET /market-intel/{id} — Sandbox available
- GET /market/exchanges — Sandbox available
- GET /market/holidays — Sandbox available
- GET /market/movers — Sandbox available
- GET /market/ohlcv — Sandbox available
- GET /market/quotes — Sandbox available
- GET /market/snapshot — Sandbox available
- GET /price-alerts — Production only
- POST /price-alerts — Production only
- DELETE /price-alerts/{alertId} — Production only
- GET /price-alerts/{alertId} — Production only
- GET /stocks — Sandbox available
- GET /stocks/{symbol} — Sandbox available
- GET /stocks/{symbol}/candles — Sandbox available
- GET /stocks/{symbol}/chart — Sandbox available
- GET /stocks/{symbol}/history — Sandbox available
- GET /stocks/{symbol}/pulse — Sandbox available
- GET /bonds — Sandbox available
- GET /bonds/{id} — Sandbox available
- GET /buying-power — Sandbox available
- GET /funds — Sandbox available
- GET /funds/{id} — Sandbox available
- GET /market/clock — Sandbox available
- GET /market/settlement — Sandbox available
- GET /market/status — Sandbox available
- GET /opportunities — Sandbox available
- GET /opportunities/{id} — Sandbox available
- GET /orders — Sandbox available
- DELETE /orders/{orderId} — Sandbox unsupported
- GET /orders/{orderId} — Sandbox unsupported
- PATCH /orders/{orderId} — Sandbox unsupported
- GET /orders/{orderId}/executions — Production only
- GET /orders/blotter — Sandbox available
- GET /portfolio — Sandbox available
- GET /portfolio/history — Sandbox available
- GET /portfolio/performance — Sandbox available
- GET /quote/{symbol} — Sandbox available
- POST /trade — Sandbox unsupported
- GET /users/{userId}/preflight — Sandbox available
- POST /auto-register — Sandbox available
- POST /fx/convert — Sandbox available
- POST /fx/quote — Sandbox available
- GET /users — Sandbox available
- POST /users — Sandbox available
- DELETE /users/{userId} — Sandbox available
- GET /users/{userId} — Sandbox available
- PATCH /users/{userId} — Sandbox available
- GET /users/{userId}/buying-power — Sandbox available
- POST /users/{userId}/deposit — Sandbox available
- GET /users/{userId}/devices — Sandbox available
- POST /users/{userId}/devices — Sandbox available
- DELETE /users/{userId}/devices/{deviceId} — Sandbox available
- GET /users/{userId}/dividends — Sandbox available
- POST /users/{userId}/fx/convert — Sandbox available
- POST /users/{userId}/fx/quote — Sandbox available
- GET /users/{userId}/gains — Sandbox available
- POST /users/{userId}/kyc — Sandbox available
- GET /users/{userId}/orders — Sandbox available
- DELETE /users/{userId}/orders/{orderId} — Sandbox available
- GET /users/{userId}/orders/{orderId} — Sandbox available
- PATCH /users/{userId}/orders/{orderId} — Sandbox unsupported
- GET /users/{userId}/orders/{orderId}/executions — Sandbox available
- GET /users/{userId}/portfolio — Sandbox available
- GET /users/{userId}/portfolio/history — Sandbox available
- GET /users/{userId}/portfolio/performance — Sandbox available
- POST /users/{userId}/redeem — Sandbox available
- POST /users/{userId}/subscribe — Sandbox available
- GET /users/{userId}/tax-lots — Sandbox available
- POST /users/{userId}/trade — Sandbox available
- GET /users/{userId}/transactions — Sandbox available
- GET /users/{userId}/wallet — Sandbox available
- GET /users/{userId}/watchlist — Sandbox available
- POST /users/{userId}/watchlist — Sandbox available
- DELETE /users/{userId}/watchlist/{symbol} — Sandbox available
- POST /users/{userId}/withdraw — Sandbox available
- GET /users/summary — Sandbox available
- GET /float — Sandbox available
- PATCH /float — Sandbox available
- POST /float — Sandbox available
- GET /payout — Sandbox available
- POST /payout — Sandbox unsupported
- GET /topup — Sandbox available
- POST /topup — Sandbox available
- GET /corporate-actions — Sandbox available
- GET /corporate-actions/{actionId} — Sandbox available
- GET /dividends/{symbol}/history — Sandbox available
- GET /dividends/calendar — Sandbox available
- GET /report/dividends — Sandbox available
- GET /shareholder-meetings — Sandbox available
- GET /shareholder-meetings/{meetingId} — Sandbox available
- GET /users/{userId}/corporate-actions/{actionId}/elections — Sandbox available
- POST /users/{userId}/corporate-actions/{actionId}/elections — Sandbox available
- GET /users/{userId}/corporate-actions/{actionId}/entitlement — Sandbox available
- GET /users/{userId}/shareholder-meetings/{meetingId}/ballot — Sandbox available
- GET /users/{userId}/shareholder-meetings/{meetingId}/votes — Sandbox available
- POST /users/{userId}/shareholder-meetings/{meetingId}/votes — Sandbox available
- GET /audit — Sandbox available
- GET /client-activity — Sandbox available
- GET /commercial — Production only
- GET /documents — Sandbox available
- POST /documents — Production only
- GET /documents/{id} — Sandbox only
- GET /gains — Sandbox available
- GET /reconciliation-signoffs — Production only
- POST /reconciliation-signoffs — Production only
- GET /report/aum — Sandbox available
- GET /report/fees — Sandbox available
- GET /report/invoice — Sandbox available
- GET /report/operation — Sandbox available
- GET /report/positions — Sandbox available
- GET /report/reconciliation — Sandbox available
- GET /report/revenue — Sandbox available
- GET /stream — Sandbox available
- GET /tax-lots — Sandbox available
- GET /usage — Sandbox available
- GET /approvals — Production only
- POST /approvals — Production only
- GET /approvals/{approvalId} — Production only
- PATCH /approvals/{approvalId} — Production only
- GET /approvals/policies — Production only
- PATCH /approvals/policies — Production only
- GET /enterprise/access-reviews — Production only
- PATCH /enterprise/access-reviews — Production only
- POST /enterprise/access-reviews — Production only
- GET /enterprise/access-reviews/{reviewId} — Production only
- PATCH /enterprise/access-reviews/{reviewId} — Production only
- GET /enterprise/evidence — Production only
- DELETE /enterprise/scim — Production only
- GET /enterprise/scim — Production only
- POST /enterprise/scim — Production only
- GET /enterprise/sso — Production only
- PATCH /enterprise/sso — Production only
- POST /oauth/token — Production only
- GET /security — Production only
- PATCH /security — Production only
- DELETE /sessions — Production only
- GET /sessions — Production only
- GET /sla — Sandbox available
- GET /support — Production only
- POST /support — Production only
- GET /support/{ticketId} — Production only
- PATCH /support/{ticketId} — Production only
- POST /support/{ticketId}/messages — Production only
- GET /team — Production only
- PATCH /team — Production only
- DELETE /team/invites — Production only
- POST /team/invites — Production only
- PATCH /team/members/{memberId} — Production only
- GET /team/roles — Production only
- POST /team/roles — Production only
- DELETE /team/roles/{roleId} — Production only
- PATCH /team/roles/{roleId} — Production only
- GET /account — Sandbox available
- DELETE /api-keys/data-key — Sandbox unsupported
- GET /api-keys/data-key — Sandbox available
- POST /api-keys/data-key — Sandbox unsupported
- DELETE /api-keys/revoke — Sandbox unsupported
- POST /api-keys/revoke — Sandbox unsupported
- POST /api-keys/rotate — Sandbox available
- POST /apply — Public
- GET /certification — Production only
- PATCH /certification — Production only
- POST /certification — Production only
- GET /installations — Production only
- GET /me — Sandbox available
- POST /me — Production only
- GET /notification-rules — Production only
- PUT /notification-rules — Production only
- GET /openapi.json — Public
- GET /openapi.yaml — Public
- GET /pricing — Sandbox available
- PATCH /pricing — Sandbox available
- GET /public-brand — Public
- POST /register — Sandbox only
- POST /reset — Sandbox only
- POST /sandbox/deposit — Sandbox available
- GET /sandbox/orders — Sandbox available
- POST /sandbox/trade — Sandbox available
- POST /session — Production only
- GET /settings — Sandbox available
- PATCH /settings — Sandbox available
- POST /settings — Sandbox available
- POST /test-tools/deposit — Sandbox available
- GET /test-tools/orders — Sandbox available
- PATCH /test-tools/orders/{orderId} — Sandbox only
- POST /test-tools/trade — Sandbox available
- GET /upgrade-request — Sandbox available
- POST /upgrade-request — Sandbox available
- GET /webhooks — Sandbox available
- POST /webhooks — Sandbox available
- DELETE /webhooks/{id} — Sandbox available
- GET /webhooks/{id} — Sandbox only
- GET /webhooks/{id}/deliveries — Sandbox available
- POST /webhooks/{id}/test — Sandbox available