Sign in
Account Management
Private

Retrieves position details for all subaccounts for a specific currency. Returns positions aggregated across all subaccounts, including size, average entry price, mark price, and P&L information.

Optionally include open orders for each subaccount by setting the with_open_orders parameter to true.

📖 Related Article: Managing Subaccounts

Scope: account:read

Try in API console

get/private/get_subaccounts_details

Query parameters

currency'BTC' | 'ETH' | 'USDC' | 'USDT' | 'EURR' required

Currency, i.e "BTC", "ETH", "USDC"

The currency symbol

with_open_ordersboolean

Optional parameter to ask for open orders list, default: false

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": [
    {
      "positions": [
        {
          "instrument_name": "BTC-PERPETUAL",
          "user_id": 57874
        }
      ],
      "open_orders": [
        {
          "order_id": "ETH-100234",
          "instrument_name": "BTC-PERPETUAL",
          "creation_timestamp": 1536569522277,
          "last_update_timestamp": 1536569522277,
          "starbase_last_update_timestamp": 1536569522277000000,
          "block_trade": true,
          "trigger_order_id": "SLIB-370",
          "combo_order_id": "103148386169",
          "starbase_order_id": 103148386170,
          "app_name": "Example Application",
          "mmp_cancelled": true,
          "oto_order_ids": [
            "ETH-100234"
          ],
          "primary_order_id": "ETH-100234"
        }
      ]
    }
  ]
}

Changes

Changed in 4 of the 8 revisions of this API.13

  • 9375d9a185431See the full diff
    • ○

      added the required property result/items/positions/items/user_id to the response with the 200 status

      response-required-property-added

  • 6e5c000c82a81See the full diff
    • ○

      added the optional property result/items/open_orders/items/starbase_client_order_id to the response with the 200 status

      response-optional-property-added

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

  • 430b3f0bc67c1See the full diff
    • ○

      removed the speed_bumped enum value from the result/items/open_orders/items/order_state response property for the response status 200

      response-property-enum-value-removed

  • cc08850a8d921See the full diff
    • ●

      added the new speed_bumped enum value to the result/items/open_orders/items/order_state response property for the response status 200

      response-property-enum-value-added