Sign in

v1

latestOpenAPI 3.1.02026-08-04751,1671.3 MB
Vaults

List Vault Addresses

Get a list of all addresses in a vault.

get/api/v1/vaults/{id}/addresses

Path parameters

idstring uuid required

ID of the vault.

ID of the vault.

Query parameters

sort_byVaultAddressSortableFields[]
pageinteger

The page number to fetch.

The page number to fetch.

sizeinteger

The number of items per page.

The number of items per page.

skip_countboolean

Whether to skip counting the total number of items.

Whether to skip counting the total number of items.

searchstring
addressesstring[]

List of addresses to filter on.

List of addresses to filter on.

address_typesUtxoAddressType[]

List of address types to filter on.

List of address types to filter on.

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required

Example response

{
  "addresses": [
    {
      "vault": {
        "end_user": {
          "external_id": "user|1234"
        }
      },
      "balances": {
        "total_mined": "1000000000000000000",
        "total_pending_incoming": "1000000000000000000",
        "available_mined": "1000000000000000000",
        "available_pending_incoming": "1000000000000000000",
        "frozen_mined": "1000000000000000000",
        "frozen_pending_incoming": "1000000000000000000",
        "trustline_limit": "1000000000000000000"
      },
      "public_key_compressed": "SGVsbG8=",
      "derivation_path": "m/44/60/0/0/0",
      "address": {
        "address": "bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq"
      }
    }
  ]
}