Get addresses (Paginated) - Fireblocks Developer Docs

GET

vault

accounts

{vaultAccountId}

{assetId}

addresses_paginated

TypeScript

const response: Promise<FireblocksResponse<PaginatedAddressResponse>> = fireblocks.vaults.getVaultAccountAssetAddressesPaginated(vaultsApiGetVaultAccountAssetAddressesPaginatedRequest);

{
  "addresses": [
    {
      "assetId": "<string>",
      "address": "<string>",
      "description": "<string>",
      "tag": "<string>",
      "type": "<string>",
      "customerRefId": "<string>",
      "legacyAddress": "<string>",
      "enterpriseAddress": "<string>",
      "bip44AddressIndex": 123,
      "userDefined": true
    }
  ],
  "paging": {
    "before": "<string>",
    "after": "<string>"
  }
}

Path Parameters

vaultAccountId

string<numeric>

required

The ID of the vault account to return

assetId

string

required

The ID of the asset

Query Parameters

limit

number

before

string

after

string

Response

A paginated list of addresses, and pagination info.

addresses

object[]

Show child attributes

paging

object

Show child attributes

Update address descriptionUpdates the description of an existing address of an asset in a vault account. Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

⌘I

TypeScript

const response: Promise<FireblocksResponse<PaginatedAddressResponse>> = fireblocks.vaults.getVaultAccountAssetAddressesPaginated(vaultsApiGetVaultAccountAssetAddressesPaginatedRequest);

{
  "addresses": [
    {
      "assetId": "<string>",
      "address": "<string>",
      "description": "<string>",
      "tag": "<string>",
      "type": "<string>",
      "customerRefId": "<string>",
      "legacyAddress": "<string>",
      "enterpriseAddress": "<string>",
      "bip44AddressIndex": 123,
      "userDefined": true
    }
  ],
  "paging": {
    "before": "<string>",
    "after": "<string>"
  }
}