List vaults

Retrieve all vaults within the custody domain.

POST /0/private/ListCustodyVaults

List vaults

cURL

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"
    }
  ]
}
'

import requests

url = "https://api.kraken.com/0/private/ListCustodyVaults"

payload = {
    "nonce": 123,
    "resolve_policies": None,
    "filters": { "and": [] },
    "pagination": {
        "limit": 100,
        "offset": 0
    },
    "orderings": [
        {
            "by": "id",
            "direction": "desc"
        }
    ]
}
headers = {
    "API-Key": "<api-key>",
    "API-Sign": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'API-Key': '<api-key>',
    'API-Sign': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    nonce: 123,
    resolve_policies: null,
    filters: {and: []},
    pagination: {limit: 100, offset: 0},
    orderings: [{by: 'id', direction: 'desc'}]
  })
};

fetch('https://api.kraken.com/0/private/ListCustodyVaults', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kraken.com/0/private/ListCustodyVaults"

	payload := strings.NewReader("{\n  \"nonce\": 123,\n  \"resolve_policies\": null,\n  \"filters\": {\n    \"and\": []\n  },\n  \"pagination\": {\n    \"limit\": 100,\n    \"offset\": 0\n  },\n  \"orderings\": [\n    {\n      \"by\": \"id\",\n      \"direction\": \"desc\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("API-Key", "<api-key>")
	req.Header.Add("API-Sign", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

200

{
  "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.

Show child attributes

Example:

{ "and": [] }

pagination · object

Define which items will get returned

Show child attributes

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.

Show child attributes

Example:

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

Response

200 - application/json

result · object[] | null

Show child attributes

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[]

Show child attributes

start · integer<uint64>

Required range: x >= 0

total · integer<uint64>

Required range: x >= 0