> ## Documentation Index > Fetch the complete documentation index at: https://docs.kraken.com/llms.txt > Use this file to discover all available pages before exploring further. # List vaults > Retrieve all vaults within the custody domain. ## OpenAPI ````yaml /openapi/custody-rest.yaml post /0/private/ListCustodyVaults openapi: 3.0.0 info: title: REST API version: 1.1.0 description: '' servers: - url: https://api.kraken.com description: Production Server security: - API-Key: [] API-Sign: [] tags: - name: Portfolios - name: Transfers - name: Tasks paths: /0/private/ListCustodyVaults: post: tags: - Portfolios summary: List vaults description: Retrieve all vaults within the custody domain. operationId: listCustodyVaults requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/listCustodyVaults' responses: '200': content: application/json: schema: $ref: '#/components/schemas/listCustodyVaults-2' description: '' components: schemas: listCustodyVaults: type: object required: - nonce properties: nonce: $ref: '#/components/schemas/nonce' resolve_policies: description: >- If set to true, the response includes information about the feature policies enabled for the vault. nullable: true default: null type: boolean filters: example: and: [] description: >- Specify a subset of filter items. All filter objects are `AND` combined. Inside a filter object all properties are `OR` combined. default: and: [] oneOf: - description: All elements are combined with `AND`. type: object title: and properties: and: type: array items: description: Filtering expressions with or expressions oneOf: - description: All elements are combined with `OR`. type: object title: or properties: or: type: array items: oneOf: - title: id description: Filter by id oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: VaultId type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 by: type: string enum: - id required: - by - type - values - title: name description: Filter by name oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact value to match type: array items: type: string case: description: >- Case-sensitive matching behavior - `insensitive`: Filter items with case-insensitive matching - `sensitive`: Filter items with case-sensitive matching default: insensitive type: string enum: - insensitive - sensitive by: type: string enum: - name required: - by - type - values - title: starts_with description: Field must start with this filter type: object properties: type: type: string enum: - starts_with values: description: Value the column must start with type: array items: type: string case: description: >- Case-sensitive matching behavior - `insensitive`: Filter items with case-insensitive matching - `sensitive`: Filter items with case-sensitive matching default: insensitive type: string enum: - insensitive - sensitive by: type: string enum: - name required: - by - type - values - title: contains description: Field must contain this filter type: object properties: type: type: string enum: - contains values: description: Value the columns must contain type: array items: type: string case: description: >- Case-sensitive matching behavior - `insensitive`: Filter items with case-insensitive matching - `sensitive`: Filter items with case-sensitive matching default: insensitive type: string enum: - insensitive - sensitive by: type: string enum: - name required: - by - type - values - title: default_approvals description: Filter by default_approvals oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: type: array items: type: integer format: uint32 minimum: 0 by: type: string enum: - default_approvals required: - by - type - values - title: in description: >- A range uses closed intervals `[left, right]` with `left <= column <= right`. Not providing a `left` will result a left-unbounded intervals `(−∞, right]` and respectively not providing `right` will result in a right-unbounded interval `[left, ∞)`. type: object properties: type: type: string enum: - in left: nullable: true type: integer format: uint32 minimum: 0 right: nullable: true type: integer format: uint32 minimum: 0 by: type: string enum: - default_approvals required: - by - type - title: created_at description: Filter by created_at oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: type: array items: title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 by: type: string enum: - created_at required: - by - type - values - title: in description: >- A range uses closed intervals `[left, right]` with `left <= column <= right`. Not providing a `left` will result a left-unbounded intervals `(−∞, right]` and respectively not providing `right` will result in a right-unbounded interval `[left, ∞)`. type: object properties: type: type: string enum: - in left: nullable: true title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 right: nullable: true title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 by: type: string enum: - created_at required: - by - type - title: updated_at description: Filter by updated_at oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: type: array items: title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 by: type: string enum: - updated_at required: - by - type - values - title: in description: >- A range uses closed intervals `[left, right]` with `left <= column <= right`. Not providing a `left` will result a left-unbounded intervals `(−∞, right]` and respectively not providing `right` will result in a right-unbounded interval `[left, ∞)`. type: object properties: type: type: string enum: - in left: nullable: true title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 right: nullable: true title: UnixTimestamp description: Unix timestamp in seconds type: string maxLength: 13 by: type: string enum: - updated_at required: - by - type - title: member description: Filter by member oneOf: - title: equals description: Field must match the filter exactly. type: object properties: type: type: string enum: - equals values: description: Exact values to match against type: array items: description: IBAN type: string minLength: 14 maxLength: 42 by: type: string enum: - member required: - by - type - values required: - or required: - and pagination: $ref: '#/components/schemas/pagination' orderings: example: - by: id direction: desc description: >- Specify how to order the returned items. If a column in the `orderings` list contains `null` values, these are always sorted to the end. default: - by: id direction: desc type: array items: description: Result ordering type: object properties: by: enum: - id - name - created_at - updated_at description: Column to order by direction: $ref: '#/components/schemas/orderDirection' required: - by listCustodyVaults-2: type: object properties: result: nullable: true 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 type: array items: description: Metadata of a vault type: object properties: id: example: VN2F7NJJWKJHI2 description: An ID uniquely identifying the vault type: string pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$ minLength: 14 maxLength: 14 created_at: title: UnixTimestamp description: Vault creation time type: string maxLength: 13 updated_at: title: UnixTimestamp description: Last time an attribute of the vault was changed type: string maxLength: 13 count_assets: description: Count of the number of unique assets for a vault type: integer format: uint32 minimum: 0 status: type: string enum: - pending - created - failed - disabled description: |- Vault status: - `pending`: The HSM vault is still initializing - `created`: The HSM vault has been created - `failed`: The HSM vault creation has failed - `disabled`: The underlying account has been disabled iiban: description: The IIBAN of the vault. type: string minLength: 14 maxLength: 42 deposit_lock_rekeying_only: nullable: true type: boolean name: description: Vault name type: string pattern: ^[a-zA-Z0-9\s\/-]+$ minLength: 1 maxLength: 32 description: nullable: true description: A description of the vault type: string maxLength: 1024 balance_fiat: nullable: true example: '1.23' description: Total balance in fiat currency type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 balance_diff: nullable: true example: '1.23' description: >- Balance percentage daily change relative to midnight's total balance type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 available_balance_fiat: nullable: true example: '1.23' description: Available balance in fiat currency type: string pattern: ^-?[0-9]+(\.[0-9]+)?$ minLength: 1 maxLength: 64 otc_enabled: description: The setting of the OTC policy linked to the vault type: boolean required: - count_assets - created_at - id - iiban - name - status - updated_at errors: $ref: '#/components/schemas/KWebErrors' start: type: integer format: uint64 minimum: 0 total: type: integer format: uint64 minimum: 0 nonce: description: Nonce used in construction of `API-Sign` header type: integer format: int64 pagination: description: Define which items will get returned default: limit: 100 offset: 0 type: object properties: limit: description: Number of records to retrieve type: integer format: uint32 minimum: 1 maximum: 1000 offset: description: Result Offset type: integer format: uint32 minimum: 0 required: - limit - offset orderDirection: description: | Ordering direction - `asc`: Return items in ascending order (first to last) - `desc`: Return items in descending order (last to first) default: desc type: string enum: - asc - desc KWebErrors: type: array items: description: General API error. type: object properties: severity: description: API error severity. type: string enum: - E - W errorClass: type: string type: type: string errorMessage: nullable: true type: string required: - errorClass - severity - type securitySchemes: API-Key: type: apiKey description: The "API-Key" header should contain your API key. name: API-Key in: header API-Sign: type: apiKey description: >- Authenticated requests should be signed with the "API-Sign" header, using a signature generated with your private key, nonce, encoded payload, and URI path. name: API-Sign in: header ````