VaultsApi

All URIs are relative to https://developers.fireblocks.com/reference/

Method	HTTP request	Description
activateAssetForVaultAccount	POST /vault/accounts/{vaultAccountId}/{assetId}/activate	Activate a wallet in a vault account
attachOrDetachTagsFromVaultAccounts	POST /vault/accounts/attached_tags	Attach or detach tags from vault accounts
createLegacyAddress	POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy	Convert a segwit address to legacy format
createMultipleAccounts	POST /vault/accounts/bulk	Bulk creation of new vault accounts
createMultipleDepositAddresses	POST /vault/accounts/addresses/bulk	Bulk creation of new deposit addresses
createVaultAccount	POST /vault/accounts	Create a new vault account
createVaultAccountAsset	POST /vault/accounts/{vaultAccountId}/{assetId}	Create a new vault wallet
createVaultAccountAssetAddress	POST /vault/accounts/{vaultAccountId}/{assetId}/addresses	Create new asset deposit address
getAssetWallets	GET /vault/asset_wallets	Get vault wallets (Paginated)
getCreateMultipleDepositAddressesJobStatus	GET /vault/accounts/addresses/bulk/{jobId}	Get the job status of the bulk deposit address creation
getCreateMultipleVaultAccountsJobStatus	GET /vault/accounts/bulk/{jobId}	Get job status of bulk creation of new vault accounts
getMaxBipIndexUsed	GET /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_used	Get maximum BIP44 index used
getMaxSpendableAmount	GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount	Get max spendable amount in a transaction
getPagedVaultAccounts	GET /vault/accounts_paged	Get vault accounts (Paginated)
getPublicKeyInfo	GET /vault/public_key_info	Get the public key for a derivation path
getPublicKeyInfoForAddress	GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info	Get an asset's public key
getUnspentInputs	GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs	Get UTXO unspent inputs information
getVaultAccount	GET /vault/accounts/{vaultAccountId}	Get a vault account by ID
getVaultAccountAsset	GET /vault/accounts/{vaultAccountId}/{assetId}	Get the asset balance for a vault account
getVaultAccountAssetAddressesPaginated	GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated	Get addresses (Paginated)
getVaultAssets	GET /vault/assets	Get asset balance for chosen assets
getVaultBalanceByAsset	GET /vault/assets/{assetId}	Get vault balance by an asset
hideVaultAccount	POST /vault/accounts/{vaultAccountId}/hide	Hide a vault account in the console
setCustomerRefIdForAddress	POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id	Assign AML customer reference ID
setVaultAccountAutoFuel	POST /vault/accounts/{vaultAccountId}/set_auto_fuel	Set auto fueling to on or off
setVaultAccountCustomerRefId	POST /vault/accounts/{vaultAccountId}/set_customer_ref_id	Set an AML/KYT ID for a vault account
unhideVaultAccount	POST /vault/accounts/{vaultAccountId}/unhide	Unhide a vault account in the console
updateVaultAccount	PUT /vault/accounts/{vaultAccountId}	Rename a vault account
updateVaultAccountAssetAddress	PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}	Update address description
updateVaultAccountAssetBalance	POST /vault/accounts/{vaultAccountId}/{assetId}/balance	Refresh asset balance data

activateAssetForVaultAccount

CreateVaultAssetResponse activateAssetForVaultAccount()

Initiates activation for a wallet in a vault account. Activation is required for tokens that need an on-chain transaction for creation (XLM tokens, SOL tokens etc).
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiActivateAssetForVaultAccountRequest, CreateVaultAssetResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiActivateAssetForVaultAccountRequest = {
  // string | The ID of the vault account to return, or \'default\' for the default vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
  // string | Optional immutable blockchain wallet type to store per tenant+vault (optional)
  blockchainWalletType: blockchainWalletType_example,
};

