VaultsApi.md

fireblocks.VaultsApi

All URIs are relative to https://api.fireblocks.io/v1

Method	HTTP request	Description
activate_asset_for_vault_account	POST /vault/accounts/{vaultAccountId}/{assetId}/activate	Activate a wallet in a vault account
attach_or_detach_tags_from_vault_accounts	POST /vault/accounts/attached_tags	Attach or detach tags from vault accounts
create_legacy_address	POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy	Convert a segwit address to legacy format
create_multiple_accounts	POST /vault/accounts/bulk	Bulk creation of new vault accounts
create_multiple_deposit_addresses	POST /vault/accounts/addresses/bulk	Bulk creation of new deposit addresses
create_vault_account	POST /vault/accounts	Create a new vault account
create_vault_account_asset	POST /vault/accounts/{vaultAccountId}/{assetId}	Create a new vault wallet
create_vault_account_asset_address	POST /vault/accounts/{vaultAccountId}/{assetId}/addresses	Create new asset deposit address
get_asset_wallets	GET /vault/asset_wallets	Get vault wallets (Paginated)
get_create_multiple_deposit_addresses_job_status	GET /vault/accounts/addresses/bulk/{jobId}	Get the job status of the bulk deposit address creation
get_create_multiple_vault_accounts_job_status	GET /vault/accounts/bulk/{jobId}	Get job status of bulk creation of new vault accounts
get_max_bip_index_used	GET /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_used	Get maximum BIP44 index used
get_max_spendable_amount	GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount	Get max spendable amount in a transaction
get_paged_vault_accounts	GET /vault/accounts_paged	Get vault accounts (Paginated)
get_public_key_info	GET /vault/public_key_info	Get the public key for a derivation path
get_public_key_info_for_address	GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info	Get an asset's public key
get_unspent_inputs	GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs	Get UTXO unspent inputs information
get_vault_account	GET /vault/accounts/{vaultAccountId}	Get a vault account by ID
get_vault_account_asset	GET /vault/accounts/{vaultAccountId}/{assetId}	Get the asset balance for a vault account
get_vault_account_asset_addresses_paginated	GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated	Get addresses (Paginated)
get_vault_assets	GET /vault/assets	Get asset balance for chosen assets
get_vault_balance_by_asset	GET /vault/assets/{assetId}	Get vault balance by an asset
hide_vault_account	POST /vault/accounts/{vaultAccountId}/hide	Hide a vault account in the console
set_customer_ref_id_for_address	POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id	Assign AML customer reference ID
set_vault_account_auto_fuel	POST /vault/accounts/{vaultAccountId}/set_auto_fuel	Set auto fueling to on or off
set_vault_account_customer_ref_id	POST /vault/accounts/{vaultAccountId}/set_customer_ref_id	Set an AML/KYT ID for a vault account
unhide_vault_account	POST /vault/accounts/{vaultAccountId}/unhide	Unhide a vault account in the console
update_vault_account	PUT /vault/accounts/{vaultAccountId}	Rename a vault account
update_vault_account_asset_address	PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}	Update address description
update_vault_account_asset_balance	POST /vault/accounts/{vaultAccountId}/{assetId}/balance	Refresh asset balance data

activate_asset_for_vault_account

CreateVaultAssetResponse activate_asset_for_vault_account(vault_account_id, asset_id, idempotency_key=idempotency_key, blockchain_wallet_type=blockchain_wallet_type)

Activate a wallet in a vault account

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

from fireblocks.models.create_vault_asset_response import CreateVaultAssetResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to return, or 'default' for the default vault account
    asset_id = 'asset_id_example' # str | The ID of the asset
    idempotency_key = 'idempotency_key_example' # str | 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)
    blockchain_wallet_type = 'blockchain_wallet_type_example' # str | Optional immutable blockchain wallet type to store per tenant+vault (optional)

    try:
        # Activate a wallet in a vault account
        api_response = fireblocks.vaults.activate_asset_for_vault_account(vault_account_id, asset_id, idempotency_key=idempotency_key, blockchain_wallet_type=blockchain_wallet_type).result()
        print("The response of VaultsApi->activate_asset_for_vault_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->activate_asset_for_vault_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to return, or 'default' for the default vault account
asset_id	str	The ID of the asset
idempotency_key	str	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]
blockchain_wallet_type	str	Optional immutable blockchain wallet type to store per tenant+vault	[optional]

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]

attach_or_detach_tags_from_vault_accounts

VaultAccountsTagAttachmentOperationsResponse attach_or_detach_tags_from_vault_accounts(vault_accounts_tag_attachment_operations_request, idempotency_key=idempotency_key)

Attach or detach tags from vault accounts

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

from fireblocks.models.vault_accounts_tag_attachment_operations_request import VaultAccountsTagAttachmentOperationsRequest
from fireblocks.models.vault_accounts_tag_attachment_operations_response import VaultAccountsTagAttachmentOperationsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_accounts_tag_attachment_operations_request = fireblocks.VaultAccountsTagAttachmentOperationsRequest() # VaultAccountsTagAttachmentOperationsRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Attach or detach tags from vault accounts
        api_response = fireblocks.vaults.attach_or_detach_tags_from_vault_accounts(vault_accounts_tag_attachment_operations_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->attach_or_detach_tags_from_vault_accounts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->attach_or_detach_tags_from_vault_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_accounts_tag_attachment_operations_request	VaultAccountsTagAttachmentOperationsRequest
idempotency_key	str	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]

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]

create_legacy_address

CreateAddressResponse create_legacy_address(vault_account_id, asset_id, address_id, idempotency_key=idempotency_key)

Convert a segwit address to legacy format

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

Example

from fireblocks.models.create_address_response import CreateAddressResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account
    asset_id = 'asset_id_example' # str | The ID of the asset
    address_id = 'address_id_example' # str | The segwit address to translate
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Convert a segwit address to legacy format
        api_response = fireblocks.vaults.create_legacy_address(vault_account_id, asset_id, address_id, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->create_legacy_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->create_legacy_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account
asset_id	str	The ID of the asset
address_id	str	The segwit address to translate
idempotency_key	str	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]

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]

create_multiple_accounts

JobCreated create_multiple_accounts(create_multiple_accounts_request, idempotency_key=idempotency_key)

Bulk creation of new vault accounts

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

from fireblocks.models.create_multiple_accounts_request import CreateMultipleAccountsRequest
from fireblocks.models.job_created import JobCreated
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    create_multiple_accounts_request = fireblocks.CreateMultipleAccountsRequest() # CreateMultipleAccountsRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Bulk creation of new vault accounts
        api_response = fireblocks.vaults.create_multiple_accounts(create_multiple_accounts_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->create_multiple_accounts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->create_multiple_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_multiple_accounts_request	CreateMultipleAccountsRequest
idempotency_key	str	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]

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]

create_multiple_deposit_addresses

JobCreated create_multiple_deposit_addresses(create_multiple_deposit_addresses_request, idempotency_key=idempotency_key)

Bulk creation of new deposit addresses

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

from fireblocks.models.create_multiple_deposit_addresses_request import CreateMultipleDepositAddressesRequest
from fireblocks.models.job_created import JobCreated
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    create_multiple_deposit_addresses_request = fireblocks.CreateMultipleDepositAddressesRequest() # CreateMultipleDepositAddressesRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Bulk creation of new deposit addresses
        api_response = fireblocks.vaults.create_multiple_deposit_addresses(create_multiple_deposit_addresses_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->create_multiple_deposit_addresses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->create_multiple_deposit_addresses: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_multiple_deposit_addresses_request	CreateMultipleDepositAddressesRequest
idempotency_key	str	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]

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]

create_vault_account

VaultAccount create_vault_account(create_vault_account_request, idempotency_key=idempotency_key)

