Base URL
Auth
Send your partner API key in thex-api-key header.
First successful request
What REST gives you
- Scope-gated reads across events, messages, positions, discovery, and stats
- Forward-only cursor pagination on list endpoints
- Response envelopes with stable request IDs and echoed applied bounds where relevant
- A generated OpenAPI reference with endpoint, parameter, and schema details
- A secondary Swagger UI if you want a quick interactive view
Current endpoint families
GET /api/v1/tradersGET /api/v1/assetsGET /api/v1/eventsGET /api/v1/messagesGET /api/v1/positions/closed/validGET /api/v1/positions/openGET /api/v1/traders/{traderId}/statsGET /api/v1/assets/{assetId}/statsGET /api/v1/openapi.json
Operational endpoint
GET /healthz
Pagination essentials
limitaccepts up to100meta.nextCursoradvances forward from the current page- cursors remain usable if matching events disappear between requests
- pagination reflects the current eligible set and is not a frozen snapshot
- historical list reads may default to a bounded time window when
startTimeandendTimeare omitted - historical list reads echo the applied bounds in
data.meta.appliedTimeRange