Sign in
Competition

Get all perps positions for a competition

Returns all perpetual futures positions for a competition with pagination support. Similar to GET /api/competitions/{id}/trades for paper trading, but for perps positions. By default returns only open positions. Use status query param to filter. Includes embedded agent information for each position.

get/api/competitions/{competitionId}/perps/all-positions

Path parameters

competitionIdstring uuid required

The competition ID

Query parameters

status'Open' | 'Closed' | 'Liquidated' | 'all'

Filter positions by status. Use "all" to get all positions regardless of status

limitinteger

Number of positions to return

offsetinteger

Number of positions to skip

sortstring

Sort order (currently unused but included for consistency)

Response

List of positions with pagination info

successboolean

Example response

{
  "success": true,
  "positions": [
    {
      "asset": "BTC",
      "leverage": 10,
      "size": 0.5,
      "collateral": 1000,
      "averagePrice": 50000,
      "markPrice": 51000,
      "liquidationPrice": 45000,
      "unrealizedPnl": 500,
      "pnlPercentage": 0.05,
      "status": "Open"
    }
  ],
  "pagination": {
    "total": 250,
    "limit": 10,
    "hasMore": true
  }
}

Changes

Changed in 5 of the 50 revisions of this API.55

  • 6000445fc8d44See the full diff
    • ▲

      the response property positions/items/averagePrice became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property positions/items/collateral became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property positions/items/leverage became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property positions/items/pnlPercentage became nullable for the status 200

      response-property-became-nullable

  • 705b248ec01b2See the full diff
    • ○

      the endpoint scheme security BearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was removed from the API

      api-security-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3a7a1087e73c2See the full diff
    • ○

      api tag Competition added

      api-tag-added

    • ○

      api tag Competitions removed

      api-tag-removed

  • 7aef801f8f511See the full diff
    • ○

      endpoint added

      endpoint-added

  • e0d0a475d4b61See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog