Choose your API
Partner Capability Index
Find the production endpoint, webhook, sandbox scenario, and integration guidance for common partner workflows.
Use this index when you know the workflow you need and want the authoritative contract immediately.
All endpoint paths are relative to /api/v1/partner in production and /api/sandbox/v1/partner in sandbox.
| Capability | Production contract | Test and implementation guidance |
|---|---|---|
| Batch portfolio quotes | GET /market/quotes?symbols=SCOM.KE,MTN.ZA — up to 50 symbols | Quotes and freshness |
| Tradeable price quote | GET /quote/{symbol} — single-use, 60-second TTL | Quote refresh pattern |
| Replace a resting order | PATCH /orders/{orderId} or PATCH /users/{userId}/orders/{orderId} | Advanced order types |
| Market open/closed state | GET /market/status | Market state |
| Holidays and closures | GET /market/holidays | Market calendar |
| KYC status changes | kyc.updated webhook; inspect kycStatus | KYC webhook handling |
| Instrument eligibility | GET /assets; inspect fractionalEligibility and orderRules | Fractional trading |
| Raw equity history | GET /portfolio/history and sub-account equivalent | Trading API |
| Cash-flow-adjusted performance | GET /portfolio/performance and sub-account equivalent | Optional benchmark=SCOM.KE; daily TWR, P&L, and excess return |
| Partial fill and failure simulation | POST /test-tools/trade, then PATCH /test-tools/orders/{orderId} | Paper and demo trading |
| Idempotent mutation retry | Reuse the same Idempotency-Key and identical request | Authentication and idempotency |
A market-data quote and a tradeable quote are different. Batch /market/quotes responses are for
display and portfolio refresh. MARKET orders require the single-use quoteId from /quote/{symbol}.
For machine consumers, use the OpenAPI JSON, OpenAPI YAML, or the documentation catalog.
Was this page useful?
Your signal helps us tighten partner onboarding docs.
Last updated on