Create a new vault account

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

from fireblocks.models.create_vault_account_request import CreateVaultAccountRequest
from fireblocks.models.vault_account import VaultAccount
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    create_vault_account_request = fireblocks.CreateVaultAccountRequest() # CreateVaultAccountRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Create a new vault account
        api_response = fireblocks.vaults.create_vault_account(create_vault_account_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->create_vault_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->create_vault_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_vault_account_request	CreateVaultAccountRequest
idempotency_key	str	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]

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]

create_vault_account_asset

CreateVaultAssetResponse create_vault_account_asset(vault_account_id, asset_id, idempotency_key=idempotency_key, blockchain_wallet_type=blockchain_wallet_type, create_assets_request=create_assets_request)

Create a new vault wallet

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

from fireblocks.models.create_assets_request import CreateAssetsRequest
from fireblocks.models.create_vault_asset_response import CreateVaultAssetResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to return, or 'default' for the default vault account
    asset_id = 'asset_id_example' # str | The ID of the asset
    idempotency_key = 'idempotency_key_example' # str | 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)
    blockchain_wallet_type = 'blockchain_wallet_type_example' # str | Optional immutable blockchain wallet type to store per tenant+vault (optional)
    create_assets_request = fireblocks.CreateAssetsRequest() # CreateAssetsRequest |  (optional)

    try:
        # Create a new vault wallet
        api_response = fireblocks.vaults.create_vault_account_asset(vault_account_id, asset_id, idempotency_key=idempotency_key, blockchain_wallet_type=blockchain_wallet_type, create_assets_request=create_assets_request).result()
        print("The response of VaultsApi->create_vault_account_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->create_vault_account_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to return, or 'default' for the default vault account
asset_id	str	The ID of the asset
idempotency_key	str	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]
blockchain_wallet_type	str	Optional immutable blockchain wallet type to store per tenant+vault	[optional]
create_assets_request	CreateAssetsRequest		[optional]

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]

create_vault_account_asset_address

CreateAddressResponse create_vault_account_asset_address(vault_account_id, asset_id, idempotency_key=idempotency_key, create_address_request=create_address_request)

Create new asset deposit address

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

from fireblocks.models.create_address_request import CreateAddressRequest
from fireblocks.models.create_address_response import CreateAddressResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to return
    asset_id = 'asset_id_example' # str | The ID of the asset
    idempotency_key = 'idempotency_key_example' # str | 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)
    create_address_request = fireblocks.CreateAddressRequest() # CreateAddressRequest |  (optional)

    try:
        # Create new asset deposit address
        api_response = fireblocks.vaults.create_vault_account_asset_address(vault_account_id, asset_id, idempotency_key=idempotency_key, create_address_request=create_address_request).result()
        print("The response of VaultsApi->create_vault_account_asset_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->create_vault_account_asset_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to return
asset_id	str	The ID of the asset
idempotency_key	str	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]
create_address_request	CreateAddressRequest		[optional]

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]

get_asset_wallets

PaginatedAssetWalletResponse get_asset_wallets(total_amount_larger_than=total_amount_larger_than, asset_id=asset_id, order_by=order_by, before=before, after=after, limit=limit)

Get vault wallets (Paginated)

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

from fireblocks.models.paginated_asset_wallet_response import PaginatedAssetWalletResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    total_amount_larger_than = 3.4 # float | When specified, only vault wallets with total balance greater than this amount are returned. (optional)
    asset_id = 'asset_id_example' # str | When specified, only vault wallets with the specified ID are returned. (optional)
    order_by = DESC # str |  (optional) (default to DESC)
    before = 'before_example' # str | Fetches the next paginated response before this element.  This element is a cursor and is returned at the response of the previous page.  (optional)
    after = 'after_example' # str | Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page. (optional)
    limit = 200 # float | The maximum number of vault wallets in a single response.   The default is 200 and the maximum is 1000.  (optional) (default to 200)

    try:
        # Get vault wallets (Paginated)
        api_response = fireblocks.vaults.get_asset_wallets(total_amount_larger_than=total_amount_larger_than, asset_id=asset_id, order_by=order_by, before=before, after=after, limit=limit).result()
        print("The response of VaultsApi->get_asset_wallets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_asset_wallets: %s\n" % e)

