Get subaccounts

Return information about subaccounts, including balances and UIDs.

GET /subaccounts

Get subaccounts

cURL

curl --request GET \
  --url https://futures.kraken.com/derivatives/api/v3/subaccounts \
  --header 'APIKey: <api-key>' \
  --header 'Authent: <api-key>'

200

{
  "result": "success",
  "serverTime": "2022-03-31T20:38:53.677Z",
  "masterAccountUid": "ba598ca1-65c1-4f48-927d-0e2b647d627a",
  "subaccounts": [
    {
      "holdingAccounts": [
        {
          "currency": "gbp",
          "amount": 0
        },
        {
          "currency": "bch",
          "amount": 0.00004
        },
        {
          "currency": "xrp",
          "amount": 13662.85078
        },
        {
          "currency": "usd",
          "amount": 0
        },
        {
          "currency": "eth",
          "amount": 3.0000485057
        },
        {
          "currency": "usdt",
          "amount": 0
        },
        {
          "currency": "ltc",
          "amount": 0.00002
        },
        {
          "currency": "usdc",
          "amount": 0
        },
        {
          "currency": "xbt",
          "amount": 3.46e-9
        }
      ],
      "futuresAccounts": [
        {
          "name": "f-xrp:usd",
          "availableMargin": 16187.33210488726
        },
        {
          "name": "f-eth:usd",
          "availableMargin": 67.59768318324302
        },
        {
          "name": "f-xbt:usd",
          "availableMargin": -0.0009056832839642471
        },
        {
          "name": "f-ltc:usd",
          "availableMargin": 67.51126059691163
        },
        {
          "name": "f-xrp:xbt",
          "availableMargin": 2.34e-9
        },
        {
          "name": "f-bch:usd",
          "availableMargin": 47.151615710695495
        }
      ],
      "flexAccount": {
        "currencies": [
          {
            "currency": "eth",
            "quantity": 0.5,
            "value": 1646.575,
            "collateral": 1543.91104875,
            "available": 0.49999966035931903
          },
          {
            "currency": "usdt",
            "quantity": 0,
            "value": 0,
            "collateral": 0,
            "available": 0
          },
          {
            "currency": "gbp",
            "quantity": 0,
            "value": 0,
            "collateral": 0,
            "available": 0
          },
          {
            "currency": "xbt",
            "quantity": 0,
            "value": 0,
            "collateral": 0,
            "available": 0
          },
          {
            "currency": "usdc",
            "quantity": 0,
            "value": 0,
            "collateral": 0,
            "available": 0
          },
          {
            "currency": "usd",
            "quantity": 0,
            "value": 0,
            "collateral": 0,
            "available": 0
          }
        ],
        "initialMargin": 0,
        "initialMarginWithOrders": 0,
        "maintenanceMargin": 0,
        "balanceValue": 1646.58,
        "portfolioValue": 1646.58,
        "collateralValue": 1543.91,
        "pnl": 0,
        "unrealizedFunding": 0,
        "totalUnrealized": 0,
        "totalUnrealizedAsMargin": 0,
        "availableMargin": 1543.91,
        "marginEquity": 1543.91
      },
      "fullName": "fullname redacted",
      "email": "email redacted",
      "accountUid": "7f5c528e-2285-45f0-95f5-83d53d4bfcd2"
    }
  ]
}

Authorizations

APIKey · string · header · required

General API key with at least read-only access

Authent · string · header · required

Authentication string

Response

200 - application/json

Success Response

Errors

masterAccountUid · string · required

Master account UID

subaccounts · object[] · required

The sub-accounts.

Show child attributes

result · enum<string> · required

Available options: success

Example:

"success"

serverTime · string<date-time> · required

Server time in Coordinated Universal Time (UTC)

Example:

"2020-08-27T17:03:33.196Z"