List positions across accessible accounts

Returns positions for trading accounts the caller can access, filtered by state. Staff users can see every account in the firm, while non-staff users only see their own accounts.

date_from / date_to are coarse date filters. For timestamp-level windows, use opened_at_after / opened_at_before with state=OPEN or closed_at_after / closed_at_before with state=CLOSED.

Default state is OPEN. Results are ordered by open_time DESC then id DESC for OPEN positions, and close_time DESC then open_time DESC for CLOSED positions.

GET /api/trade/positions/

List positions across accessible accounts

cURL

curl --request GET \
  --url https://api.example.com/api/trade/positions/ \
  --header 'Authorization: <api-key>'

200

{
  "meta": {
    "count": 123,
    "page": 1,
    "page_size": 20,
    "total_pages": 7,
    "has_next": true,
    "has_previous": false,
    "next": "https://api.example.org/resources/?page=2",
    "previous": null
  },
  "results": [
    {
      "meta": {
        "count": 1,
        "page": 1,
        "page_size": 20,
        "total_pages": 1,
        "has_next": false,
        "has_previous": false,
        "next": null,
        "previous": null
      },
      "results": [
        {
          "account_id": 2001,
          "account_currency": "USD",
          "uid": "POS-OPEN-001",
          "symbol": "EURUSD",
          "direction": "long",
          "volume": "1.0000",
          "open_price": "1.0800",
          "open_time": "2025-01-13T10:00:00Z",
          "tp": "1.0900",
          "sl": "1.0700",
          "open_pnl": "0.0000"
        }
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Query Parameters

account_id · integer

Optional account ID. Regular users may only request their own accounts.

closed_at_after · string<date-time>

For state=CLOSED only. Filter by close_time at or after this ISO 8601 datetime. Inclusive.

closed_at_before · string<date-time>

For state=CLOSED only. Filter by close_time at or before this ISO 8601 datetime. Inclusive.

date_from · string

Filter by open or close date. Use YYYY-MM-DD; DD-MM-YYYY is also accepted for compatibility. For timestamp precision, use the opened_at_* or closed_at_* filters.

date_to · string

Filter by open or close date. Use YYYY-MM-DD; DD-MM-YYYY is also accepted for compatibility. For timestamp precision, use the opened_at_* or closed_at_* filters.

opened_at_after · string<date-time>

For state=OPEN only. Filter by open_time at or after this ISO 8601 datetime. Inclusive.

opened_at_before · string<date-time>

For state=OPEN only. Filter by open_time at or before this ISO 8601 datetime. Inclusive.

page · integer

A page number within the paginated result set.

page_size · integer

Number of results to return per page.

prop_firm · string

Optional firm slug. When supplied, results are limited to the caller's own accounts for that firm.

state · enum<string> · default: OPEN

Filter positions by state

Available options: CLOSED, OPEN

Response

200 - application/json

meta · object · required

Pagination metadata. Use has_next/has_previous for boolean page checks and next/previous for page URLs.

Show child attributes

Example:

{
  "count": 123,
  "page": 1,
  "page_size": 20,
  "total_pages": 7,
  "has_next": true,
  "has_previous": false,
  "next": "https://api.example.org/resources/?page=2",
  "previous": null
}

results · object[] · required

Show child attributes