Skip to content

fireblocks/py-sdk

BranchesTags

Repository files navigation

Official Fireblocks Python SDK

PyPI version

The Fireblocks SDK allows developers to seamlessly integrate with the Fireblocks platform and perform a variety of operations, including managing vault accounts and executing transactions securely.

For detailed API documentation please refer to the Fireblocks API Reference.

Requirements.

Python 3.8+

Installation

To use the Fireblocks SDK, follow these steps:

pip install

If the python package is hosted on a repository, you can install directly using:

pip install fireblocks

Then import the package:

import fireblocks

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import fireblocks

Usage

Please follow the installation procedure first.

Initializing the SDK

You can initialize the Fireblocks SDK in two ways, either by setting environment variables or providing the parameters directly:

Using Environment Variables
You can initialize the SDK using environment variables from your .env file or by setting them programmatically:

use bash commands to set environment variables:

export FIREBLOCKS_BASE_PATH="https://sandbox-api.fireblocks.io/v1"
export FIREBLOCKS_API_KEY="my-api-key"
export FIREBLOCKS_SECRET_KEY="my-secret-key"
from fireblocks.client import Fireblocks

# Enter a context with an instance of the API client
with Fireblocks() as fireblocks:
    pass

Providing Local Variables

from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath


# 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:
    pass

Basic Api Examples

Creating a Vault Account
To create a new vault account, you can use the following function:

from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath
from fireblocks.models.create_vault_account_request import CreateVaultAccountRequest
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: CreateVaultAccountRequest = CreateVaultAccountRequest(
                                    name='My First Vault Account',
                                    hidden_on_ui=False,
                                    auto_fuel=False
                                    )
    try:
        # Create a new vault account
        future = fireblocks.vaults.create_vault_account(create_vault_account_request=create_vault_account_request)
        api_response = future.result()  # Wait for the response
        print("The response of VaultsApi->create_vault_account:\n")
        pprint(api_response)
        # to print just the data:                pprint(api_response.data)
        # to print just the data in json format: pprint(api_response.data.to_json())
    except Exception as e:
        print("Exception when calling VaultsApi->create_vault_account: %s\n" % e)

Retrieving Vault Accounts
To get a list of vault accounts, you can use the following function:

from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
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:
    try:
        # List vault accounts (Paginated)
        future = fireblocks.vaults.get_paged_vault_accounts()
        api_response = future.result()  # Wait for the response
        print("The response of VaultsApi->get_paged_vault_accounts:\n")
        pprint(api_response)
        # to print just the data:                pprint(api_response.data)
        # to print just the data in json format: pprint(api_response.data.to_json())
    except Exception as e:
        print("Exception when calling VaultsApi->get_paged_vault_accounts: %s\n" % e)

Creating a Transaction
To make a transaction between vault accounts, you can use the following function:

from fireblocks.client import Fireblocks
from fireblocks.client_configuration import ClientConfiguration
from fireblocks.base_path import BasePath
from fireblocks.models.transaction_request import TransactionRequest
from fireblocks.models.destination_transfer_peer_path import DestinationTransferPeerPath
from fireblocks.models.source_transfer_peer_path import SourceTransferPeerPath
from fireblocks.models.transfer_peer_path_type import TransferPeerPathType
from fireblocks.models.transaction_request_amount import TransactionRequestAmount
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:
    transaction_request: TransactionRequest = TransactionRequest(
        asset_id="ETH",
        amount=TransactionRequestAmount("0.1"),
        source=SourceTransferPeerPath(
            type=TransferPeerPathType.VAULT_ACCOUNT,
            id="0"
        ),
        destination=DestinationTransferPeerPath(
            type=TransferPeerPathType.VAULT_ACCOUNT,
            id="1"
        ),
        note="Your first transaction!"
    )
    # or you can use JSON approach:
    #
    # transaction_request: TransactionRequest = TransactionRequest.from_json(
    #     '{"note": "Your first transaction!", '
    #     '"assetId": "ETH", '
    #     '"source": {"type": "VAULT_ACCOUNT", "id": "0"}, '
    #     '"destination": {"type": "VAULT_ACCOUNT", "id": "1"}, '
    #     '"amount": "0.1"}'
    # )
    try:
        # Create a new transaction
        future = fireblocks.transactions.create_transaction(transaction_request=transaction_request)
        api_response = future.result()  # Wait for the response
        print("The response of TransactionsApi->create_transaction:\n")
        pprint(api_response)
        # to print just the data:                pprint(api_response.data)
        # to print just the data in json format: pprint(api_response.data.to_json())
    except Exception as e:
        print("Exception when calling TransactionsApi->create_transaction: %s\n" % e)

Documentation for API Endpoints

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

