Skip to main content

List vaults

POST 
/0/private/ListCustodyVaults

Retrieve all vaults within the custody domain.

Request​

Body

required
    required
    nonce int64

    Nonce used in construction of API-Sign header

    resolve_policies booleannullable

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

    filters object

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

    oneOf
    and object[]required
  • Array [
    • oneOf
    or object[]required
  • Array [
    • oneOf
    oneOf
    type stringrequired

    Possible values: [equals]

    values string[]required

    Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

    Exact values to match against

    by stringrequired

    Possible values: [id]

  • ]
  • ]
    • pagination object

    Define which items will get returned

    limit uint32required

    Possible values: >= 1 and <= 1000

    Number of records to retrieve

    offset uint32required

    Result Offset

    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.

  • Array [
    • by required

    Possible values: [id, name, created_at, updated_at]

    Column to order by

    direction orderDirection (string)

    Possible values: [asc, desc]

    Default value: desc

    Ordering direction

    • asc: Return items in ascending order (first to last)
    • desc: Return items in descending order (last to first)
  • ]

Responses​

Schema
    result object[]nullable
  • Array [
    • id stringrequired

    Possible values: >= 14 characters and <= 14 characters, Value must match regular expression ^V[A-Z2-7]{12}[ACEGIKMOQSUWY246]$

    An ID uniquely identifying the vault

    created_at UnixTimestamp (string)required

    Possible values: <= 13 characters

    Vault creation time

    updated_at UnixTimestamp (string)required

    Possible values: <= 13 characters

    Last time an attribute of the vault was changed

    count_assets uint32required

    Count of the number of unique assets for a vault

    status stringrequired

    Possible values: [pending, created, failed, disabled]

    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 stringrequired

    Possible values: >= 14 characters and <= 42 characters

    The IIBAN of the vault.

    deposit_lock_rekeying_only booleannullable
    name stringrequired

    Possible values: non-empty and <= 32 characters, Value must match regular expression ^[a-zA-Z0-9\s\/-]+$

    Vault name

    description stringnullable

    Possible values: <= 1024 characters

    A description of the vault

    balance_fiat stringnullable

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

    Total balance in fiat currency

    balance_diff stringnullable

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

    Balance percentage daily change relative to midnight's total balance

    available_balance_fiat stringnullable

    Possible values: non-empty and <= 64 characters, Value must match regular expression ^-?[0-9]+(\.[0-9]+)?$

    Available balance in fiat currency

    otc_enabled boolean

    The setting of the OTC policy linked to the vault

  • ]
    • errors object[]
  • Array [
    • severity stringrequired

    Possible values: [E, W]

    API error severity.

    errorClass stringrequired
    type stringrequired
    errorMessage stringnullable
  • ]
    • start uint64
    total uint64
Loading...