Parameters

Name	Type	Description	Notes
total_amount_larger_than	float	When specified, only vault wallets with total balance greater than this amount are returned.	[optional]
asset_id	str	When specified, only vault wallets with the specified ID are returned.	[optional]
order_by	str		[optional] [default to DESC]
before	str	Fetches the next paginated response before this element. This element is a cursor and is returned at the response of the previous page.	[optional]
after	str	Fetches the next paginated response after this element. This element is a cursor and is returned at the response of the previous page.	[optional]
limit	float	The maximum number of vault wallets in a single response. The default is 200 and the maximum is 1000.	[optional] [default 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]

get_create_multiple_deposit_addresses_job_status

CreateMultipleDepositAddressesJobStatus get_create_multiple_deposit_addresses_job_status(job_id)

Get the job status of the bulk deposit address creation

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

from fireblocks.models.create_multiple_deposit_addresses_job_status import CreateMultipleDepositAddressesJobStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    job_id = '019681b4-107d-7243-942d-4c3c30e36fae' # str | The ID of the job to create addresses

    try:
        # Get the job status of the bulk deposit address creation
        api_response = fireblocks.vaults.get_create_multiple_deposit_addresses_job_status(job_id).result()
        print("The response of VaultsApi->get_create_multiple_deposit_addresses_job_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_create_multiple_deposit_addresses_job_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str	The ID of the job to create addresses

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]

get_create_multiple_vault_accounts_job_status

CreateMultipleVaultAccountsJobStatus get_create_multiple_vault_accounts_job_status(job_id)

Get job status of bulk creation of new vault accounts

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

from fireblocks.models.create_multiple_vault_accounts_job_status import CreateMultipleVaultAccountsJobStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    job_id = '019681b4-107d-7243-942d-4c3c30e36fae' # str | The ID of the job to create addresses

    try:
        # Get job status of bulk creation of new vault accounts
        api_response = fireblocks.vaults.get_create_multiple_vault_accounts_job_status(job_id).result()
        print("The response of VaultsApi->get_create_multiple_vault_accounts_job_status:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_create_multiple_vault_accounts_job_status: %s\n" % e)

Parameters

Name	Type	Description	Notes
job_id	str	The ID of the job to create addresses

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]

get_max_bip_index_used

GetMaxBipIndexUsedResponse get_max_bip_index_used(vault_account_id, asset_id)

Get maximum BIP44 index used

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

Example

from fireblocks.models.get_max_bip_index_used_response import GetMaxBipIndexUsedResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account
    asset_id = 'asset_id_example' # str | The ID of the asset

    try:
        # Get maximum BIP44 index used
        api_response = fireblocks.vaults.get_max_bip_index_used(vault_account_id, asset_id).result()
        print("The response of VaultsApi->get_max_bip_index_used:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_max_bip_index_used: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account
asset_id	str	The ID of the asset

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]

get_max_spendable_amount

GetMaxSpendableAmountResponse get_max_spendable_amount(vault_account_id, asset_id, manual_signging=manual_signging)

Get max spendable amount in a transaction

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

from fireblocks.models.get_max_spendable_amount_response import GetMaxSpendableAmountResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account, or 'default' for the default vault account
    asset_id = 'asset_id_example' # str | The ID of the asset
    manual_signging = True # bool | 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)

    try:
        # Get max spendable amount in a transaction
        api_response = fireblocks.vaults.get_max_spendable_amount(vault_account_id, asset_id, manual_signging=manual_signging).result()
        print("The response of VaultsApi->get_max_spendable_amount:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_max_spendable_amount: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account, or 'default' for the default vault account
asset_id	str	The ID of the asset
manual_signging	bool	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]

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]

get_paged_vault_accounts

VaultAccountsPagedResponse get_paged_vault_accounts(name_prefix=name_prefix, name_suffix=name_suffix, min_amount_threshold=min_amount_threshold, asset_id=asset_id, order_by=order_by, before=before, after=after, limit=limit, tag_ids=tag_ids, include_tag_ids=include_tag_ids, exclude_tag_ids=exclude_tag_ids)

Get vault accounts (Paginated)

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

from fireblocks.models.vault_accounts_paged_response import VaultAccountsPagedResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    name_prefix = 'name_prefix_example' # str |  (optional)
    name_suffix = 'name_suffix_example' # str |  (optional)
    min_amount_threshold = 10 # float | 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)
    asset_id = 'asset_id_example' # str |  (optional)
    order_by = DESC # str |  (optional) (default to DESC)
    before = 'before_example' # str |  (optional)
    after = 'after_example' # str |  (optional)
    limit = 200 # float |  (optional) (default to 200)
    tag_ids = ['tag_ids_example'] # List[str] | DEPRECATED - use includeTagIds instead (optional)
    include_tag_ids = ['include_tag_ids_example'] # List[str] | List of tag IDs to include. Vault accounts with any of these tags will be included (optional)
    exclude_tag_ids = ['exclude_tag_ids_example'] # List[str] | List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out (optional)

    try:
        # Get vault accounts (Paginated)
        api_response = fireblocks.vaults.get_paged_vault_accounts(name_prefix=name_prefix, name_suffix=name_suffix, min_amount_threshold=min_amount_threshold, asset_id=asset_id, order_by=order_by, before=before, after=after, limit=limit, tag_ids=tag_ids, include_tag_ids=include_tag_ids, exclude_tag_ids=exclude_tag_ids).result()
        print("The response of VaultsApi->get_paged_vault_accounts:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_paged_vault_accounts: %s\n" % e)

Parameters

Name	Type	Description	Notes
name_prefix	str		[optional]
name_suffix	str		[optional]
min_amount_threshold	float	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]
asset_id	str		[optional]
order_by	str		[optional] [default to DESC]
before	str		[optional]
after	str		[optional]
limit	float		[optional] [default to 200]
tag_ids	List[str]	DEPRECATED - use includeTagIds instead	[optional]
include_tag_ids	List[str]	List of tag IDs to include. Vault accounts with any of these tags will be included	[optional]
exclude_tag_ids	List[str]	List of tag IDs to exclude. Vault accounts with any of these tags will be filtered out	[optional]

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]

get_public_key_info

PublicKeyInformation get_public_key_info(derivation_path, algorithm, compressed=compressed)

Get the public key for a derivation path

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

Example

from fireblocks.models.public_key_information import PublicKeyInformation
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    derivation_path = 'derivation_path_example' # str | 
    algorithm = 'algorithm_example' # str | 
    compressed = True # bool |  (optional)

    try:
        # Get the public key for a derivation path
        api_response = fireblocks.vaults.get_public_key_info(derivation_path, algorithm, compressed=compressed).result()
        print("The response of VaultsApi->get_public_key_info:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_public_key_info: %s\n" % e)

Parameters

Name	Type	Description	Notes
derivation_path	str
algorithm	str
compressed	bool		[optional]

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]

get_public_key_info_for_address

PublicKeyInformation get_public_key_info_for_address(vault_account_id, asset_id, change, address_index, compressed=compressed)

Get an asset's public key

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

Example

from fireblocks.models.public_key_information import PublicKeyInformation
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | 
    asset_id = 'asset_id_example' # str | 
    change = 3.4 # float | 
    address_index = 3.4 # float | 
    compressed = True # bool |  (optional)

    try:
        # Get an asset's public key
        api_response = fireblocks.vaults.get_public_key_info_for_address(vault_account_id, asset_id, change, address_index, compressed=compressed).result()
        print("The response of VaultsApi->get_public_key_info_for_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_public_key_info_for_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str
asset_id	str
change	float
address_index	float
compressed	bool		[optional]

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]

get_unspent_inputs

List[UnspentInputsResponse] get_unspent_inputs(vault_account_id, asset_id)

Get UTXO unspent inputs information

Returns unspent inputs information of an UTXO asset in a vault account.

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

from fireblocks.models.unspent_inputs_response import UnspentInputsResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account
    asset_id = 'asset_id_example' # str | The ID of the asset

    try:
        # Get UTXO unspent inputs information
        api_response = fireblocks.vaults.get_unspent_inputs(vault_account_id, asset_id).result()
        print("The response of VaultsApi->get_unspent_inputs:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_unspent_inputs: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account
asset_id	str	The ID of the asset

Return type

List[UnspentInputsResponse]

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]

get_vault_account

VaultAccount get_vault_account(vault_account_id)

Get a vault account by ID

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

Example

from fireblocks.models.vault_account import VaultAccount
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account

    try:
        # Get a vault account by ID
        api_response = fireblocks.vaults.get_vault_account(vault_account_id).result()
        print("The response of VaultsApi->get_vault_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_vault_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account

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]

get_vault_account_asset

VaultAsset get_vault_account_asset(vault_account_id, asset_id)

Get the asset balance for a vault account

Returns a specific vault wallet balance information for a specific asset.

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

from fireblocks.models.vault_asset import VaultAsset
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to return
    asset_id = 'asset_id_example' # str | The ID of the asset

    try:
        # Get the asset balance for a vault account
        api_response = fireblocks.vaults.get_vault_account_asset(vault_account_id, asset_id).result()
        print("The response of VaultsApi->get_vault_account_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_vault_account_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to return
asset_id	str	The ID of the asset

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]

get_vault_account_asset_addresses_paginated

PaginatedAddressResponse get_vault_account_asset_addresses_paginated(vault_account_id, asset_id, limit=limit, before=before, after=after)

Get addresses (Paginated)

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

from fireblocks.models.paginated_address_response import PaginatedAddressResponse
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to return
    asset_id = 'asset_id_example' # str | The ID of the asset
    limit = 3.4 # float |  (optional)
    before = 'before_example' # str |  (optional)
    after = 'after_example' # str |  (optional)

    try:
        # Get addresses (Paginated)
        api_response = fireblocks.vaults.get_vault_account_asset_addresses_paginated(vault_account_id, asset_id, limit=limit, before=before, after=after).result()
        print("The response of VaultsApi->get_vault_account_asset_addresses_paginated:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_vault_account_asset_addresses_paginated: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to return
asset_id	str	The ID of the asset
limit	float		[optional]
before	str		[optional]
after	str		[optional]

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]

get_vault_assets

List[VaultAsset] get_vault_assets(account_name_prefix=account_name_prefix, account_name_suffix=account_name_suffix)

Get asset balance for chosen assets

Gets the assets amount summary for all accounts or filtered accounts.

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

from fireblocks.models.vault_asset import VaultAsset
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    account_name_prefix = 'account_name_prefix_example' # str |  (optional)
    account_name_suffix = 'account_name_suffix_example' # str |  (optional)

    try:
        # Get asset balance for chosen assets
        api_response = fireblocks.vaults.get_vault_assets(account_name_prefix=account_name_prefix, account_name_suffix=account_name_suffix).result()
        print("The response of VaultsApi->get_vault_assets:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_vault_assets: %s\n" % e)

Parameters

Name	Type	Description	Notes
account_name_prefix	str		[optional]
account_name_suffix	str		[optional]

Return type

List[VaultAsset]

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]

get_vault_balance_by_asset

VaultAsset get_vault_balance_by_asset(asset_id)

Get vault balance by an asset

Get the total balance of an asset across all the vault accounts.

