Skip to main content
POST
/
0
/
private
/
ListCustodyVaults
List vaults
curl --request POST \
  --url https://api.kraken.com/0/private/ListCustodyVaults \
  --header 'API-Key: <api-key>' \
  --header 'API-Sign: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nonce": 123,
  "resolve_policies": null,
  "filters": {
    "and": []
  },
  "pagination": {
    "limit": 100,
    "offset": 0
  },
  "orderings": [
    {
      "by": "id",
      "direction": "desc"
    }
  ]
}
'
{
  "result": [
    {
      "id": "VW44KPQC4C62K6",
      "name": "My Vault 1",
      "description": "My vault description",
      "created_at": "1710877421",
      "updated_at": "1710877421",
      "balance_fiat": "1000.0000",
      "balance_diff": "1.25",
      "available_balance_fiat": "1000.0000",
      "count_assets": 3,
      "status": "created",
      "iiban": "AA88 N84G AET3 RAOA",
      "deposit_lock_rekeying_only": false,
      "otc_enabled": true
    }
  ],
  "errors": [
    {
      "errorClass": "<string>",
      "type": "<string>",
      "errorMessage": "<string>"
    }
  ],
  "start": 1,
  "total": 1
}

Authorizations

​
API-Key
string
header
required

The "API-Key" header should contain your API key.

​
API-Sign
string
header
required

Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path.

Body

application/json
​
nonce
integer<int64>
required

Nonce used in construction of API-Sign header

​
resolve_policies
boolean | null

If set to true, the response includes information about the feature policies enabled for the vault.

​
filters
and · object

Specify a subset of filter items. All filter objects are AND combined. Inside a filter object all properties are OR combined.

Example:
{ "and": [] }
​
pagination
object

Define which items will get returned

​
orderings
object[]

Specify how to order the returned items. If a column in the orderings list contains null values, these are always sorted to the end.

Example:
[{ "by": "id", "direction": "desc" }]

Response

200 - application/json
​
result
object[] | null
Example:
[
  {
    "id": "VW44KPQC4C62K6",
    "name": "My Vault 1",
    "description": "My vault description",
    "created_at": "1710877421",
    "updated_at": "1710877421",
    "balance_fiat": "1000.0000",
    "balance_diff": "1.25",
    "available_balance_fiat": "1000.0000",
    "count_assets": 3,
    "status": "created",
    "iiban": "AA88 N84G AET3 RAOA",
    "deposit_lock_rekeying_only": false,
    "otc_enabled": true
  }
]
​
errors
object[]
​
start
integer<uint64>
Required range: x >= 0
​
total
integer<uint64>
Required range: x >= 0