Partner API
Endpoint catalogue
Generated from the implemented Partner API router.
This catalogue lists every HMAC-authenticated Partner API route. All listed scopes are required. It intentionally excludes CRISP admin and dashboard-session routes. This is a route inventory, not an OpenAPI payload schema. See the integration guides for request bodies and response semantics.
Download the catalogue and source hashes.
| Method | Path | Required scopes | Idempotency-Key |
|---|---|---|---|
| GET | /v1/capabilities | accounts:read | Not required |
| GET | /v1/trading-status | markets:read | Not required |
| POST | /v1/accounts | accounts:write | Required |
| GET | /v1/accounts | accounts:read | Not required |
| GET | /v1/accounts/{externalUserId} | accounts:read | Not required |
| GET | /v1/accounts/{externalUserId}/profile | profile:read | Not required |
| GET | /v1/accounts/{externalUserId}/wallet | wallet:read | Not required |
| POST | /v1/accounts/{externalUserId}/order-cell-capability | orders:write | Not required |
| POST | /v1/accounts/{externalUserId}/orders | orders:write | Required |
| POST | /v1/accounts/{externalUserId}/orders/prewarm | orders:write | Not required |
| GET | /v1/accounts/{externalUserId}/orders | orders:read | Not required |
| GET | /v1/accounts/{externalUserId}/trade-fills | orders:read, fees:read | Not required |
| GET | /v1/accounts/{externalUserId}/orders/{orderId}/trade-fills | orders:read, fees:read | Not required |
| GET | /v1/accounts/{externalUserId}/updates | orders:read | Not required |
| POST | /v1/accounts/{externalUserId}/realtime-session | realtime:session | Not required |
| GET | /v1/accounts/{externalUserId}/sellable-shares | orders:read | Not required |
| POST | /v1/accounts/{externalUserId}/orders/{orderId}/cancel | orders:write | Required |
| GET | /v1/accounts/{externalUserId}/positions | portfolio:read | Not required |
| POST | /v1/accounts/{externalUserId}/positions/redeem | orders:write | Required |
| GET | /v1/accounts/{externalUserId}/trades | portfolio:read | Not required |
| GET | /v1/events | markets:read | Not required |
| GET | /v1/events/{id} | markets:read | Not required |
| GET | /v1/markets | markets:read | Not required |
| GET | /v1/markets/{conditionId} | markets:read | Not required |
| GET | /v1/books/{tokenId} | markets:read | Not required |
| GET | /v1/order-requirements | markets:read | Not required |
| GET | /v1/accounts/{externalUserId}/wallet/deposit-instructions | wallet:read | Not required |
| GET | /v1/accounts/{externalUserId}/wallet/funding | wallet:read | Not required |
| GET | /v1/accounts/{externalUserId}/wallet/transfers | wallet:read | Not required |
| POST | /v1/accounts/{externalUserId}/wallet/deposit-quote | wallet:read | Not required |
| POST | /v1/accounts/{externalUserId}/wallet/withdrawal-quote | wallet:read | Not required |
| GET | /v1/accounts/{externalUserId}/withdrawals | wallet:read | Not required |
| GET | /v1/accounts/{externalUserId}/withdrawals/{withdrawalId} | wallet:read | Not required |
| POST | /v1/accounts/{externalUserId}/withdrawals | wallet:write | Required |
| GET | /v1/analytics/trading | analytics:read | Not required |
| POST | /v1/traffic/page-views | traffic:write | Not required |
| GET | /v1/fee-schedule | fees:read | Not required |
| PATCH | /v1/fee-schedule | fees:write | Required |
| GET | /v1/fee-claims | fees:read | Not required |
| POST | /v1/fee-claims | fees:write | Required |
| PUT | /v1/accounts/{externalUserId}/referrer | accounts:write | Required |
| GET | /v1/accounts/{externalUserId}/referral-earnings | fees:read | Not required |
| POST | /v1/accounts/{externalUserId}/referral-claims | fees:write | Required |
| GET | /v1/fee-program | fees:read | Not required |