Endpoint Permission: Admin, Non-Signing Admin, Signer, Approver, Editor, Viewer.

Example

from fireblocks.models.vault_asset import VaultAsset
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    asset_id = 'asset_id_example' # str | 

    try:
        # Get vault balance by an asset
        api_response = fireblocks.vaults.get_vault_balance_by_asset(asset_id).result()
        print("The response of VaultsApi->get_vault_balance_by_asset:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->get_vault_balance_by_asset: %s\n" % e)

Parameters

Name	Type	Description	Notes
asset_id	str

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]

hide_vault_account

VaultActionStatus hide_vault_account(vault_account_id, idempotency_key=idempotency_key)

Hide a vault account in the console

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

from fireblocks.models.vault_action_status import VaultActionStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The vault account to hide
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Hide a vault account in the console
        api_response = fireblocks.vaults.hide_vault_account(vault_account_id, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->hide_vault_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->hide_vault_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The vault account to hide
idempotency_key	str	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]

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]

set_customer_ref_id_for_address

VaultActionStatus set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, set_customer_ref_id_for_address_request, idempotency_key=idempotency_key)

Assign AML customer reference ID

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

Example

from fireblocks.models.set_customer_ref_id_for_address_request import SetCustomerRefIdForAddressRequest
from fireblocks.models.vault_action_status import VaultActionStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account
    asset_id = 'asset_id_example' # str | The ID of the asset
    address_id = 'address_id_example' # str | The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
    set_customer_ref_id_for_address_request = fireblocks.SetCustomerRefIdForAddressRequest() # SetCustomerRefIdForAddressRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Assign AML customer reference ID
        api_response = fireblocks.vaults.set_customer_ref_id_for_address(vault_account_id, asset_id, address_id, set_customer_ref_id_for_address_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->set_customer_ref_id_for_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->set_customer_ref_id_for_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account
asset_id	str	The ID of the asset
address_id	str	The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
set_customer_ref_id_for_address_request	SetCustomerRefIdForAddressRequest
idempotency_key	str	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]

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]

set_vault_account_auto_fuel

VaultActionStatus set_vault_account_auto_fuel(vault_account_id, set_auto_fuel_request, idempotency_key=idempotency_key)

Set auto fueling to on or off

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

from fireblocks.models.set_auto_fuel_request import SetAutoFuelRequest
from fireblocks.models.vault_action_status import VaultActionStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The vault account ID
    set_auto_fuel_request = fireblocks.SetAutoFuelRequest() # SetAutoFuelRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Set auto fueling to on or off
        api_response = fireblocks.vaults.set_vault_account_auto_fuel(vault_account_id, set_auto_fuel_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->set_vault_account_auto_fuel:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->set_vault_account_auto_fuel: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The vault account ID
set_auto_fuel_request	SetAutoFuelRequest
idempotency_key	str	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]

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]

set_vault_account_customer_ref_id

VaultActionStatus set_vault_account_customer_ref_id(vault_account_id, set_customer_ref_id_request, idempotency_key=idempotency_key)

Set an AML/KYT ID for a vault account

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

from fireblocks.models.set_customer_ref_id_request import SetCustomerRefIdRequest
from fireblocks.models.vault_action_status import VaultActionStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The vault account ID
    set_customer_ref_id_request = fireblocks.SetCustomerRefIdRequest() # SetCustomerRefIdRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Set an AML/KYT ID for a vault account
        api_response = fireblocks.vaults.set_vault_account_customer_ref_id(vault_account_id, set_customer_ref_id_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->set_vault_account_customer_ref_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->set_vault_account_customer_ref_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The vault account ID
set_customer_ref_id_request	SetCustomerRefIdRequest
idempotency_key	str	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]

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]

unhide_vault_account

VaultActionStatus unhide_vault_account(vault_account_id, idempotency_key=idempotency_key)

Unhide a vault account in the console

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

Example

