Skip to main content
GET
/
v0
/
insto
/
custody
/
vaults
List vaults
curl --request GET \
  --url https://api.kraken.com/v0/insto/custody/vaults \
  --header 'api-key: <api-key>' \
  --header 'api-nonce: <api-key>' \
  --header 'api-otp: <api-key>' \
  --header 'api-sign: <api-key>'
{
  "vaults": [
    {
      "id": "VW44KPQC4C62K6",
      "iiban": "AA88 N84G AET3 RAOA",
      "name": "My Vault 1",
      "status": "created",
      "balance_diff": "1.50",
      "missing_rates": [
        {
          "asset": "XBT",
          "asset_class": "currency"
        }
      ],
      "attributes": [
        "token_vesting"
      ],
      "balance_fiat": "1000.0000",
      "deposit_lock_rekeying_only": false,
      "otc_enabled": true
    }
  ],
  "total": 1,
  "quote": {
    "asset": "USD",
    "asset_class": "currency"
  }
}

Authorizations

​
api-key
string
header
required
​
api-sign
string
header
required
​
api-nonce
string
header
required
​
api-otp
string
header
required

Query Parameters

​
org_id
string

Restrict the result set to vaults owned by the specified organization, identified by its 16-char IIBAN. Defaults to the caller's organization when omitted.

​
quote_asset
string

Asset code used to value each vault's fiat balance (e.g. USD, EUR). Defaults to USD when omitted.

​
quote_asset_class
string

Asset class of quote_asset. Currently only currency is supported.

​
limit
number<double>

Maximum number of vaults to return in the page. Defaults to 100 when omitted.

​
offset
number<double>

Number of vaults to skip before the page begins, used together with limit for offset-based pagination. Defaults to 0 when omitted.

​
id
string[]

Restrict the result set to the supplied vault IDs. Each value is a V-prefixed 14-char base32 identifier with a final check character.

​
iban
string[]

Restrict the result set to vaults whose IIBAN matches one of the supplied values. Each value is a 16-char alphanumeric IIBAN in 4x4 groups.

​
member
string[]

Restrict the result set to vaults that include the supplied member(s), each identified by their 16-char user IIBAN.

​
name
string

Filter vaults by name. Combined with name_match and name_case to control how the term is matched.

​
name_match
string

How the name term is matched against vault names. One of equals, starts_with, contains.

​
name_case
string

Case sensitivity of the name match. One of sensitive, insensitive.

​
default_approvals_left
number<double>

Lower bound (inclusive) for the vault's default required-approvals count.

​
default_approvals_right
number<double>

Upper bound (inclusive) for the vault's default required-approvals count.

​
created_at_left
string<date-time>

Include only vaults created at or after this timestamp (inclusive).

​
created_at_right
string<date-time>

Include only vaults created at or before this timestamp (inclusive).

​
updated_at_left
string<date-time>

Include only vaults last updated at or after this timestamp (inclusive).

​
updated_at_right
string<date-time>

Include only vaults last updated at or before this timestamp (inclusive).

​
order_by
string[]

Column(s) to sort the result set by, paired positionally with order_direction. Allowed columns: id, name, created_at, updated_at. Defaults to id.

​
order_direction
string[]

Sort direction(s), paired positionally with order_by. Each value is asc or desc. Defaults to desc.

​
resolve_policies
string

When set to true, include each vault's otc_enabled policy flag in the response. Omitted otherwise.

Response

OK. Returns the page of vaults the caller can access, with pagination total and the resolved quote asset.

​
vaults
object[]
required

Page of vaults matching the request filters.

​
total
number<double>
required

Total number of vaults matching the filters, ignoring pagination.

Example:

1

​
quote
object
required

Quote asset used to value the fiat balances.