API reference
The reference pages are drawn from the OpenAPI document, which we generate from the annotations in the service code. CI checks that the document stays equal to the code. No reference is written by hand. When an endpoint changes, we regenerate the document and these pages show it.
- Operator API: user and balance sync, positions, the widget session, reports and support tickets.
- Market Feed API: read-only endpoints for the market catalog and the prices of a tenant.
The Operator API examples come from the published contract examples. We replay each example against a real server in the contract tests. In the examples, replace placeholders such as {{api_key}} with your own values.
All paths are under /v1. List endpoints page with a cursor: you send ?cursor=<opaque>&limit=<1..100> and the response has the form { "data": [...], "next_cursor": ... }. Do not parse the cursor and do not build one yourself.
Last updated on