from fireblocks.models.vault_action_status import VaultActionStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The vault account to unhide
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Unhide a vault account in the console
        api_response = fireblocks.vaults.unhide_vault_account(vault_account_id, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->unhide_vault_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->unhide_vault_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The vault account to unhide
idempotency_key	str	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]

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]

update_vault_account

RenameVaultAccountResponse update_vault_account(vault_account_id, update_vault_account_request, idempotency_key=idempotency_key)

Rename a vault account

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

Example

from fireblocks.models.rename_vault_account_response import RenameVaultAccountResponse
from fireblocks.models.update_vault_account_request import UpdateVaultAccountRequest
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to edit
    update_vault_account_request = fireblocks.UpdateVaultAccountRequest() # UpdateVaultAccountRequest | 
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Rename a vault account
        api_response = fireblocks.vaults.update_vault_account(vault_account_id, update_vault_account_request, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->update_vault_account:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->update_vault_account: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to edit
update_vault_account_request	UpdateVaultAccountRequest
idempotency_key	str	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]

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]

update_vault_account_asset_address

VaultActionStatus update_vault_account_asset_address(vault_account_id, asset_id, address_id, idempotency_key=idempotency_key, update_vault_account_asset_address_request=update_vault_account_asset_address_request)

Update address description

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

Example

from fireblocks.models.update_vault_account_asset_address_request import UpdateVaultAccountAssetAddressRequest
from fireblocks.models.vault_action_status import VaultActionStatus
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account
    asset_id = 'asset_id_example' # str | The ID of the asset
    address_id = 'address_id_example' # str | The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
    idempotency_key = 'idempotency_key_example' # str | 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)
    update_vault_account_asset_address_request = fireblocks.UpdateVaultAccountAssetAddressRequest() # UpdateVaultAccountAssetAddressRequest |  (optional)

    try:
        # Update address description
        api_response = fireblocks.vaults.update_vault_account_asset_address(vault_account_id, asset_id, address_id, idempotency_key=idempotency_key, update_vault_account_asset_address_request=update_vault_account_asset_address_request).result()
        print("The response of VaultsApi->update_vault_account_asset_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->update_vault_account_asset_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account
asset_id	str	The ID of the asset
address_id	str	The address for which to add a description. For XRP, use <address>:<tag>, for all other assets, use only the address
idempotency_key	str	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]
update_vault_account_asset_address_request	UpdateVaultAccountAssetAddressRequest		[optional]

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]

update_vault_account_asset_balance

VaultAsset update_vault_account_asset_balance(vault_account_id, asset_id, idempotency_key=idempotency_key)

Refresh asset balance data

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

from fireblocks.models.vault_asset import VaultAsset
from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.exceptions import ApiException
from fireblocks.base_path import BasePath
from pprint import pprint

# load the secret key content from a file
with open('your_secret_key_file_path', 'r') as file:
    secret_key_value = file.read()

# build the configuration
configuration = ClientConfiguration(
        api_key="your_api_key",
        secret_key=secret_key_value,
        base_path=BasePath.Sandbox, # or set it directly to a string "https://sandbox-api.fireblocks.io/v1"
)


# Enter a context with an instance of the API client
with Fireblocks(configuration) as fireblocks:
    vault_account_id = 'vault_account_id_example' # str | The ID of the vault account to return
    asset_id = 'asset_id_example' # str | The ID of the asset
    idempotency_key = 'idempotency_key_example' # str | 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)

    try:
        # Refresh asset balance data
        api_response = fireblocks.vaults.update_vault_account_asset_balance(vault_account_id, asset_id, idempotency_key=idempotency_key).result()
        print("The response of VaultsApi->update_vault_account_asset_balance:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling VaultsApi->update_vault_account_asset_balance: %s\n" % e)

Parameters

Name	Type	Description	Notes
vault_account_id	str	The ID of the vault account to return
asset_id	str	The ID of the asset
idempotency_key	str	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]

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]