fireblocks.vaults.activateAssetForVaultAccount(body).then((res: FireblocksResponse<CreateVaultAssetResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account to return, or 'default' for the default vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined
blockchainWalletType	[string]	Optional immutable blockchain wallet type to store per tenant+vault	(optional) defaults to undefined

Return type

CreateVaultAssetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

attachOrDetachTagsFromVaultAccounts

VaultAccountsTagAttachmentOperationsResponse attachOrDetachTagsFromVaultAccounts(vaultAccountsTagAttachmentOperationsRequest)

Attach or detach one or more tags from the requested vault accounts. Endpoint Permission: For protected tags: Owner, Admin, Non-Signing Admin. For non protected tags: Owner, Admin, Non-Signing Admin, Signer, Editor, Approver.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiAttachOrDetachTagsFromVaultAccountsRequest, VaultAccountsTagAttachmentOperationsResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiAttachOrDetachTagsFromVaultAccountsRequest = {
  // VaultAccountsTagAttachmentOperationsRequest
  vaultAccountsTagAttachmentOperationsRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.attachOrDetachTagsFromVaultAccounts(body).then((res: FireblocksResponse<VaultAccountsTagAttachmentOperationsResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountsTagAttachmentOperationsRequest	VaultAccountsTagAttachmentOperationsRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultAccountsTagAttachmentOperationsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Tags were attached/detached successfully	* X-Request-ID -
400	- Invalid request parameters. - Same tag ID is provided in both tagIdsToAttach and tagIdsToDetach. - Vault accounts are archived.	* X-Request-ID -
404	- Tags with the requested ID not found. - Vault accounts with the requested ID not found.	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createLegacyAddress

CreateAddressResponse createLegacyAddress()

Converts an existing segwit address to the legacy format.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiCreateLegacyAddressRequest, CreateAddressResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiCreateLegacyAddressRequest = {
  // string | The ID of the vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // string | The segwit address to translate
  addressId: addressId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.createLegacyAddress(body).then((res: FireblocksResponse<CreateAddressResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
addressId	[string]	The segwit address to translate	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

CreateAddressResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The created address	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createMultipleAccounts

JobCreated createMultipleAccounts(createMultipleAccountsRequest)

Create multiple vault accounts by running an async job. - The HBAR, TON, SUI, TERRA, ALGO, and DOT blockchains are not supported. - These endpoints are currently in beta and might be subject to changes. - Limited to a maximum of 10,000 accounts per operation. Endpoint Permissions: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiCreateMultipleAccountsRequest, JobCreated } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiCreateMultipleAccountsRequest = {
  // CreateMultipleAccountsRequest
  createMultipleAccountsRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.createMultipleAccounts(body).then((res: FireblocksResponse<JobCreated>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createMultipleAccountsRequest	CreateMultipleAccountsRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

JobCreated

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A JobCreated object	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createMultipleDepositAddresses

JobCreated createMultipleDepositAddresses(createMultipleDepositAddressesRequest)

For UTXO blockchains only. Create multiple deposit addresses by running an async job. - The target Vault account should already have a UTXO asset wallet with a permanent address. - Limited to a maximum of 10,000 addresses per operation. Use multiple operations for the same Vault account/permanent address if needed. Endpoint Permissions: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiCreateMultipleDepositAddressesRequest, JobCreated } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiCreateMultipleDepositAddressesRequest = {
  // CreateMultipleDepositAddressesRequest
  createMultipleDepositAddressesRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.createMultipleDepositAddresses(body).then((res: FireblocksResponse<JobCreated>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createMultipleDepositAddressesRequest	CreateMultipleDepositAddressesRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

JobCreated

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A JobCreated object	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createVaultAccount

VaultAccount createVaultAccount(createVaultAccountRequest)

Creates a new vault account with the requested name. **Note: ** Vault account names should consist of ASCII characters only. Learn more about Fireblocks Vault Accounts in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiCreateVaultAccountRequest, VaultAccount } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiCreateVaultAccountRequest = {
  // CreateVaultAccountRequest
  createVaultAccountRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.createVaultAccount(body).then((res: FireblocksResponse<VaultAccount>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createVaultAccountRequest	CreateVaultAccountRequest
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultAccount

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A Vault Account object	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createVaultAccountAsset

CreateVaultAssetResponse createVaultAccountAsset()

Creates a wallet for a specific asset in a vault account. Learn more about Fireblocks Vault Wallets in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiCreateVaultAccountAssetRequest, CreateVaultAssetResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiCreateVaultAccountAssetRequest = {
  // string | The ID of the vault account to return, or \'default\' for the default vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // CreateAssetsRequest (optional)
  createAssetsRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
  // string | Optional immutable blockchain wallet type to store per tenant+vault (optional)
  blockchainWalletType: blockchainWalletType_example,
};

fireblocks.vaults.createVaultAccountAsset(body).then((res: FireblocksResponse<CreateVaultAssetResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createAssetsRequest	CreateAssetsRequest
vaultAccountId	[string]	The ID of the vault account to return, or 'default' for the default vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined
blockchainWalletType	[string]	Optional immutable blockchain wallet type to store per tenant+vault	(optional) defaults to undefined

Return type

CreateVaultAssetResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

createVaultAccountAssetAddress

CreateAddressResponse createVaultAccountAssetAddress()

Creates a new deposit address for an asset of a vault account. Should be used for UTXO or Tag/Memo based assets ONLY. Requests with account based assets will fail.
Endpoint Permission: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiCreateVaultAccountAssetAddressRequest, CreateAddressResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiCreateVaultAccountAssetAddressRequest = {
  // string | The ID of the vault account to return
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // CreateAddressRequest (optional)
  createAddressRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.createVaultAccountAssetAddress(body).then((res: FireblocksResponse<CreateAddressResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
createAddressRequest	CreateAddressRequest
vaultAccountId	[string]	The ID of the vault account to return	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

CreateAddressResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The created address	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAssetWallets

PaginatedAssetWalletResponse getAssetWallets()

Get all vault wallets of the vault accounts in your workspace. A vault wallet is an asset in a vault account. This method allows fast traversal of all account balances.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetAssetWalletsRequest, PaginatedAssetWalletResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetAssetWalletsRequest = {
  // number | When specified, only vault wallets with total balance greater than this amount are returned. (optional)
  totalAmountLargerThan: 8.14,
  // string | When specified, only vault wallets with the specified ID are returned. (optional)
  assetId: assetId_example,
  // 'ASC' | 'DESC' (optional)
  orderBy: orderBy_example,
  // string | Fetches the next paginated response before this element.  This element is a cursor and is returned at the response of the previous page.  (optional)
  before: before_example,
  // string | Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page. (optional)
  after: after_example,
  // number | The maximum number of vault wallets in a single response.   The default is 200 and the maximum is 1000.  (optional)
  limit: 8.14,
};

fireblocks.vaults.getAssetWallets(body).then((res: FireblocksResponse<PaginatedAssetWalletResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
totalAmountLargerThan	[number]	When specified, only vault wallets with total balance greater than this amount are returned.	(optional) defaults to undefined
assetId	[string]	When specified, only vault wallets with the specified ID are returned.	(optional) defaults to undefined
orderBy	[**'ASC'	'DESC']Array<'ASC' \| 'DESC'>**
before	[string]	Fetches the next paginated response before this element. This element is a cursor and is returned at the response of the previous page.	(optional) defaults to undefined
after	[string]	Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page.	(optional) defaults to undefined
limit	[number]	The maximum number of vault wallets in a single response. The default is 200 and the maximum is 1000.	(optional) defaults to 200

Return type

PaginatedAssetWalletResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A PaginatedAssetWalletResponse object	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCreateMultipleDepositAddressesJobStatus

CreateMultipleDepositAddressesJobStatus getCreateMultipleDepositAddressesJobStatus()

Returns the current status of (or an error for) the specified deposit addresss bulk creation job. Endpoint Permissions: Admin, Non-Signing Admin, Signer, Approver, Editor, and Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest, CreateMultipleDepositAddressesJobStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetCreateMultipleDepositAddressesJobStatusRequest = {
  // string | The ID of the job to create addresses
  jobId: 019681b4-107d-7243-942d-4c3c30e36fae,
};

fireblocks.vaults.getCreateMultipleDepositAddressesJobStatus(body).then((res: FireblocksResponse<CreateMultipleDepositAddressesJobStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
jobId	[string]	The ID of the job to create addresses	defaults to undefined

Return type

CreateMultipleDepositAddressesJobStatus

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A Job with status	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCreateMultipleVaultAccountsJobStatus

CreateMultipleVaultAccountsJobStatus getCreateMultipleVaultAccountsJobStatus()

Returns the current status of (or error for) the specified vault account bulk creation job. Endpoint Permissions: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest, CreateMultipleVaultAccountsJobStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetCreateMultipleVaultAccountsJobStatusRequest = {
  // string | The ID of the job to create addresses
  jobId: 019681b4-107d-7243-942d-4c3c30e36fae,
};

fireblocks.vaults.getCreateMultipleVaultAccountsJobStatus(body).then((res: FireblocksResponse<CreateMultipleVaultAccountsJobStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
jobId	[string]	The ID of the job to create addresses	defaults to undefined

Return type

CreateMultipleVaultAccountsJobStatus

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A Job with status	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMaxBipIndexUsed

GetMaxBipIndexUsedResponse getMaxBipIndexUsed()

Retrieves the maximum BIP44 address index and change address index used for a specific asset in a vault account (BIP44 standard).

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetMaxBipIndexUsedRequest, GetMaxBipIndexUsedResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetMaxBipIndexUsedRequest = {
  // string | The ID of the vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
};

fireblocks.vaults.getMaxBipIndexUsed(body).then((res: FireblocksResponse<GetMaxBipIndexUsedResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined

Return type

GetMaxBipIndexUsedResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMaxSpendableAmount

GetMaxSpendableAmountResponse getMaxSpendableAmount()

UTXO assets only. Retrieve the maximum amount of the specified asset that can be spent in a single transaction from the specified vault account. Endpoint Permissions: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetMaxSpendableAmountRequest, GetMaxSpendableAmountResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetMaxSpendableAmountRequest = {
  // string | The ID of the vault account, or \'default\' for the default vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // boolean | False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device. (optional)
  manualSignging: true,
};

fireblocks.vaults.getMaxSpendableAmount(body).then((res: FireblocksResponse<GetMaxSpendableAmountResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account, or 'default' for the default vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
manualSignging	[boolean]	False by default. The maximum number of inputs depends if the transaction will be signed by an automated co-signer server or on a mobile device.	(optional) defaults to undefined

Return type

GetMaxSpendableAmountResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPagedVaultAccounts

VaultAccountsPagedResponse getPagedVaultAccounts()

Gets all vault accounts in your workspace. This endpoint returns a limited amount of results with a quick response time.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetPagedVaultAccountsRequest, VaultAccountsPagedResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetPagedVaultAccountsRequest = {
  // string (optional)
  namePrefix: namePrefix_example,
  // string (optional)
  nameSuffix: nameSuffix_example,
  // number | Specifying minAmountThreshold will filter accounts whose total balance is greater than this value; otherwise, it returns all accounts. The amount set in this parameter represents the native asset amount, not its USD value. (optional)
  minAmountThreshold: 10,
  // string (optional)
  assetId: assetId_example,
  // 'ASC' | 'DESC' (optional)
  orderBy: orderBy_example,
  // string (optional)
  before: before_example,
  // string (optional)
  after: after_example,
  // number (optional)
  limit: 8.14,
  // Array<string> | DEPRECATED - use includeTagIds instead (optional)
  tagIds: param_value,
  // Array<string> | List of tag IDs to include. Vault accounts with any of these tags will be included (optional)
  includeTagIds: param_value,
  // Array<string> | List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out (optional)
  excludeTagIds: param_value,
};

fireblocks.vaults.getPagedVaultAccounts(body).then((res: FireblocksResponse<VaultAccountsPagedResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
namePrefix	[string]		(optional) defaults to undefined
nameSuffix	[string]		(optional) defaults to undefined
minAmountThreshold	[number]	Specifying minAmountThreshold will filter accounts whose total balance is greater than this value; otherwise, it returns all accounts. The amount set in this parameter represents the native asset amount, not its USD value.	(optional) defaults to undefined
assetId	[string]		(optional) defaults to undefined
orderBy	[**'ASC'	'DESC']Array<'ASC' \| 'DESC'>**
before	[string]		(optional) defaults to undefined
after	[string]		(optional) defaults to undefined
limit	[number]		(optional) defaults to 200
tagIds	Array<string>	DEPRECATED - use includeTagIds instead	(optional) defaults to undefined
includeTagIds	Array<string>	List of tag IDs to include. Vault accounts with any of these tags will be included	(optional) defaults to undefined
excludeTagIds	Array<string>	List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out	(optional) defaults to undefined

Return type

VaultAccountsPagedResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A VaultAccountsPagedResponse object	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPublicKeyInfo

PublicKeyInformation getPublicKeyInfo()

Gets the public key information based on derivation path and signing algorithm.
Endpoint Permission: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetPublicKeyInfoRequest, PublicKeyInformation } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetPublicKeyInfoRequest = {
  // string
  derivationPath: derivationPath_example,
  // string
  algorithm: algorithm_example,
  // boolean (optional)
  compressed: true,
};

fireblocks.vaults.getPublicKeyInfo(body).then((res: FireblocksResponse<PublicKeyInformation>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Notes
derivationPath	[string]	defaults to undefined
algorithm	[string]	defaults to undefined
compressed	[boolean]	(optional) defaults to undefined

Return type

PublicKeyInformation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Public key information	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getPublicKeyInfoForAddress

PublicKeyInformation getPublicKeyInfoForAddress()

Get the public key information for a specific asset in a vault account.
Endpoint Permission: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetPublicKeyInfoForAddressRequest, PublicKeyInformation } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetPublicKeyInfoForAddressRequest = {
  // string
  vaultAccountId: vaultAccountId_example,
  // string
  assetId: assetId_example,
  // number
  change: 8.14,
  // number
  addressIndex: 8.14,
  // boolean (optional)
  compressed: true,
};

fireblocks.vaults.getPublicKeyInfoForAddress(body).then((res: FireblocksResponse<PublicKeyInformation>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Notes
vaultAccountId	[string]	defaults to undefined
assetId	[string]	defaults to undefined
change	[number]	defaults to undefined
addressIndex	[number]	defaults to undefined
compressed	[boolean]	(optional) defaults to undefined

Return type

PublicKeyInformation

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Public Key Information	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUnspentInputs

GetUnspentInputsResponse getUnspentInputs()

Returns unspent inputs information of an UTXO asset in a vault account.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetUnspentInputsRequest, GetUnspentInputsResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetUnspentInputsRequest = {
  // string | The ID of the vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
};

fireblocks.vaults.getUnspentInputs(body).then((res: FireblocksResponse<GetUnspentInputsResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined

Return type

GetUnspentInputsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of Unspent information per input	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVaultAccount

VaultAccount getVaultAccount()

Get a vault account by its unique ID.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetVaultAccountRequest, VaultAccount } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetVaultAccountRequest = {
  // string | The ID of the vault account
  vaultAccountId: vaultAccountId_example,
};

fireblocks.vaults.getVaultAccount(body).then((res: FireblocksResponse<VaultAccount>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account	defaults to undefined

Return type

VaultAccount

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A Vault Account object	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVaultAccountAsset

VaultAsset getVaultAccountAsset()

Returns a specific vault wallet balance information for a specific asset.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetVaultAccountAssetRequest, VaultAsset } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetVaultAccountAssetRequest = {
  // string | The ID of the vault account to return
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
};

fireblocks.vaults.getVaultAccountAsset(body).then((res: FireblocksResponse<VaultAsset>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account to return	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined

Return type

VaultAsset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A VaultAsset object	-
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVaultAccountAssetAddressesPaginated

PaginatedAddressResponse getVaultAccountAssetAddressesPaginated()

Returns a paginated response of the addresses for a given vault account and asset.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetVaultAccountAssetAddressesPaginatedRequest, PaginatedAddressResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetVaultAccountAssetAddressesPaginatedRequest = {
  // string | The ID of the vault account to return
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // number (optional)
  limit: 8.14,
  // string (optional)
  before: before_example,
  // string (optional)
  after: after_example,
};

fireblocks.vaults.getVaultAccountAssetAddressesPaginated(body).then((res: FireblocksResponse<PaginatedAddressResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account to return	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
limit	[number]		(optional) defaults to undefined
before	[string]		(optional) defaults to undefined
after	[string]		(optional) defaults to undefined

Return type

PaginatedAddressResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A paginated list of addresses, and pagination info.	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVaultAssets

GetVaultAssetsResponse getVaultAssets()

Gets the assets amount summary for all accounts or filtered accounts.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetVaultAssetsRequest, GetVaultAssetsResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetVaultAssetsRequest = {
  // string (optional)
  accountNamePrefix: accountNamePrefix_example,
  // string (optional)
  accountNameSuffix: accountNameSuffix_example,
};

fireblocks.vaults.getVaultAssets(body).then((res: FireblocksResponse<GetVaultAssetsResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
accountNamePrefix	[string]		(optional) defaults to undefined
accountNameSuffix	[string]		(optional) defaults to undefined

Return type

GetVaultAssetsResponse

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Amount by asset	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getVaultBalanceByAsset

VaultAsset getVaultBalanceByAsset()

Get the total balance of an asset across all the vault accounts.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiGetVaultBalanceByAssetRequest, VaultAsset } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiGetVaultBalanceByAssetRequest = {
  // string
  assetId: assetId_example,
};

fireblocks.vaults.getVaultBalanceByAsset(body).then((res: FireblocksResponse<VaultAsset>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
assetId	[string]		defaults to undefined

Return type

VaultAsset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Vault amount by asset	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

hideVaultAccount

VaultActionStatus hideVaultAccount()

Hides the requested vault account from the web console view. This operation is required when creating thousands of vault accounts to serve your end-users. Used for preventing the web console to be swamped with too much vault accounts. Learn more in the following guide. NOTE: Hiding the vault account from the web console will also hide all the related transactions to/from this vault.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiHideVaultAccountRequest, VaultActionStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiHideVaultAccountRequest = {
  // string | The vault account to hide
  vaultAccountId: vaultAccountId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.hideVaultAccount(body).then((res: FireblocksResponse<VaultActionStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The vault account to hide	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultActionStatus

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setCustomerRefIdForAddress

VaultActionStatus setCustomerRefIdForAddress(setCustomerRefIdForAddressRequest, )

Sets an AML/KYT customer reference ID for a specific address.
Endpoint Permission: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiSetCustomerRefIdForAddressRequest, VaultActionStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiSetCustomerRefIdForAddressRequest = {
  // SetCustomerRefIdForAddressRequest
  setCustomerRefIdForAddressRequest: param_value,
  // string | The ID of the vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // string | The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
  addressId: addressId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.setCustomerRefIdForAddress(body).then((res: FireblocksResponse<VaultActionStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
setCustomerRefIdForAddressRequest	SetCustomerRefIdForAddressRequest
vaultAccountId	[string]	The ID of the vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
addressId	[string]	The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultActionStatus

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setVaultAccountAutoFuel

VaultActionStatus setVaultAccountAutoFuel(setAutoFuelRequest, )

Toggles the auto fueling property of the vault account to enabled or disabled. Vault Accounts with 'autoFuel=true' are monitored and auto fueled by the Fireblocks Gas Station. Learn more about the Fireblocks Gas Station in the following guide.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiSetVaultAccountAutoFuelRequest, VaultActionStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiSetVaultAccountAutoFuelRequest = {
  // SetAutoFuelRequest
  setAutoFuelRequest: param_value,
  // string | The vault account ID
  vaultAccountId: vaultAccountId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.setVaultAccountAutoFuel(body).then((res: FireblocksResponse<VaultActionStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
setAutoFuelRequest	SetAutoFuelRequest
vaultAccountId	[string]	The vault account ID	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultActionStatus

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

setVaultAccountCustomerRefId

VaultActionStatus setVaultAccountCustomerRefId(setCustomerRefIdRequest, )

Assigns an AML/KYT customer reference ID for the vault account. Learn more about Fireblocks AML management in the following guide.
Endpoint Permission: Admin, Non-Signing Admin.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiSetVaultAccountCustomerRefIdRequest, VaultActionStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiSetVaultAccountCustomerRefIdRequest = {
  // SetCustomerRefIdRequest
  setCustomerRefIdRequest: param_value,
  // string | The vault account ID
  vaultAccountId: vaultAccountId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.setVaultAccountCustomerRefId(body).then((res: FireblocksResponse<VaultActionStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
setCustomerRefIdRequest	SetCustomerRefIdRequest
vaultAccountId	[string]	The vault account ID	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultActionStatus

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unhideVaultAccount

VaultActionStatus unhideVaultAccount()

Makes a hidden vault account visible in web console view.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiUnhideVaultAccountRequest, VaultActionStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiUnhideVaultAccountRequest = {
  // string | The vault account to unhide
  vaultAccountId: vaultAccountId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.unhideVaultAccount(body).then((res: FireblocksResponse<VaultActionStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The vault account to unhide	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultActionStatus

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateVaultAccount

RenameVaultAccountResponse updateVaultAccount(updateVaultAccountRequest, )

Renames the requested vault account.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiUpdateVaultAccountRequest, RenameVaultAccountResponse } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiUpdateVaultAccountRequest = {
  // UpdateVaultAccountRequest
  updateVaultAccountRequest: param_value,
  // string | The ID of the vault account to edit
  vaultAccountId: vaultAccountId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.updateVaultAccount(body).then((res: FireblocksResponse<RenameVaultAccountResponse>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
updateVaultAccountRequest	UpdateVaultAccountRequest
vaultAccountId	[string]	The ID of the vault account to edit	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

RenameVaultAccountResponse

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateVaultAccountAssetAddress

VaultActionStatus updateVaultAccountAssetAddress()

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

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiUpdateVaultAccountAssetAddressRequest, VaultActionStatus } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiUpdateVaultAccountAssetAddressRequest = {
  // string | The ID of the vault account
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // string | The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
  addressId: addressId_example,
  // UpdateVaultAccountAssetAddressRequest (optional)
  updateVaultAccountAssetAddressRequest: param_value,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.updateVaultAccountAssetAddress(body).then((res: FireblocksResponse<VaultActionStatus>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
updateVaultAccountAssetAddressRequest	UpdateVaultAccountAssetAddressRequest
vaultAccountId	[string]	The ID of the vault account	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
addressId	[string]	The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultActionStatus

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
201	OK	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateVaultAccountAssetBalance

VaultAsset updateVaultAccountAssetBalance()

Updates the balance of a specific asset in a vault account. This API endpoint is subject to a strict rate limit. Should be used by clients in very specific scenarios.
Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor.

Example

import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from '@fireblocks/ts-sdk';
import type { FireblocksResponse, VaultsApiUpdateVaultAccountAssetBalanceRequest, VaultAsset } from '@fireblocks/ts-sdk';

// Set the environment variables for authentication
process.env.FIREBLOCKS_BASE_PATH = BasePath.Sandbox; // or assign directly to "https://sandbox-api.fireblocks.io/v1"
process.env.FIREBLOCKS_API_KEY = "my-api-key";
process.env.FIREBLOCKS_SECRET_KEY = readFileSync("./fireblocks_secret.key", "utf8");

const fireblocks = new Fireblocks();

let body: VaultsApiUpdateVaultAccountAssetBalanceRequest = {
  // string | The ID of the vault account to return
  vaultAccountId: vaultAccountId_example,
  // string | The ID of the asset
  assetId: assetId_example,
  // string | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours. (optional)
  idempotencyKey: idempotencyKey_example,
};

fireblocks.vaults.updateVaultAccountAssetBalance(body).then((res: FireblocksResponse<VaultAsset>) => {
  console.log('API called successfully. Returned data: ' + JSON.stringify(res, null, 2));
}).catch((error:any) => console.error(error));

Parameters

Name	Type	Description	Notes
vaultAccountId	[string]	The ID of the vault account to return	defaults to undefined
assetId	[string]	The ID of the asset	defaults to undefined
idempotencyKey	[string]	A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.	(optional) defaults to undefined

Return type

VaultAsset

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A VaultAsset object	* X-Request-ID -
0	Error Response	* X-Request-ID -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

VaultsApi.md

Latest commit

History

VaultsApi.md

File metadata and controls

VaultsApi

activateAssetForVaultAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

attachOrDetachTagsFromVaultAccounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createLegacyAddress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createMultipleAccounts

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createMultipleDepositAddresses

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createVaultAccount

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createVaultAccountAsset

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

createVaultAccountAssetAddress

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getAssetWallets

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCreateMultipleDepositAddressesJobStatus

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getCreateMultipleVaultAccountsJobStatus

Example

Parameters