Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
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"
        }
      ],
      "open_orders": [
        {
          "order_id": "ETH-100234",
          "starbase_order_id": 103148386170,
          "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",
          "app_name": "Example Application",
          "mmp_cancelled": true,
          "oto_order_ids": [
            "ETH-100234"
          ],
          "primary_order_id": "ETH-100234"
        }
      ]
    }
  ]
}