Class Method HTTP request Description
ApiUserApi create_api_user POST /management/api_users Create API Key
ApiUserApi get_api_users GET /management/api_users Get API Keys
AuditLogsApi get_audit_logs GET /management/audit_logs Get audit logs
BlockchainsAssetsApi get_asset GET /assets/{id} Get an asset
BlockchainsAssetsApi get_blockchain GET /blockchains/{id} Get a Blockchain by ID
BlockchainsAssetsApi get_supported_assets GET /supported_assets List assets (Legacy)
BlockchainsAssetsApi list_assets GET /assets List assets
BlockchainsAssetsApi list_blockchains GET /blockchains List blockchains
BlockchainsAssetsApi register_new_asset POST /assets Register an asset
BlockchainsAssetsApi set_asset_price POST /assets/prices/{id} Set asset price
BlockchainsAssetsApi update_asset_user_metadata PATCH /assets/{id} Update the user’s metadata for an asset
ComplianceApi get_aml_post_screening_policy GET /screening/aml/post_screening_policy AML - View Post-Screening Policy
ComplianceApi get_aml_screening_policy GET /screening/aml/screening_policy AML - View Screening Policy
ComplianceApi get_post_screening_policy GET /screening/travel_rule/post_screening_policy Travel Rule - View Post-Screening Policy
ComplianceApi get_screening_full_details GET /screening/transaction/{txId} Provides all the compliance details for the given screened transaction.
ComplianceApi get_screening_policy GET /screening/travel_rule/screening_policy Travel Rule - View Screening Policy
ComplianceApi retry_rejected_transaction_bypass_screening_checks POST /screening/transaction/{txId}/bypass_screening_policy Calling the "Bypass Screening Policy" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
ComplianceApi set_aml_verdict POST /screening/aml/verdict/manual Set AML Verdict for Manual Screening Verdict.
ComplianceApi update_aml_screening_configuration PUT /screening/aml/policy_configuration Update AML Configuration
ComplianceApi update_screening_configuration PUT /screening/configurations Tenant - Screening Configuration
ComplianceApi update_travel_rule_config PUT /screening/travel_rule/policy_configuration Update Travel Rule Configuration
ComplianceScreeningConfigurationApi get_aml_screening_configuration GET /screening/aml/policy_configuration Get AML Screening Policy Configuration
ComplianceScreeningConfigurationApi get_screening_configuration GET /screening/travel_rule/policy_configuration Get Travel Rule Screening Policy Configuration
ConnectedAccountsBetaApi disconnect_connected_account DELETE /connected_accounts/{accountId} Disconnect connected account
ConnectedAccountsBetaApi get_connected_account GET /connected_accounts/{accountId} Get connected account
ConnectedAccountsBetaApi get_connected_account_balances GET /connected_accounts/{accountId}/balances Get balances for an account
ConnectedAccountsBetaApi get_connected_account_rates GET /connected_accounts/{accountId}/rates Get exchange rates for an account
ConnectedAccountsBetaApi get_connected_account_trading_pairs GET /connected_accounts/{accountId}/manifest/capabilities/trading/pairs Get supported trading pairs for an account
ConnectedAccountsBetaApi get_connected_accounts GET /connected_accounts Get connected accounts
ConnectedAccountsBetaApi rename_connected_account POST /connected_accounts/{accountId}/rename Rename Connected Account
ConsoleUserApi create_console_user POST /management/users Create console user
ConsoleUserApi get_console_users GET /management/users Get console users
ContractInteractionsApi decode_contract_data POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decode Decode a function call data, error, or event log
ContractInteractionsApi get_contract_address GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash} Get contract address by transaction hash
ContractInteractionsApi get_deployed_contract_abi GET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions Return deployed contract's ABI
ContractInteractionsApi get_transaction_receipt GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt Get transaction receipt
ContractInteractionsApi read_call_function POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read Call a read function on a deployed contract
ContractInteractionsApi write_call_function POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/write Call a write function on a deployed contract
ContractTemplatesApi delete_contract_template_by_id DELETE /tokenization/templates/{contractTemplateId} Delete a contract template by id
ContractTemplatesApi deploy_contract POST /tokenization/templates/{contractTemplateId}/deploy Deploy contract
ContractTemplatesApi get_constructor_by_contract_template_id GET /tokenization/templates/{contractTemplateId}/constructor Return contract template's constructor
ContractTemplatesApi get_contract_template_by_id GET /tokenization/templates/{contractTemplateId} Return contract template by id
ContractTemplatesApi get_contract_templates GET /tokenization/templates List all contract templates
ContractTemplatesApi get_function_abi_by_contract_template_id GET /tokenization/templates/{contractTemplateId}/function Return contract template's function
ContractTemplatesApi get_supported_blockchains_by_template_id GET /tokenization/templates/{contractTemplateId}/supported_blockchains Get supported blockchains for the template
ContractTemplatesApi upload_contract_template POST /tokenization/templates Upload contract template
ContractsApi add_contract_asset POST /contracts/{contractId}/{assetId} Add an asset to a whitelisted contract
ContractsApi create_contract POST /contracts Add a contract
ContractsApi delete_contract DELETE /contracts/{contractId} Delete a contract
ContractsApi delete_contract_asset DELETE /contracts/{contractId}/{assetId} Delete an asset from a whitelisted contract
ContractsApi get_contract GET /contracts/{contractId} Find a Specific Whitelisted Contract
ContractsApi get_contract_asset GET /contracts/{contractId}/{assetId} Find a whitelisted contract's asset
ContractsApi get_contracts GET /contracts List Whitelisted Contracts
CosignersBetaApi add_cosigner POST /cosigners Add cosigner
CosignersBetaApi get_api_key GET /cosigners/{cosignerId}/api_keys/{apiKeyId} Get API key
CosignersBetaApi get_api_keys GET /cosigners/{cosignerId}/api_keys Get all API keys
CosignersBetaApi get_cosigner GET /cosigners/{cosignerId} Get cosigner
CosignersBetaApi get_cosigners GET /cosigners Get all cosigners
CosignersBetaApi get_request_status GET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} Get request status
CosignersBetaApi pair_api_key PUT /cosigners/{cosignerId}/api_keys/{apiKeyId} Pair API key
CosignersBetaApi rename_cosigner PATCH /cosigners/{cosignerId} Rename cosigner
CosignersBetaApi unpair_api_key DELETE /cosigners/{cosignerId}/api_keys/{apiKeyId} Unpair API key
CosignersBetaApi update_callback_handler PATCH /cosigners/{cosignerId}/api_keys/{apiKeyId} Update API key callback handler
DeployedContractsApi add_contract_abi POST /tokenization/contracts/abi Save contract ABI
DeployedContractsApi fetch_contract_abi POST /tokenization/contracts/fetch_abi Fetch the contract ABI
DeployedContractsApi get_deployed_contract_by_address GET /tokenization/contracts/{assetId}/{contractAddress} Return deployed contract data
DeployedContractsApi get_deployed_contract_by_id GET /tokenization/contracts/{id} Return deployed contract data by id
DeployedContractsApi get_deployed_contracts GET /tokenization/contracts List deployed contracts data
EmbeddedWalletsApi add_embedded_wallet_asset POST /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} Add asset to account
EmbeddedWalletsApi assign_embedded_wallet POST /ncw/wallets/{walletId}/assign Assign a wallet
EmbeddedWalletsApi create_embedded_wallet POST /ncw/wallets Create a new wallet
EmbeddedWalletsApi create_embedded_wallet_account POST /ncw/wallets/{walletId}/accounts Create a new account
EmbeddedWalletsApi get_embedded_wallet GET /ncw/wallets/{walletId} Get a wallet
EmbeddedWalletsApi get_embedded_wallet_account GET /ncw/wallets/{walletId}/accounts/{accountId} Get a account
EmbeddedWalletsApi get_embedded_wallet_addresses GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses Retrieve asset addresses
EmbeddedWalletsApi get_embedded_wallet_asset GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} Retrieve asset
EmbeddedWalletsApi get_embedded_wallet_asset_balance GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance Retrieve asset balance
EmbeddedWalletsApi get_embedded_wallet_assets GET /ncw/wallets/{walletId}/accounts/{accountId}/assets Retrieve assets
EmbeddedWalletsApi get_embedded_wallet_device GET /ncw/wallets/{walletId}/devices/{deviceId} Get Embedded Wallet Device
EmbeddedWalletsApi get_embedded_wallet_device_setup_state GET /ncw/wallets/{walletId}/devices/{deviceId}/setup_status Get device key setup state
EmbeddedWalletsApi get_embedded_wallet_devices_paginated GET /ncw/wallets/{walletId}/devices_paginated Get registered devices - paginated
EmbeddedWalletsApi get_embedded_wallet_latest_backup GET /ncw/wallets/{walletId}/backup/latest Get wallet Latest Backup details
EmbeddedWalletsApi get_embedded_wallet_public_key_info_for_address GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_info Get the public key of an asset
EmbeddedWalletsApi get_embedded_wallet_setup_status GET /ncw/wallets/{walletId}/setup_status Get wallet key setup state
EmbeddedWalletsApi get_embedded_wallet_supported_assets GET /ncw/wallets/supported_assets Retrieve supported assets
EmbeddedWalletsApi get_embedded_wallets GET /ncw/wallets List wallets
EmbeddedWalletsApi get_public_key_info_ncw GET /ncw/wallets/{walletId}/public_key_info Get the public key for a derivation path
EmbeddedWalletsApi refresh_embedded_wallet_asset_balance PUT /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance Refresh asset balance
EmbeddedWalletsApi update_embedded_wallet_device_status PATCH /ncw/wallets/{walletId}/devices/{deviceId}/status Update device status
EmbeddedWalletsApi update_embedded_wallet_status PATCH /ncw/wallets/{walletId}/status Update wallet status
ExchangeAccountsApi add_exchange_account POST /exchange_accounts Add an exchange account
ExchangeAccountsApi convert_assets POST /exchange_accounts/{exchangeAccountId}/convert Convert exchange account funds
ExchangeAccountsApi get_exchange_account GET /exchange_accounts/{exchangeAccountId} Get a specific exchange account
ExchangeAccountsApi get_exchange_account_asset GET /exchange_accounts/{exchangeAccountId}/{assetId} Get an asset for an exchange account
ExchangeAccountsApi get_exchange_accounts_credentials_public_key GET /exchange_accounts/credentials_public_key Get public key to encrypt exchange credentials
ExchangeAccountsApi get_paged_exchange_accounts GET /exchange_accounts/paged List connected exchange accounts
ExchangeAccountsApi internal_transfer POST /exchange_accounts/{exchangeAccountId}/internal_transfer Internal transfer for exchange accounts
ExternalWalletsApi add_asset_to_external_wallet POST /external_wallets/{walletId}/{assetId} Add an asset to an external wallet.
ExternalWalletsApi create_external_wallet POST /external_wallets Create an external wallet
ExternalWalletsApi delete_external_wallet DELETE /external_wallets/{walletId} Delete an external wallet
ExternalWalletsApi get_external_wallet GET /external_wallets/{walletId} Find an external wallet
ExternalWalletsApi get_external_wallet_asset GET /external_wallets/{walletId}/{assetId} Get an asset from an external wallet
ExternalWalletsApi get_external_wallets GET /external_wallets List external wallets
ExternalWalletsApi remove_asset_from_external_wallet DELETE /external_wallets/{walletId}/{assetId} Delete an asset from an external wallet
ExternalWalletsApi set_external_wallet_customer_ref_id POST /external_wallets/{walletId}/set_customer_ref_id Set an AML customer reference ID for an external wallet
FiatAccountsApi deposit_funds_from_linked_dda POST /fiat_accounts/{accountId}/deposit_from_linked_dda Deposit funds from DDA
FiatAccountsApi get_fiat_account GET /fiat_accounts/{accountId} Find a specific fiat account
FiatAccountsApi get_fiat_accounts GET /fiat_accounts List fiat accounts
FiatAccountsApi redeem_funds_to_linked_dda POST /fiat_accounts/{accountId}/redeem_to_linked_dda Redeem funds to DDA
GasStationsApi get_gas_station_by_asset_id GET /gas_station/{assetId} Get gas station settings by asset
GasStationsApi get_gas_station_info GET /gas_station Get gas station settings
GasStationsApi update_gas_station_configuration PUT /gas_station/configuration Edit gas station settings
GasStationsApi update_gas_station_configuration_by_asset_id PUT /gas_station/configuration/{assetId} Edit gas station settings for an asset
InternalWalletsApi create_internal_wallet POST /internal_wallets Create an internal wallet
InternalWalletsApi create_internal_wallet_asset POST /internal_wallets/{walletId}/{assetId} Add an asset to an internal wallet
InternalWalletsApi delete_internal_wallet DELETE /internal_wallets/{walletId} Delete an internal wallet
InternalWalletsApi delete_internal_wallet_asset DELETE /internal_wallets/{walletId}/{assetId} Delete a whitelisted address
InternalWalletsApi get_internal_wallet GET /internal_wallets/{walletId} Get assets for internal wallet
InternalWalletsApi get_internal_wallet_asset GET /internal_wallets/{walletId}/{assetId} Get an asset from an internal wallet
InternalWalletsApi get_internal_wallet_assets_paginated GET /internal_wallets/{walletId}/assets List assets in an internal wallet (Paginated)
InternalWalletsApi get_internal_wallets GET /internal_wallets List internal wallets
InternalWalletsApi set_customer_ref_id_for_internal_wallet POST /internal_wallets/{walletId}/set_customer_ref_id Set an AML/KYT customer reference ID for internal wallet
KeyLinkBetaApi create_signing_key POST /key_link/signing_keys Add a new signing key
KeyLinkBetaApi create_validation_key POST /key_link/validation_keys Add a new validation key
KeyLinkBetaApi disable_validation_key PATCH /key_link/validation_keys/{keyId} Disables a validation key
KeyLinkBetaApi get_signing_key GET /key_link/signing_keys/{keyId} Get a signing key by `keyId`
KeyLinkBetaApi get_signing_keys_list GET /key_link/signing_keys Get list of signing keys
KeyLinkBetaApi get_validation_key GET /key_link/validation_keys/{keyId} Get a validation key by `keyId`
KeyLinkBetaApi get_validation_keys_list GET /key_link/validation_keys Get list of registered validation keys
KeyLinkBetaApi set_agent_id PATCH /key_link/signing_keys/{keyId}/agent_user_id Set agent user id
KeyLinkBetaApi update_signing_key PATCH /key_link/signing_keys/{keyId} Modify the signing keyId
KeysBetaApi get_mpc_keys_list GET /keys/mpc/list Get list of mpc keys
KeysBetaApi get_mpc_keys_list_by_user GET /keys/mpc/list/{userId} Get list of mpc keys by `userId`
NFTsApi get_nft GET /nfts/tokens/{id} List token data by ID
NFTsApi get_nfts GET /nfts/tokens List tokens by IDs
NFTsApi get_ownership_tokens GET /nfts/ownership/tokens List all owned tokens (paginated)
NFTsApi list_owned_collections GET /nfts/ownership/collections List owned collections (paginated)
NFTsApi list_owned_tokens GET /nfts/ownership/assets List all distinct owned tokens (paginated)
NFTsApi refresh_nft_metadata PUT /nfts/tokens/{id} Refresh token metadata
NFTsApi update_ownership_tokens PUT /nfts/ownership/tokens Refresh vault account tokens
NFTsApi update_token_ownership_status PUT /nfts/ownership/tokens/{id}/status Update token ownership status
NFTsApi update_tokens_ownership_spam PUT /nfts/ownership/tokens/spam Update tokens ownership spam property
NFTsApi update_tokens_ownership_status PUT /nfts/ownership/tokens/status Update tokens ownership status
NetworkConnectionsApi check_third_party_routing GET /network_connections/{connectionId}/is_third_party_routing/{assetType} Retrieve third-party network routing validation
NetworkConnectionsApi create_network_connection POST /network_connections Create a new network connection
NetworkConnectionsApi create_network_id POST /network_ids Creates a new Network ID
NetworkConnectionsApi delete_network_connection DELETE /network_connections/{connectionId} Deletes a network connection by ID
NetworkConnectionsApi delete_network_id DELETE /network_ids/{networkId} Deletes specific network ID.
NetworkConnectionsApi get_network GET /network_connections/{connectionId} Get a network connection
NetworkConnectionsApi get_network_connections GET /network_connections List network connections
NetworkConnectionsApi get_network_id GET /network_ids/{networkId} Returns specific network ID.
NetworkConnectionsApi get_network_ids GET /network_ids Get all network IDs
NetworkConnectionsApi get_routing_policy_asset_groups GET /network_ids/routing_policy_asset_groups Returns all enabled routing policy asset groups
NetworkConnectionsApi search_network_ids GET /network_ids/search Get both local IDs and discoverable remote IDs
NetworkConnectionsApi set_network_id_discoverability PATCH /network_ids/{networkId}/set_discoverability Update network ID's discoverability.
NetworkConnectionsApi set_network_id_name PATCH /network_ids/{networkId}/set_name Update network ID's name.
NetworkConnectionsApi set_network_id_routing_policy PATCH /network_ids/{networkId}/set_routing_policy Update network id routing policy.
NetworkConnectionsApi set_routing_policy PATCH /network_connections/{connectionId}/set_routing_policy Update network connection routing policy.
OTABetaApi get_ota_status GET /management/ota Returns current OTA status
OTABetaApi set_ota_status PUT /management/ota Enable or disable transactions to OTA
OffExchangesApi add_off_exchange POST /off_exchange/add Add Collateral
OffExchangesApi get_off_exchange_collateral_accounts GET /off_exchange/collateral_accounts/{mainExchangeAccountId} Find a specific collateral exchange account
OffExchangesApi get_off_exchange_settlement_transactions GET /off_exchange/settlements/transactions Get Settlements Transactions
OffExchangesApi remove_off_exchange POST /off_exchange/remove Remove Collateral
OffExchangesApi settle_off_exchange_trades POST /off_exchange/settlements/trader Create Settlement for a Trader
OnchainDataApi get_access_registry_current_state GET /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/list Get the current state of addresses in an access registry
OnchainDataApi get_access_registry_summary GET /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/summary Summary of access registry state
OnchainDataApi get_active_roles_for_contract GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/roles List of active roles for a given contract address and base asset ID
OnchainDataApi get_contract_balance_history GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/account_address/{accountAddress}/balance_history Get historical balance data for a specific account in a contract
OnchainDataApi get_contract_balances_summary GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/summary Get summary for the token contract
OnchainDataApi get_contract_total_supply GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/total_supply Get historical total supply data for a contract
OnchainDataApi get_latest_balances_for_contract GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/balances Get latest balances for all addresses holding tokens from a contract
OnchainDataApi get_onchain_transactions GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/transactions Fetch onchain transactions for a contract
PaymentsPayoutApi create_payout POST /payments/payout Create a payout instruction set
PaymentsPayoutApi execute_payout_action POST /payments/payout/{payoutId}/actions/execute Execute a payout instruction set
PaymentsPayoutApi get_payout GET /payments/payout/{payoutId} Get the status of a payout instruction set
PolicyEditorV2BetaApi get_active_policy GET /policy/active_policy Get the active policy and its validation by policy type
PolicyEditorV2BetaApi get_draft GET /policy/draft Get the active draft by policy type
PolicyEditorV2BetaApi publish_draft POST /policy/draft Send publish request for a certain draft id
PolicyEditorV2BetaApi update_draft PUT /policy/draft Update the draft with a new set of rules by policy types
PolicyEditorBetaApi get_active_policy_legacy GET /tap/active_policy Get the active policy and its validation
PolicyEditorBetaApi get_draft_legacy GET /tap/draft Get the active draft
PolicyEditorBetaApi publish_draft_legacy POST /tap/draft Send publish request for a certain draft id
PolicyEditorBetaApi publish_policy_rules POST /tap/publish Send publish request for a set of policy rules
PolicyEditorBetaApi update_draft_legacy PUT /tap/draft Update the draft with a new set of rules
ResetDeviceApi reset_device POST /management/users/{id}/reset_device Resets device
SmartTransferApi approve_dv_p_ticket_term PUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approve Set funding source and approval
SmartTransferApi cancel_ticket PUT /smart-transfers/{ticketId}/cancel Cancel Ticket
SmartTransferApi create_ticket POST /smart-transfers Create Ticket
SmartTransferApi create_ticket_term POST /smart-transfers/{ticketId}/terms Create leg (term)
SmartTransferApi find_ticket_by_id GET /smart-transfers/{ticketId} Search Ticket by ID
SmartTransferApi find_ticket_term_by_id GET /smart-transfers/{ticketId}/terms/{termId} Get Smart Transfer ticket term
SmartTransferApi fulfill_ticket PUT /smart-transfers/{ticketId}/fulfill Fund ticket manually
SmartTransferApi fund_dvp_ticket PUT /smart_transfers/{ticketId}/dvp/fund Fund dvp ticket
SmartTransferApi fund_ticket_term PUT /smart-transfers/{ticketId}/terms/{termId}/fund Define funding source
SmartTransferApi get_smart_transfer_statistic GET /smart_transfers/statistic Get smart transfers statistic
SmartTransferApi get_smart_transfer_user_groups GET /smart-transfers/settings/user-groups Get user group
SmartTransferApi manually_fund_ticket_term PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund Manually add term transaction
SmartTransferApi remove_ticket_term DELETE /smart-transfers/{ticketId}/terms/{termId} Delete ticket leg (term)
SmartTransferApi search_tickets GET /smart-transfers Find Ticket
SmartTransferApi set_external_ref_id PUT /smart-transfers/{ticketId}/external-id Add external ref. ID
SmartTransferApi set_ticket_expiration PUT /smart-transfers/{ticketId}/expires-in Set expiration
SmartTransferApi set_user_groups POST /smart-transfers/settings/user-groups Set user group
SmartTransferApi submit_ticket PUT /smart-transfers/{ticketId}/submit Submit ticket
SmartTransferApi update_ticket_term PUT /smart-transfers/{ticketId}/terms/{termId} Update ticket leg (term)
StakingApi approve_terms_of_service_by_provider_id POST /staking/providers/{providerId}/approveTermsOfService Approve provider terms of service
StakingApi claim_rewards POST /staking/chains/{chainDescriptor}/claim_rewards Claim accrued rewards
StakingApi get_all_delegations GET /staking/positions List staking positions
StakingApi get_chain_info GET /staking/chains/{chainDescriptor}/chainInfo Get chain-level staking parameters
StakingApi get_chains GET /staking/chains List supported staking chains
StakingApi get_delegation_by_id GET /staking/positions/{id} Get position details
StakingApi get_providers GET /staking/providers List staking providers
StakingApi get_summary GET /staking/positions/summary Get positions summary
StakingApi get_summary_by_vault GET /staking/positions/summary/vaults Get positions summary by vault
StakingApi merge_stake_accounts POST /staking/chains/{chainDescriptor}/merge Merge staking positions
StakingApi split POST /staking/chains/{chainDescriptor}/split Split a staking position
StakingApi stake POST /staking/chains/{chainDescriptor}/stake Initiate or add to existing stake
StakingApi unstake POST /staking/chains/{chainDescriptor}/unstake Initiate unstake
StakingApi withdraw POST /staking/chains/{chainDescriptor}/withdraw Withdraw staked funds
TRLinkApi assess_tr_link_travel_rule_requirement POST /screening/trlink/customers/integration/{customerIntegrationId}/trm/assess Assess Travel Rule requirement
TRLinkApi cancel_tr_link_trm POST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancel Cancel Travel Rule Message
TRLinkApi connect_tr_link_integration PUT /screening/trlink/customers/integration/{customerIntegrationId} Connect customer integration
TRLinkApi create_tr_link_customer POST /screening/trlink/customers Create customer
TRLinkApi create_tr_link_integration POST /screening/trlink/customers/integration Create customer integration
TRLinkApi create_tr_link_trm POST /screening/trlink/customers/integration/{customerIntegrationId}/trm Create Travel Rule Message
TRLinkApi delete_tr_link_customer DELETE /screening/trlink/customers/{customerId} Delete customer
TRLinkApi disconnect_tr_link_integration DELETE /screening/trlink/customers/integration/{customerIntegrationId} Disconnect customer integration
TRLinkApi get_tr_link_customer_by_id GET /screening/trlink/customers/{customerId} Get customer by ID
TRLinkApi get_tr_link_customer_integration_by_id GET /screening/trlink/customers/{customerId}/integrations/{customerIntegrationId} Get customer integration by ID
TRLinkApi get_tr_link_customer_integrations GET /screening/trlink/customers/{customerId}/integrations Get customer integrations
TRLinkApi get_tr_link_customers GET /screening/trlink/customers Get all customers
TRLinkApi get_tr_link_integration_public_key GET /screening/trlink/customers/integration/{customerIntegrationId}/public_key Get public key for PII encryption
TRLinkApi get_tr_link_partners GET /screening/trlink/partners List available TRLink partners
TRLinkApi get_tr_link_policy GET /screening/trlink/policy Get TRLink policy
TRLinkApi get_tr_link_supported_asset GET /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} Get supported asset by ID
TRLinkApi get_tr_link_trm_by_id GET /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId} Get TRM by ID
TRLinkApi get_tr_link_vasp_by_id GET /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId} Get VASP by ID
TRLinkApi list_tr_link_supported_assets GET /screening/trlink/customers/integration/{customerIntegrationId}/assets List supported assets
TRLinkApi list_tr_link_vasps GET /screening/trlink/customers/integration/{customerIntegrationId}/vasps List VASPs
TRLinkApi redirect_tr_link_trm POST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect Redirect Travel Rule Message
TRLinkApi set_tr_link_destination_travel_rule_message_id POST /screening/trlink/transaction/{txId}/destination/travel_rule_message_id Set destination travel rule message ID
TRLinkApi set_tr_link_transaction_travel_rule_message_id POST /screening/trlink/transaction/{txId}/travel_rule_message_id Set transaction travel rule message ID
TRLinkApi test_tr_link_integration_connection POST /screening/trlink/customers/integration/{customerIntegrationId}/test_connection Test connection
TRLinkApi update_tr_link_customer PUT /screening/trlink/customers/{customerId} Update customer
TagsApi cancel_approval_request POST /tags/approval_requests/{id}/cancel Cancel an approval request by id
TagsApi create_tag POST /tags Create a new tag
TagsApi delete_tag DELETE /tags/{tagId} Delete a tag
TagsApi get_approval_request GET /tags/approval_requests/{id} Get an approval request by id
TagsApi get_tag GET /tags/{tagId} Get a tag
TagsApi get_tags GET /tags Get list of tags
TagsApi update_tag PATCH /tags/{tagId} Update a tag
TokenizationApi burn_collection_token POST /tokenization/collections/{id}/tokens/burn Burn tokens
TokenizationApi create_new_collection POST /tokenization/collections Create a new collection
TokenizationApi deactivate_and_unlink_adapters DELETE /tokenization/multichain/bridge/layerzero Remove LayerZero adapters
TokenizationApi deploy_and_link_adapters POST /tokenization/multichain/bridge/layerzero Deploy LayerZero adapters
TokenizationApi fetch_collection_token_details GET /tokenization/collections/{id}/tokens/{tokenId} Get collection token details
TokenizationApi get_collection_by_id GET /tokenization/collections/{id} Get a collection by id
TokenizationApi get_deployable_address POST /tokenization/multichain/deterministic_address Get deterministic address for contract deployment
TokenizationApi get_layer_zero_dvn_config GET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/dvns Get LayerZero DVN configuration
TokenizationApi get_layer_zero_peers GET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/peers Get LayerZero peers
TokenizationApi get_linked_collections GET /tokenization/collections Get collections
TokenizationApi get_linked_token GET /tokenization/tokens/{id} Return a linked token
TokenizationApi get_linked_tokens GET /tokenization/tokens List all linked tokens
TokenizationApi get_linked_tokens_count GET /tokenization/tokens/count Get the total count of linked tokens
TokenizationApi issue_new_token POST /tokenization/tokens Issue a new token
TokenizationApi issue_token_multi_chain POST /tokenization/multichain/tokens Issue a token on one or more blockchains
TokenizationApi link POST /tokenization/tokens/link Link a contract
TokenizationApi mint_collection_token POST /tokenization/collections/{id}/tokens/mint Mint tokens
TokenizationApi re_issue_token_multi_chain POST /tokenization/multichain/reissue/token/{tokenLinkId} Reissue a multichain token
TokenizationApi remove_layer_zero_peers DELETE /tokenization/multichain/bridge/layerzero/config/peers Remove LayerZero peers
TokenizationApi set_layer_zero_dvn_config POST /tokenization/multichain/bridge/layerzero/config/dvns Set LayerZero DVN configuration
TokenizationApi set_layer_zero_peers POST /tokenization/multichain/bridge/layerzero/config/peers Set LayerZero peers
TokenizationApi unlink DELETE /tokenization/tokens/{id} Unlink a token
TokenizationApi unlink_collection DELETE /tokenization/collections/{id} Delete a collection link
TokenizationApi validate_layer_zero_channel_config GET /tokenization/multichain/bridge/layerzero/validate Validate LayerZero channel configuration
TradingBetaApi create_order POST /trading/orders Create an order
TradingBetaApi create_quote POST /trading/quotes Create a quote
TradingBetaApi get_order GET /trading/orders/{orderId} Get order details
TradingBetaApi get_orders GET /trading/orders Get orders
TradingBetaApi get_trading_providers GET /trading/providers Get providers
TransactionsApi cancel_transaction POST /transactions/{txId}/cancel Cancel a transaction
TransactionsApi create_transaction POST /transactions Create a new transaction
TransactionsApi drop_transaction POST /transactions/{txId}/drop Drop ETH (EVM) transaction by ID
TransactionsApi estimate_network_fee GET /estimate_network_fee Estimate the required fee for an asset
TransactionsApi estimate_transaction_fee POST /transactions/estimate_fee Estimate transaction fee
TransactionsApi freeze_transaction POST /transactions/{txId}/freeze Freeze a transaction
TransactionsApi get_transaction GET /transactions/{txId} Get a specific transaction by Fireblocks transaction ID
TransactionsApi get_transaction_by_external_id GET /transactions/external_tx_id/{externalTxId} Get a specific transaction by external transaction ID
TransactionsApi get_transactions GET /transactions Get transaction history
TransactionsApi set_confirmation_threshold_by_transaction_hash POST /txHash/{txHash}/set_confirmation_threshold Set confirmation threshold by transaction hash
TransactionsApi set_transaction_confirmation_threshold POST /transactions/{txId}/set_confirmation_threshold Set confirmation threshold by Fireblocks Transaction ID
TransactionsApi unfreeze_transaction POST /transactions/{txId}/unfreeze Unfreeze a transaction
TransactionsApi validate_address GET /transactions/validate_address/{assetId}/{address} Validate destination address
TravelRuleApi create_trust_proof_of_address POST /screening/travel_rule/providers/trust/proof_of_address Create Trust Network Proof of Address
TravelRuleApi get_trust_proof_of_address GET /screening/travel_rule/providers/trust/proof_of_address/{transactionId} Retrieve Trust Network Proof of Address Signature
TravelRuleApi get_vasp_for_vault GET /screening/travel_rule/vault/{vaultAccountId}/vasp Get assigned VASP to vault
TravelRuleApi get_vaspby_did GET /screening/travel_rule/vasp/{did} Get VASP details
TravelRuleApi get_vasps GET /screening/travel_rule/vasp Get All VASPs
TravelRuleApi set_vasp_for_vault POST /screening/travel_rule/vault/{vaultAccountId}/vasp Assign VASP to vault
TravelRuleApi update_vasp PUT /screening/travel_rule/vasp/update Add jsonDidKey to VASP details
TravelRuleApi validate_full_travel_rule_transaction POST /screening/travel_rule/transaction/validate/full Validate Full Travel Rule Transaction
UserGroupsBetaApi create_user_group POST /management/user_groups Create user group
UserGroupsBetaApi delete_user_group DELETE /management/user_groups/{groupId} Delete user group
UserGroupsBetaApi get_user_group GET /management/user_groups/{groupId} Get user group
UserGroupsBetaApi get_user_groups GET /management/user_groups List user groups
UserGroupsBetaApi update_user_group PUT /management/user_groups/{groupId} Update user group
UsersApi get_users GET /users List users
VaultsApi activate_asset_for_vault_account POST /vault/accounts/{vaultAccountId}/{assetId}/activate Activate a wallet in a vault account
VaultsApi attach_or_detach_tags_from_vault_accounts POST /vault/accounts/attached_tags Attach or detach tags from vault accounts
VaultsApi create_legacy_address POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy Convert a segwit address to legacy format
VaultsApi create_multiple_accounts POST /vault/accounts/bulk Bulk creation of new vault accounts
VaultsApi create_multiple_deposit_addresses POST /vault/accounts/addresses/bulk Bulk creation of new deposit addresses
VaultsApi create_vault_account POST /vault/accounts Create a new vault account
VaultsApi create_vault_account_asset POST /vault/accounts/{vaultAccountId}/{assetId} Create a new vault wallet
VaultsApi create_vault_account_asset_address POST /vault/accounts/{vaultAccountId}/{assetId}/addresses Create new asset deposit address
VaultsApi get_asset_wallets GET /vault/asset_wallets Get vault wallets (Paginated)
VaultsApi get_create_multiple_deposit_addresses_job_status GET /vault/accounts/addresses/bulk/{jobId} Get the job status of the bulk deposit address creation
VaultsApi get_create_multiple_vault_accounts_job_status GET /vault/accounts/bulk/{jobId} Get job status of bulk creation of new vault accounts
VaultsApi get_max_bip_index_used GET /vault/accounts/{vaultAccountId}/{assetId}/max_bip_index_used Get maximum BIP44 index used
VaultsApi get_max_spendable_amount GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount Get max spendable amount in a transaction
VaultsApi get_paged_vault_accounts GET /vault/accounts_paged Get vault accounts (Paginated)
VaultsApi get_public_key_info GET /vault/public_key_info Get the public key for a derivation path
VaultsApi get_public_key_info_for_address GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info Get an asset's public key
VaultsApi get_unspent_inputs GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs Get UTXO unspent inputs information
VaultsApi get_vault_account GET /vault/accounts/{vaultAccountId} Get a vault account by ID
VaultsApi get_vault_account_asset GET /vault/accounts/{vaultAccountId}/{assetId} Get the asset balance for a vault account
VaultsApi get_vault_account_asset_addresses_paginated GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated Get addresses (Paginated)
VaultsApi get_vault_assets GET /vault/assets Get asset balance for chosen assets
VaultsApi get_vault_balance_by_asset GET /vault/assets/{assetId} Get vault balance by an asset
VaultsApi hide_vault_account POST /vault/accounts/{vaultAccountId}/hide Hide a vault account in the console
VaultsApi set_customer_ref_id_for_address POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id Assign AML customer reference ID
VaultsApi set_vault_account_auto_fuel POST /vault/accounts/{vaultAccountId}/set_auto_fuel Set auto fueling to on or off
VaultsApi set_vault_account_customer_ref_id POST /vault/accounts/{vaultAccountId}/set_customer_ref_id Set an AML/KYT ID for a vault account
VaultsApi unhide_vault_account POST /vault/accounts/{vaultAccountId}/unhide Unhide a vault account in the console
VaultsApi update_vault_account PUT /vault/accounts/{vaultAccountId} Rename a vault account
VaultsApi update_vault_account_asset_address PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} Update address description
VaultsApi update_vault_account_asset_balance POST /vault/accounts/{vaultAccountId}/{assetId}/balance Refresh asset balance data
Web3ConnectionsApi create POST /connections/wc Create a new Web3 connection.
Web3ConnectionsApi get GET /connections List all open Web3 connections.
Web3ConnectionsApi remove DELETE /connections/wc/{id} Remove an existing Web3 connection.
Web3ConnectionsApi submit PUT /connections/wc/{id} Respond to a pending Web3 connection request.
WebhooksApi resend_transaction_webhooks POST /webhooks/resend/{txId} Resend webhooks for a transaction by ID
WebhooksApi resend_webhooks POST /webhooks/resend Resend failed webhooks
WebhooksV2Api create_webhook POST /webhooks Create a new webhook
WebhooksV2Api delete_webhook DELETE /webhooks/{webhookId} Delete webhook
WebhooksV2Api get_metrics GET /webhooks/{webhookId}/metrics/{metricName} Get webhook metrics
WebhooksV2Api get_notification GET /webhooks/{webhookId}/notifications/{notificationId} Get notification by id
WebhooksV2Api get_notification_attempts GET /webhooks/{webhookId}/notifications/{notificationId}/attempts Get notification attempts
WebhooksV2Api get_notifications GET /webhooks/{webhookId}/notifications Get all notifications by webhook id
WebhooksV2Api get_resend_job_status GET /webhooks/{webhookId}/notifications/resend_failed/jobs/{jobId} Get resend job status
WebhooksV2Api get_webhook GET /webhooks/{webhookId} Get webhook by id
WebhooksV2Api get_webhooks GET /webhooks Get all webhooks
WebhooksV2Api resend_failed_notifications POST /webhooks/{webhookId}/notifications/resend_failed Resend failed notifications
WebhooksV2Api resend_notification_by_id POST /webhooks/{webhookId}/notifications/{notificationId}/resend Resend notification by id
WebhooksV2Api resend_notifications_by_resource_id POST /webhooks/{webhookId}/notifications/resend_by_resource Resend notifications by resource Id
WebhooksV2Api update_webhook PATCH /webhooks/{webhookId} Update webhook
WorkspaceStatusBetaApi get_workspace_status GET /management/workspace_status Returns current workspace status
WhitelistIpAddressesApi get_whitelist_ip_addresses GET /management/api_users/{userId}/whitelist_ip_addresses Get whitelisted ip addresses for an API Key

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerTokenAuth

  • Type: Bearer authentication (JWT)

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-Key
  • Location: HTTP header

Author

developers@fireblocks.com

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

8 stars

Watchers

3 watching

Forks

6 forks
Report repository

Releases 31

v14.0.0 Latest
Feb 3, 2026
+ 30 releases

Packages

No packages published

Contributors 5

Languages