Skip to main content
GET
/
api
/
v1
/
positions
List positions
curl --request GET \
  --url https://api.example.com/api/v1/positions \
  --header 'X-API-Key: <api-key>'
{}

Authorizations

​
X-API-Key
string
header
required

Client API key (UUID format). Get your key from the admin dashboard.

Query Parameters

​
fixtureId
string | null

Filter by fixture ID

​
exchange
string | null

Filter by exchange

​
status
string | null
default:active

Filter by status - comma-separated (e.g., 'open,matched'). Options: open, matched, filled, cancelled, active

​
fromDate
string<date> | null

Filter positions from orders created on or after this date (YYYY-MM-DD)

​
toDate
string<date> | null

Filter positions from orders created on or before this date (YYYY-MM-DD)

Response

Successful Response

The response is of type Response List Positions Api V1 Positions Get · object.