Endpoint summary
System
These endpoints need no authentication and are available before any key exists.
| Method | Path | Description |
|---|---|---|
| GET | /health |
Liveness probe. |
| GET | /time |
Server time in milliseconds, for clock synchronization before signing. |
Fixtures
This endpoint needs no authentication.
| Method | Path | Description |
|---|---|---|
| GET | /fixtures |
List fixtures, paged and filterable. |
Orders
Requesting a quote needs the read permission and placing an order needs trade.
| Method | Path | Auth | Description |
|---|---|---|---|
| POST | /order/rfq |
read | Request for quote. Prices a bet without placing it. |
| POST | /order |
trade | Open a bet, or close one with a reduce only order. |
| GET | /order |
read | One order by orderId or clientOrderId. |
| GET | /orders |
read | The wallet's orders, paged and filterable by contractId, team, status. |
| GET | /orders/updates |
read | Orders that changed since the since timestamp. |
Positions and settlements
These endpoints are signed with an API key holding the read permission.
| Method | Path | Description |
|---|---|---|
| GET | /positions |
Open positions, paged and filterable by contractId, league, team. |
| GET | /settlements |
Settled positions, paged and filterable by contractId, team, type. |
Documentation
| Method | Path | Description |
|---|---|---|
| GET | /docs |
This documentation. |
| GET | /swagger |
Swagger console. |
| GET | /openapi.yaml |
OpenAPI specification. |
Pagination
GET /fixtures, GET /orders, GET /positions and GET /settlements are paginated. limit defaults to 50 with a maximum of 100, and offset defaults to 0. Filters are applied before pagination, so total reflects the number of matches. An offset beyond the last match returns an empty page rather than an error. Ordering is stable, so pages never repeat or omit entries.
{"fixtures": [], "total": 9, "limit": 50, "offset": 0}