> ## Documentation Index
> Fetch the complete documentation index at: https://kraken-sandbox.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get vault information by id

> Retrieve information and balances for a specific vault.



## OpenAPI

````yaml /openapi/custody-rest.yaml post /0/private/GetCustodyVault
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/GetCustodyVault:
    post:
      tags:
        - Portfolios
      summary: Get vault information by id
      description: Retrieve information and balances for a specific vault.
      operationId: getCustodyVault
      parameters:
        - $ref: '#/components/parameters/vaultId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
                - nonce
              properties:
                nonce:
                  $ref: '#/components/schemas/nonce'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/getCustodyVault'
          description: ''
components:
  parameters:
    vaultId:
      in: query
      name: id
      required: true
      deprecated: false
      schema:
        description: Vault ID
        type: string
        pattern: ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$
        minLength: 14
        maxLength: 14
      style: form
      allowEmptyValue: false
      description: Vault ID
  schemas:
    nonce:
      description: Nonce used in construction of `API-Sign` header
      type: integer
      format: int64
    getCustodyVault:
      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
            asset_details:
              - asset: BTC
                current_usd_price: '7.00'
                available_balance:
                  current_usd_value: '20.0'
                  quantity: '0.00000500'
                total_balance:
                  current_usd_value: '5.00'
                  quantity: '0.00001000'
            status: created
            iiban: AA88 N84G AET3 RAOA
            deposit_lock_rekeying_only: false
          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
            asset_details:
              description: A list of the assets in this vault
              type: array
              items:
                type: object
                properties:
                  asset:
                    description: The asset as ISO x-iso-4217-a3
                    type: string
                    minLength: 1
                    maxLength: 16
                  current_usd_price:
                    nullable: true
                    example: '1.23'
                    description: Current USD price of the asset
                    type: string
                    pattern: ^-?[0-9]+(\.[0-9]+)?$
                    minLength: 1
                    maxLength: 64
                  available_balance:
                    description: Available amount of a crypto-asset
                    type: object
                    properties:
                      current_usd_value:
                        nullable: true
                        example: '1.23'
                        description: Current USD value of the asset
                        type: string
                        pattern: ^-?[0-9]+(\.[0-9]+)?$
                        minLength: 1
                        maxLength: 64
                      quantity:
                        example: '1.23'
                        description: Asset quantity
                        type: string
                        pattern: ^-?[0-9]+(\.[0-9]+)?$
                        minLength: 1
                        maxLength: 64
                    required:
                      - quantity
                  total_balance:
                    description: Total amount of a crypto-asset
                    type: object
                    properties:
                      current_usd_value:
                        nullable: true
                        example: '1.23'
                        description: Current USD value of the asset
                        type: string
                        pattern: ^-?[0-9]+(\.[0-9]+)?$
                        minLength: 1
                        maxLength: 64
                      quantity:
                        example: '1.23'
                        description: Asset quantity
                        type: string
                        pattern: ^-?[0-9]+(\.[0-9]+)?$
                        minLength: 1
                        maxLength: 64
                    required:
                      - quantity
                required:
                  - asset
                  - available_balance
                  - total_balance
            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
          required:
            - asset_details
            - count_assets
            - created_at
            - id
            - iiban
            - name
            - status
            - updated_at
        errors:
          $ref: '#/components/schemas/KWebErrors'
      required:
        - errors
    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

````