Skip to content

Repository files navigation

Official Fireblocks Java SDK

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

Building the API client library requires:

  1. Java 11+
  2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
<groupId>com.fireblocks.sdk</groupId>
<artifactId>fireblocks-sdk</artifactId>
<version>26.0.0</version>
<scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "com.fireblocks.sdk:fireblocks-sdk:26.0.0"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/fireblocks-sdk-26.0.0.jar
  • target/lib/*.jar

Getting Started

Initiate Fireblocks Client

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"

execute the following java code:

importcom.fireblocks.sdk.Fireblocks;
importcom.fireblocks.sdk.ConfigurationOptions;
ConfigurationOptionsconfigurationOptions = newConfigurationOptions();
Fireblocksfireblocks = newFireblocks(configurationOptions);

Providing Local Variables
Alternatively, you can directly pass the required parameters when initializing the Fireblocks API instance:

importcom.fireblocks.sdk.BasePath;
importcom.fireblocks.sdk.Fireblocks;
importcom.fireblocks.sdk.ConfigurationOptions;
ConfigurationOptionsconfigurationOptions = newConfigurationOptions()
.basePath(BasePath.Sandbox)
.apiKey("my-api-key")
.secretKey("my-secret-key");
Fireblocksfireblocks = newFireblocks(configurationOptions);

Examples

Creating a Vault Account

CreateVaultAccountRequestrequest = newCreateVaultAccountRequest().name("My Vault Account");
StringidempotencyKey = Integer.toString(newRandom().nextInt()); // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.// Async requestCompletableFuture<VaultAccount> response = fireblocks.vaults().createVaultAccount(request, idempotencyKey);
// Waiting for the requestVaultAccountvaultAccount = response.get();

Retrieving Vault Accounts

BigDecimallimit = newBigDecimal(10);
CompletableFuture<VaultAccountsPagedResponse> response = fireblocks.vaults().getPagedVaultAccounts(null, null, null, null, null, null, null, limit);
VaultAccountsPagedResponsevaultAccountsPagedResponse = response.get();

Creating a Transaction

TransactionRequesttransactionRequest = newTransactionRequest()
.operation(TransactionOperation.TRANSFER)
.source(newTransferPeerPath()
.type(TransferPeerPath.TypeEnum.VAULT_ACCOUNT)
.id("0"))
.destination(newDestinationTransferPeerPath()
.type(DestinationTransferPeerPath.TypeEnum.VAULT_ACCOUNT)
.id("1"))
.amount(newTransactionRequestAmount("0.001"))
.assetId("ETH_TEST3"); // Ethereum Goerli testnet
.note("My first Java transaction!");
StringidempotencyKey = Integer.toString(newRandom().nextInt()); // String | A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.CompletableFuture<CreateTransactionResponse> response = fireblocks.transactions().createTransaction(transactionRequest, null, idempotencyKey);
CreateTransactionResponsetransactionResponse = response.get();
StringtxId = transactionResponse.getId();

Documentation for API Endpoints

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

ClassMethodHTTP requestDescription
ApiUserApicreateApiUserPOST /management/api_usersCreate API Key
ApiUserApigetApiUsersGET /management/api_usersGet API Keys
ApiUserApiissueApiUserPairingTokenPOST /management/api_users/{userId}/pairing_tokenIssue API user pairing token
AuditLogsApigetAuditLogsGET /management/audit_logsGet audit logs
BlockchainLinkBetaApiactivateBlockchainLinkChainPOST /blockchain_link/blockchains/{blockchainId}/activateActivate a blockchain (triggers activation workflow)
BlockchainLinkBetaApicreateBlockchainLinkChainPOST /blockchain_link/blockchainsCreate a new blockchain
BlockchainLinkBetaApideleteBlockchainLinkChainDELETE /blockchain_link/blockchains/{blockchainId}Delete a blockchain
BlockchainLinkBetaApigetBlockchainLinkBillingInfoGET /blockchain_link/blockchains/billing_infoGet tenant billing info
BlockchainLinkBetaApigetBlockchainLinkChainGET /blockchain_link/blockchains/{blockchainId}Get a blockchain by ID
BlockchainLinkBetaApigetBlockchainLinkTestWalletAddressGET /blockchain_link/blockchains/test_wallet_addressGet the test wallet address
BlockchainLinkBetaApilistBlockchainLinkChainsGET /blockchain_link/blockchainsList blockchains with pagination and filtering
BlockchainLinkBetaApitriggerBlockchainLinkValidationPOST /blockchain_link/blockchains/{blockchainId}/validateTrigger validation workflow
BlockchainLinkBetaApiupdateBlockchainLinkChainPUT /blockchain_link/blockchains/{blockchainId}Update a blockchain
BlockchainsAssetsApigetAssetGET /assets/{id}Get an asset
BlockchainsAssetsApigetBlockchainGET /blockchains/{id}Get a Blockchain by ID
BlockchainsAssetsApigetSupportedAssetsGET /supported_assetsList assets (Legacy)
BlockchainsAssetsApilistAssetsGET /assetsList assets
BlockchainsAssetsApilistBlockchainsGET /blockchainsList blockchains
BlockchainsAssetsApiregisterNewAssetPOST /assetsRegister an asset
BlockchainsAssetsApisetAssetPricePOST /assets/prices/{id}Set asset price
BlockchainsAssetsApiupdateAssetUserMetadataPATCH /assets/{id}Update the user’s metadata for an asset
ComplianceApiactivateArsConfigPOST /screening/ars/config/activateActivate ARS (Address Registry Screening)
ComplianceApiactivateByorkConfigPOST /screening/byork/config/activateActivate BYORK Light
ComplianceApiaddAddressRegistryVaultOptOutsPOST /address_registry/vaultsAdd vault accounts to the address registry opt-out list
ComplianceApiassignVaultsToLegalEntityPOST /legal_entities/{legalEntityId}/vaultsAssign vault accounts to a legal entity
ComplianceApicreateCounterpartyGroupPOST /counterparty_groupsCreate a counterparty group
ComplianceApideactivateArsConfigPOST /screening/ars/config/deactivateDeactivate ARS (Address Registry Screening)
ComplianceApideactivateByorkConfigPOST /screening/byork/config/deactivateDeactivate BYORK Light
ComplianceApideleteCounterpartyGroupDELETE /counterparty_groups/{groupId}Delete a counterparty group
ComplianceApideleteLegalEntityDELETE /legal_entities/{legalEntityId}Delete a legal entity
ComplianceApigetAddressRegistryTenantParticipationStatusGET /address_registry/tenantGet address registry participation status for the authenticated workspace
ComplianceApigetAddressRegistryVaultOptOutGET /address_registry/vaults/{vaultAccountId}Get whether a vault account is opted out of the address registry
ComplianceApigetAmlPostScreeningPolicyGET /screening/aml/post_screening_policyAML - View Post-Screening Policy
ComplianceApigetAmlScreeningPolicyGET /screening/aml/screening_policyAML - View Screening Policy
ComplianceApigetByorkConfigGET /screening/byork/configGet BYORK Light configuration
ComplianceApigetByorkVerdictGET /screening/byork/verdictGet BYORK Light verdict
ComplianceApigetCounterpartyGroupGET /counterparty_groups/{groupId}Get a counterparty group
ComplianceApigetLegalEntityGET /legal_entities/{legalEntityId}Get a legal entity
ComplianceApigetLegalEntityForAddressGET /address_registry/legal_entities/{address}Look up legal entity by blockchain address
ComplianceApigetPostScreeningPolicyGET /screening/travel_rule/post_screening_policyTravel Rule - View Post-Screening Policy
ComplianceApigetScreeningFullDetailsGET /screening/transaction/{txId}Provides all the compliance details for the given screened transaction.
ComplianceApigetScreeningPolicyGET /screening/travel_rule/screening_policyTravel Rule - View Screening Policy
ComplianceApilistAddressRegistryVaultOptOutsGET /address_registry/vaultsList vault-level address registry opt-outs (paginated)
ComplianceApilistCounterpartyGroupsGET /counterparty_groupsList counterparty groups
ComplianceApilistLegalEntitiesGET /legal_entitiesList legal entities (Paginated)
ComplianceApilistVaultsForLegalEntityGET /legal_entities/{legalEntityId}/vaultsList vault accounts for a legal entity (Paginated)
ComplianceApioptInAddressRegistryTenantPOST /address_registry/tenantOpt the workspace in to the address registry
ComplianceApioptOutAddressRegistryTenantDELETE /address_registry/tenantOpt the workspace out of the address registry
ComplianceApiregisterLegalEntityPOST /legal_entitiesRegister a new legal entity
ComplianceApiremoveAddressRegistryVaultOptOutDELETE /address_registry/vaults/{vaultAccountId}Remove a single vault account from the address registry opt-out list
ComplianceApiremoveAllAddressRegistryVaultOptOutsDELETE /address_registry/vaultsRemove all vault-level address registry opt-outs for the workspace
ComplianceApirescreenRejectedTransactionPOST /screening/transaction/{txId}/rescreenRescreen a rejected transaction
ComplianceApiretryRejectedTransactionBypassScreeningChecksPOST /screening/transaction/{txId}/bypass_screening_policyBypass Screening Policy
ComplianceApisetAmlVerdictPOST /screening/aml/verdict/manualSet AML Verdict (BYORK Super Light)
ComplianceApisetByorkTimeoutsPUT /screening/byork/config/timeoutsSet BYORK Light timeouts
ComplianceApisetByorkVerdictPOST /screening/byork/verdictSet BYORK Light verdict
ComplianceApiupdateAmlScreeningConfigurationPUT /screening/aml/policy_configurationUpdate AML Configuration
ComplianceApiupdateCounterpartyGroupPATCH /counterparty_groups/{groupId}Update a counterparty group
ComplianceApiupdateLegalEntityPUT /legal_entities/{legalEntityId}Update legal entity
ComplianceApiupdateScreeningConfigurationPUT /screening/configurationsTenant - Screening Configuration
ComplianceApiupdateTravelRuleConfigPUT /screening/travel_rule/policy_configurationUpdate Travel Rule Configuration
ComplianceScreeningConfigurationApigetAmlScreeningConfigurationGET /screening/aml/policy_configurationGet AML Screening Policy Configuration
ComplianceScreeningConfigurationApigetScreeningConfigurationGET /screening/travel_rule/policy_configurationGet Travel Rule Screening Policy Configuration
ConnectedAccountsBetaApiaddConnectedAccountPOST /connected_accountsAdd a connected account
ConnectedAccountsBetaApidisconnectConnectedAccountDELETE /connected_accounts/{accountId}Disconnect connected account
ConnectedAccountsBetaApigetConnectedAccountGET /connected_accounts/{accountId}Get connected account
ConnectedAccountsBetaApigetConnectedAccountAllowlistGET /connected_accounts/{accountId}/allowlistGet allowlist for connected account
ConnectedAccountsBetaApigetConnectedAccountAllowlistEntryGET /connected_accounts/{accountId}/allowlist/{allowlistId}Get a single allowlist entry for a connected account
ConnectedAccountsBetaApigetConnectedAccountBalancesGET /connected_accounts/{accountId}/balancesGet balances for an account
ConnectedAccountsBetaApigetConnectedAccountRatesGET /connected_accounts/{accountId}/ratesGet exchange rates for an account
ConnectedAccountsBetaApigetConnectedAccountTradingPairsGET /connected_accounts/{accountId}/manifest/capabilities/trading/pairsGet supported trading pairs for an account
ConnectedAccountsBetaApigetConnectedAccountsGET /connected_accountsGet connected accounts
ConnectedAccountsBetaApigetConnectedAccountsCredentialsPublicKeyGET /connected_accounts/credentials/public_keyGet public key to encrypt connected account credentials
ConnectedAccountsBetaApirenameConnectedAccountPOST /connected_accounts/{accountId}/renameRename Connected Account
ConnectedAccountsBetaApisyncConnectedAccountAllowlistPOST /connected_accounts/{accountId}/allowlist/syncSync allowlist for connected account
ConsoleUserApicreateConsoleUserPOST /management/usersCreate console user
ConsoleUserApigetConsoleUsersGET /management/usersGet console users
ContractInteractionsApidecodeContractDataPOST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decodeDecode a function call data, error, or event log
ContractInteractionsApigetContractAddressGET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}Get contract address by transaction hash
ContractInteractionsApigetDeployedContractAbiGET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functionsReturn deployed contract's ABI
ContractInteractionsApigetTransactionReceiptGET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receiptGet transaction receipt
ContractInteractionsApireadCallFunctionPOST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/readCall a read function on a deployed contract
ContractInteractionsApiwriteCallFunctionPOST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/writeCall a write function on a deployed contract
ContractTemplatesApideleteContractTemplateByIdDELETE /tokenization/templates/{contractTemplateId}Delete a contract template by id
ContractTemplatesApideployContractPOST /tokenization/templates/{contractTemplateId}/deployDeploy contract
ContractTemplatesApigetConstructorByContractTemplateIdGET /tokenization/templates/{contractTemplateId}/constructorReturn contract template's constructor
ContractTemplatesApigetContractTemplateByIdGET /tokenization/templates/{contractTemplateId}Return contract template by id
ContractTemplatesApigetContractTemplatesGET /tokenization/templatesList all contract templates
ContractTemplatesApigetFunctionAbiByContractTemplateIdGET /tokenization/templates/{contractTemplateId}/functionReturn contract template's function
ContractTemplatesApigetSupportedBlockchainsByTemplateIdGET /tokenization/templates/{contractTemplateId}/supported_blockchainsGet supported blockchains for the template
ContractTemplatesApiuploadContractTemplatePOST /tokenization/templatesUpload contract template
ContractsApiaddContractAssetPOST /contracts/{contractId}/{assetId}Add an asset to a whitelisted contract
ContractsApicreateContractPOST /contractsAdd a contract
ContractsApideleteContractDELETE /contracts/{contractId}Delete a contract
ContractsApideleteContractAssetDELETE /contracts/{contractId}/{assetId}Delete an asset from a whitelisted contract
ContractsApigetContractGET /contracts/{contractId}Find a Specific Whitelisted Contract
ContractsApigetContractAssetGET /contracts/{contractId}/{assetId}Find a whitelisted contract's asset
ContractsApigetContractsGET /contractsList Whitelisted Contracts
CosignersBetaApiaddCosignerPOST /cosignersAdd cosigner
CosignersBetaApigetApiKeyGET /cosigners/{cosignerId}/api_keys/{apiKeyId}Get API key
CosignersBetaApigetApiKeysGET /cosigners/{cosignerId}/api_keysGet all API keys
CosignersBetaApigetCosignerGET /cosigners/{cosignerId}Get cosigner
CosignersBetaApigetCosignersGET /cosignersGet all cosigners
CosignersBetaApigetRequestStatusGET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId}Get request status
CosignersBetaApipairApiKeyPUT /cosigners/{cosignerId}/api_keys/{apiKeyId}Pair API key
CosignersBetaApirenameCosignerPATCH /cosigners/{cosignerId}Rename cosigner
CosignersBetaApiunpairApiKeyDELETE /cosigners/{cosignerId}/api_keys/{apiKeyId}Unpair API key
CosignersBetaApiupdateCallbackHandlerPATCH /cosigners/{cosignerId}/api_keys/{apiKeyId}Update API key callback handler
DeployedContractsApiaddContractABIPOST /tokenization/contracts/abiSave contract ABI
DeployedContractsApifetchContractAbiPOST /tokenization/contracts/fetch_abiFetch the contract ABI
DeployedContractsApigetDeployedContractByAddressGET /tokenization/contracts/{assetId}/{contractAddress}Return deployed contract data
DeployedContractsApigetDeployedContractByIdGET /tokenization/contracts/{id}Return deployed contract data by id
DeployedContractsApigetDeployedContractsGET /tokenization/contractsList deployed contracts data
EarnApiapproveTermsOfServicePOST /earn/providers/approve_terms_of_serviceApprove earn provider terms of service
EarnApicreateEarnActionPOST /earn/actionsCreate and execute a lending action (deposit or withdraw)
EarnApigetEarnActionGET /earn/actions/{id}Get a single earn lending action
EarnApigetEarnActionsGET /earn/actionsList earn lending actions
EarnApigetEarnOpportunitiesGET /earn/opportunitiesGet list of earn opportunities
EarnApigetEarnPositionsGET /earn/positionsGet list of earn positions
EarnApigetEarnProvidersGET /earn/providersGet list of earn providers
EmbeddedWalletsApiaddEmbeddedWalletAssetPOST /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}Add asset to account
EmbeddedWalletsApiassignEmbeddedWalletPOST /ncw/wallets/{walletId}/assignAssign a wallet
EmbeddedWalletsApicreateEmbeddedWalletPOST /ncw/walletsCreate a new wallet
EmbeddedWalletsApicreateEmbeddedWalletAccountPOST /ncw/wallets/{walletId}/accountsCreate a new account
EmbeddedWalletsApigetEmbeddedWalletGET /ncw/wallets/{walletId}Get a wallet
EmbeddedWalletsApigetEmbeddedWalletAccountGET /ncw/wallets/{walletId}/accounts/{accountId}Get a account
EmbeddedWalletsApigetEmbeddedWalletAddressesGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addressesRetrieve asset addresses
EmbeddedWalletsApigetEmbeddedWalletAssetGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}Retrieve asset
EmbeddedWalletsApigetEmbeddedWalletAssetBalanceGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balanceRetrieve asset balance
EmbeddedWalletsApigetEmbeddedWalletAssetsGET /ncw/wallets/{walletId}/accounts/{accountId}/assetsRetrieve assets
EmbeddedWalletsApigetEmbeddedWalletDeviceGET /ncw/wallets/{walletId}/devices/{deviceId}Get Embedded Wallet Device
EmbeddedWalletsApigetEmbeddedWalletDeviceSetupStateGET /ncw/wallets/{walletId}/devices/{deviceId}/setup_statusGet device key setup state
EmbeddedWalletsApigetEmbeddedWalletDevicesPaginatedGET /ncw/wallets/{walletId}/devices_paginatedGet registered devices - paginated
EmbeddedWalletsApigetEmbeddedWalletLatestBackupGET /ncw/wallets/{walletId}/backup/latestGet wallet Latest Backup details
EmbeddedWalletsApigetEmbeddedWalletPublicKeyInfoForAddressGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_infoGet the public key of an asset
EmbeddedWalletsApigetEmbeddedWalletSetupStatusGET /ncw/wallets/{walletId}/setup_statusGet wallet key setup state
EmbeddedWalletsApigetEmbeddedWalletSupportedAssetsGET /ncw/wallets/supported_assetsRetrieve supported assets
EmbeddedWalletsApigetEmbeddedWalletsGET /ncw/walletsList wallets
EmbeddedWalletsApigetPublicKeyInfoNcwGET /ncw/wallets/{walletId}/public_key_infoGet the public key for a derivation path
EmbeddedWalletsApirefreshEmbeddedWalletAssetBalancePUT /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balanceRefresh asset balance
EmbeddedWalletsApiupdateEmbeddedWalletDeviceStatusPATCH /ncw/wallets/{walletId}/devices/{deviceId}/statusUpdate device status
EmbeddedWalletsApiupdateEmbeddedWalletStatusPATCH /ncw/wallets/{walletId}/statusUpdate wallet status
ExchangeAccountsApiaddExchangeAccountPOST /exchange_accountsAdd an exchange account
ExchangeAccountsApiconvertAssetsPOST /exchange_accounts/{exchangeAccountId}/convertConvert exchange account funds
ExchangeAccountsApigetExchangeAccountGET /exchange_accounts/{exchangeAccountId}Get a specific exchange account
ExchangeAccountsApigetExchangeAccountAssetGET /exchange_accounts/{exchangeAccountId}/{assetId}Get an asset for an exchange account
ExchangeAccountsApigetExchangeAccountsCredentialsPublicKeyGET /exchange_accounts/credentials_public_keyGet public key to encrypt exchange credentials
ExchangeAccountsApigetPagedExchangeAccountsGET /exchange_accounts/pagedList connected exchange accounts
ExchangeAccountsApiinternalTransferPOST /exchange_accounts/{exchangeAccountId}/internal_transferInternal transfer for exchange accounts
ExternalWalletsApiaddAssetToExternalWalletPOST /external_wallets/{walletId}/{assetId}Add an asset to an external wallet.
ExternalWalletsApicreateExternalWalletPOST /external_walletsCreate an external wallet
ExternalWalletsApideleteExternalWalletDELETE /external_wallets/{walletId}Delete an external wallet
ExternalWalletsApigetExternalWalletGET /external_wallets/{walletId}Find an external wallet
ExternalWalletsApigetExternalWalletAssetGET /external_wallets/{walletId}/{assetId}Get an asset from an external wallet
ExternalWalletsApigetExternalWalletsGET /external_walletsList external wallets
ExternalWalletsApiremoveAssetFromExternalWalletDELETE /external_wallets/{walletId}/{assetId}Delete an asset from an external wallet
ExternalWalletsApisetExternalWalletCustomerRefIdPOST /external_wallets/{walletId}/set_customer_ref_idSet an AML customer reference ID for an external wallet
FiatAccountsApidepositFundsFromLinkedDDAPOST /fiat_accounts/{accountId}/deposit_from_linked_ddaDeposit funds from DDA
FiatAccountsApigetFiatAccountGET /fiat_accounts/{accountId}Find a specific fiat account
FiatAccountsApigetFiatAccountsGET /fiat_accountsList fiat accounts
FiatAccountsApiredeemFundsToLinkedDDAPOST /fiat_accounts/{accountId}/redeem_to_linked_ddaRedeem funds to DDA
GasStationsApigetGasStationByAssetIdGET /gas_station/{assetId}Get gas station settings by asset
GasStationsApigetGasStationInfoGET /gas_stationGet gas station settings
GasStationsApiupdateGasStationConfigurationPUT /gas_station/configurationEdit gas station settings
GasStationsApiupdateGasStationConfigurationByAssetIdPUT /gas_station/configuration/{assetId}Edit gas station settings for an asset
GenieBetaApicreateGenieSessionPOST /genie/sessionsCreate a Genie session
GenieBetaApisendGenieMessagePOST /genie/sessions/{sessionId}/messagesSend a message to a Genie session
InternalWalletsApicreateInternalWalletPOST /internal_walletsCreate an internal wallet
InternalWalletsApicreateInternalWalletAssetPOST /internal_wallets/{walletId}/{assetId}Add an asset to an internal wallet
InternalWalletsApideleteInternalWalletDELETE /internal_wallets/{walletId}Delete an internal wallet
InternalWalletsApideleteInternalWalletAssetDELETE /internal_wallets/{walletId}/{assetId}Delete a whitelisted address
InternalWalletsApigetInternalWalletGET /internal_wallets/{walletId}Get assets for internal wallet
InternalWalletsApigetInternalWalletAssetGET /internal_wallets/{walletId}/{assetId}Get an asset from an internal wallet
InternalWalletsApigetInternalWalletAssetsPaginatedGET /internal_wallets/{walletId}/assetsList assets in an internal wallet (Paginated)
InternalWalletsApigetInternalWalletsGET /internal_walletsList internal wallets
InternalWalletsApisetCustomerRefIdForInternalWalletPOST /internal_wallets/{walletId}/set_customer_ref_idSet an AML/KYT customer reference ID for internal wallet
KeyLinkBetaApicreateSigningKeyPOST /key_link/signing_keysAdd a new signing key
KeyLinkBetaApicreateValidationKeyPOST /key_link/validation_keysAdd a new validation key
KeyLinkBetaApidisableValidationKeyPATCH /key_link/validation_keys/{keyId}Disables a validation key
KeyLinkBetaApigetSigningKeyGET /key_link/signing_keys/{keyId}Get a signing key by `keyId`
KeyLinkBetaApigetSigningKeysListGET /key_link/signing_keysGet list of signing keys
KeyLinkBetaApigetValidationKeyGET /key_link/validation_keys/{keyId}Get a validation key by `keyId`
KeyLinkBetaApigetValidationKeysListGET /key_link/validation_keysGet list of registered validation keys
KeyLinkBetaApisetAgentIdPATCH /key_link/signing_keys/{keyId}/agent_user_idSet agent user id
KeyLinkBetaApiupdateSigningKeyPATCH /key_link/signing_keys/{keyId}Modify the signing keyId
KeysBetaApigetMpcKeysListGET /keys/mpc/listGet list of mpc keys
KeysBetaApigetMpcKeysListByUserGET /keys/mpc/list/{userId}Get list of mpc keys by `userId`
NetworkConnectionsApicheckThirdPartyRoutingGET /network_connections/{connectionId}/is_third_party_routing/{assetType}Retrieve third-party network routing validation
NetworkConnectionsApicreateNetworkConnectionPOST /network_connectionsCreate a new network connection
NetworkConnectionsApicreateNetworkIdPOST /network_idsCreates a new Network ID
NetworkConnectionsApideleteNetworkConnectionDELETE /network_connections/{connectionId}Delete a network connection by ID
NetworkConnectionsApideleteNetworkIdDELETE /network_ids/{networkId}Delete specific network ID.
NetworkConnectionsApigetNetworkGET /network_connections/{connectionId}Get a network connection
NetworkConnectionsApigetNetworkConnectionsGET /network_connectionsList network connections
NetworkConnectionsApigetNetworkIdGET /network_ids/{networkId}Return specific network ID.
NetworkConnectionsApigetNetworkIdsGET /network_idsGet all network IDs
NetworkConnectionsApigetRoutingPolicyAssetGroupsGET /network_ids/routing_policy_asset_groupsReturn all enabled routing policy asset groups
NetworkConnectionsApisearchNetworkIdsGET /network_ids/searchGet both local IDs and discoverable remote IDs
NetworkConnectionsApisetNetworkIdDiscoverabilityPATCH /network_ids/{networkId}/set_discoverabilityUpdate network ID's discoverability.
NetworkConnectionsApisetNetworkIdNamePATCH /network_ids/{networkId}/set_nameUpdate network ID's name.
NetworkConnectionsApisetNetworkIdRoutingPolicyPATCH /network_ids/{networkId}/set_routing_policyUpdate network id routing policy.
NetworkConnectionsApisetRoutingPolicyPATCH /network_connections/{connectionId}/set_routing_policyUpdate network connection routing policy.
NftsApigetNFTGET /nfts/tokens/{id}List token data by ID
NftsApigetNFTsGET /nfts/tokensList tokens by IDs
NftsApigetOwnershipTokensGET /nfts/ownership/tokensList all owned tokens (paginated)
NftsApilistOwnedCollectionsGET /nfts/ownership/collectionsList owned collections (paginated)
NftsApilistOwnedTokensGET /nfts/ownership/assetsList all distinct owned tokens (paginated)
NftsApirefreshNFTMetadataPUT /nfts/tokens/{id}Refresh token metadata
NftsApiupdateOwnershipTokensPUT /nfts/ownership/tokensRefresh vault account tokens
NftsApiupdateTokenOwnershipStatusPUT /nfts/ownership/tokens/{id}/statusUpdate token ownership status
NftsApiupdateTokensOwnershipSpamPUT /nfts/ownership/tokens/spamUpdate tokens ownership spam property
NftsApiupdateTokensOwnershipStatusPUT /nfts/ownership/tokens/statusUpdate tokens ownership status
OffExchangesApiaddOffExchangePOST /off_exchange/addAdd Collateral
OffExchangesApigetOffExchangeCollateralAccountsGET /off_exchange/collateral_accounts/{mainExchangeAccountId}Find a specific collateral exchange account
OffExchangesApigetOffExchangeSettlementTransactionsGET /off_exchange/settlements/transactionsGet Settlements Transactions
OffExchangesApiremoveOffExchangePOST /off_exchange/removeRemove Collateral
OffExchangesApisettleOffExchangeTradesPOST /off_exchange/settlements/traderCreate Settlement for a Trader
OnchainDataApigetAccessRegistryCurrentStateGET /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/listGet the current state of addresses in an access registry
OnchainDataApigetAccessRegistrySummaryGET /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/summarySummary of access registry state
OnchainDataApigetActiveRolesForContractGET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/rolesList of active roles for a given contract address and base asset ID
OnchainDataApigetContractBalanceHistoryGET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/account_address/{accountAddress}/balance_historyGet historical balance data for a specific account in a contract
OnchainDataApigetContractBalancesSummaryGET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/summaryGet summary for the token contract
OnchainDataApigetContractTotalSupplyGET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/total_supplyGet historical total supply data for a contract
OnchainDataApigetLatestBalancesForContractGET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/balancesGet latest balances for all addresses holding tokens from a contract
OnchainDataApigetOnchainTransactionsGET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/transactionsFetch onchain transactions for a contract
OtaBetaApigetOtaStatusGET /management/otaReturns current OTA status
OtaBetaApisetOtaStatusPUT /management/otaEnable or disable transactions to OTA
PaymentsPayoutApicreatePayoutPOST /payments/payoutCreate a payout instruction set
PaymentsPayoutApiexecutePayoutActionPOST /payments/payout/{payoutId}/actions/executeExecute a payout instruction set
PaymentsPayoutApigetPayoutGET /payments/payout/{payoutId}Get the status of a payout instruction set
PolicyEditorBetaApigetActivePolicyLegacyGET /tap/active_policyGet the active policy and its validation
PolicyEditorBetaApigetDraftLegacyGET /tap/draftGet the active draft
PolicyEditorBetaApipublishDraftLegacyPOST /tap/draftSend publish request for a certain draft id
PolicyEditorBetaApipublishPolicyRulesPOST /tap/publishSend publish request for a set of policy rules
PolicyEditorBetaApiupdateDraftLegacyPUT /tap/draftUpdate the draft with a new set of rules
PolicyEditorV2ApigetActivePolicyGET /policy/active_policyGet the active policy and its validation by policy type
PolicyEditorV2ApigetDraftGET /policy/draftGet the active draft by policy type
PolicyEditorV2ApipublishDraftPOST /policy/draftSend publish request for a certain draft id
PolicyEditorV2ApiupdateDraftPUT /policy/draftUpdate the draft with a new set of rules by policy types
PolicyEditorV2BetaApigetPolicyRuleQuotaPOST /policy/rules/quotaCalculate the AOT quota for a policy rule
ReportsBetaApicreateReportPOST /reportsCreate a report
ReportsBetaApigetReportGET /reports/{reportId}Get report status
ReportsBetaApilistReportsGET /reportsList reports
ResetDeviceApiresetDevicePOST /management/users/{id}/reset_deviceResets device
SmartTransferApiapproveDvPTicketTermPUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approveSet funding source and approval
SmartTransferApicancelTicketPUT /smart-transfers/{ticketId}/cancelCancel Ticket
SmartTransferApicreateTicketPOST /smart-transfersCreate Ticket
SmartTransferApicreateTicketTermPOST /smart-transfers/{ticketId}/termsCreate leg (term)
SmartTransferApifindTicketByIdGET /smart-transfers/{ticketId}Search Ticket by ID
SmartTransferApifindTicketTermByIdGET /smart-transfers/{ticketId}/terms/{termId}Get Smart Transfer ticket term
SmartTransferApifulfillTicketPUT /smart-transfers/{ticketId}/fulfillFund ticket manually
SmartTransferApifundDvpTicketPUT /smart_transfers/{ticketId}/dvp/fundFund dvp ticket
SmartTransferApifundTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}/fundDefine funding source
SmartTransferApigetSmartTransferStatisticGET /smart_transfers/statisticGet smart transfers statistic
SmartTransferApigetSmartTransferUserGroupsGET /smart-transfers/settings/user-groupsGet user group
SmartTransferApimanuallyFundTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}/manually-fundManually add term transaction
SmartTransferApiremoveTicketTermDELETE /smart-transfers/{ticketId}/terms/{termId}Delete ticket leg (term)
SmartTransferApisearchTicketsGET /smart-transfersFind Ticket
SmartTransferApisetExternalRefIdPUT /smart-transfers/{ticketId}/external-idAdd external ref. ID
SmartTransferApisetTicketExpirationPUT /smart-transfers/{ticketId}/expires-inSet expiration
SmartTransferApisetUserGroupsPOST /smart-transfers/settings/user-groupsSet user group
SmartTransferApisubmitTicketPUT /smart-transfers/{ticketId}/submitSubmit ticket
SmartTransferApiupdateTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}Update ticket leg (term)
StakingApiapproveTermsOfServiceByProviderIdPOST /staking/providers/{providerId}/approveTermsOfServiceApprove provider terms of service
StakingApiclaimRewardsPOST /staking/chains/{chainDescriptor}/claim_rewardsClaim accrued rewards
StakingApiconsolidatePOST /staking/chains/{chainDescriptor}/consolidateConsolidate staking positions (ETH validator consolidation)
StakingApigetAllDelegationsGET /staking/positionsList staking positions
StakingApigetChainInfoGET /staking/chains/{chainDescriptor}/chainInfoGet chain-level staking parameters
StakingApigetChainsGET /staking/chainsList supported staking chains
StakingApigetDelegationByIdGET /staking/positions/{id}Get position details
StakingApigetPositionRelatedTransactionsGET /staking/positions/{id}/related_transactionsList related transactions for a position
StakingApigetPositionsGET /staking/positions_paginatedList staking positions (Paginated)
StakingApigetProvidersGET /staking/providersList staking providers
StakingApigetSummaryGET /staking/positions/summaryGet positions summary
StakingApigetSummaryByVaultGET /staking/positions/summary/vaultsGet positions summary by vault
StakingApimergeStakeAccountsPOST /staking/chains/{chainDescriptor}/mergeMerge staking positions
StakingApisplitPOST /staking/chains/{chainDescriptor}/splitSplit a staking position
StakingApistakePOST /staking/chains/{chainDescriptor}/stakeInitiate or add to existing stake
StakingApiunstakePOST /staking/chains/{chainDescriptor}/unstakeInitiate unstake
StakingApiwithdrawPOST /staking/chains/{chainDescriptor}/withdrawWithdraw staked funds
TagsApicreateTagPOST /tagsCreate a new tag
TagsApideleteTagDELETE /tags/{tagId}Delete a tag
TagsApigetApprovalRequestGET /tags/approval_requests/{id}Get an approval request by id
TagsApigetTagGET /tags/{tagId}Get a tag
TagsApigetTagsGET /tagsGet list of tags
TagsApiupdateTagPATCH /tags/{tagId}Update a tag
TokenizationApiburnCollectionTokenPOST /tokenization/collections/{id}/tokens/burnBurn tokens
TokenizationApicreateNewCollectionPOST /tokenization/collectionsCreate a new collection
TokenizationApideactivateAndUnlinkAdaptersDELETE /tokenization/multichain/bridge/layerzeroRemove LayerZero adapters
TokenizationApideployAndLinkAdaptersPOST /tokenization/multichain/bridge/layerzeroDeploy LayerZero adapters
TokenizationApifetchCollectionTokenDetailsGET /tokenization/collections/{id}/tokens/{tokenId}Get collection token details
TokenizationApigetCollectionByIdGET /tokenization/collections/{id}Get a collection by id
TokenizationApigetDeployableAddressPOST /tokenization/multichain/deterministic_addressGet deterministic address for contract deployment
TokenizationApigetLayerZeroDvnConfigGET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/dvnsGet LayerZero DVN configuration
TokenizationApigetLayerZeroPeersGET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/peersGet LayerZero peers
TokenizationApigetLinkedCollectionsGET /tokenization/collectionsGet collections
TokenizationApigetLinkedTokenGET /tokenization/tokens/{id}Return a linked token
TokenizationApigetLinkedTokensGET /tokenization/tokensList all linked tokens
TokenizationApigetLinkedTokensCountGET /tokenization/tokens/countGet the total count of linked tokens
TokenizationApigetTokenAccessRegistryAddressesGET /tokenization/access_registries/{id}/addressesGet current state of addresses in an access registry
TokenizationApigetTokenAccessRegistrySummaryGET /tokenization/access_registries/{id}/summaryGet summary of an access registry
TokenizationApigetTokenBalanceForAccountGET /tokenization/tokens/{id}/balances/{accountAddress}Get the latest balance for a specific account
TokenizationApigetTokenBalanceHistoryGET /tokenization/tokens/{id}/balances/{accountAddress}/historyGet balance history for a specific account
TokenizationApigetTokenBalancesGET /tokenization/tokens/{id}/balancesGet latest balances for all holders of a token
TokenizationApigetTokenContractSummaryGET /tokenization/tokens/{id}/summaryGet onchain summary for a token
TokenizationApigetTokenRbacGET /tokenization/tokens/{id}/rbacGet active RBAC roles for a token
TokenizationApigetTokenTotalSupplyGET /tokenization/tokens/{id}/total_supplyGet historical total supply for a token
TokenizationApigetTokenTransactionsGET /tokenization/tokens/{id}/transactionsGet onchain transactions for a token
TokenizationApigetTokenTransfersGET /tokenization/tokens/{id}/transfersGet onchain transfers for a token
TokenizationApiissueNewTokenPOST /tokenization/tokensIssue a new token
TokenizationApiissueTokenMultiChainPOST /tokenization/multichain/tokensIssue a token on one or more blockchains
TokenizationApilinkPOST /tokenization/tokens/linkLink a contract
TokenizationApimintCollectionTokenPOST /tokenization/collections/{id}/tokens/mintMint tokens
TokenizationApireIssueTokenMultiChainPOST /tokenization/multichain/reissue/token/{tokenLinkId}Reissue a multichain token
TokenizationApiremoveLayerZeroPeersDELETE /tokenization/multichain/bridge/layerzero/config/peersRemove LayerZero peers
TokenizationApisetLayerZeroDvnConfigPOST /tokenization/multichain/bridge/layerzero/config/dvnsSet LayerZero DVN configuration
TokenizationApisetLayerZeroPeersPOST /tokenization/multichain/bridge/layerzero/config/peersSet LayerZero peers
TokenizationApiunlinkDELETE /tokenization/tokens/{id}Unlink a token
TokenizationApiunlinkCollectionDELETE /tokenization/collections/{id}Delete a collection link
TokenizationApivalidateLayerZeroChannelConfigGET /tokenization/multichain/bridge/layerzero/validateValidate LayerZero channel configuration
TrLinkApiassessTRLinkTravelRuleRequirementPOST /screening/trlink/customers/integration/{customerIntegrationId}/trm/assessAssess Travel Rule requirement
TrLinkApicancelTRLinkTrmPOST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancelCancel Travel Rule Message
TrLinkApiconnectTRLinkIntegrationPUT /screening/trlink/customers/integration/{customerIntegrationId}Connect customer integration
TrLinkApicreateTRLinkCustomerPOST /screening/trlink/customersCreate customer
TrLinkApicreateTRLinkIntegrationPOST /screening/trlink/customers/integrationCreate customer integration
TrLinkApicreateTRLinkManualDecisionPOST /screening/trlink/customers/integration/{customerIntegrationId}/transactions/{txId}/manual_decisionManual decision for missing TRM
TrLinkApicreateTRLinkTrmPOST /screening/trlink/customers/integration/{customerIntegrationId}/trmCreate Travel Rule Message
TrLinkApideleteTRLinkCustomerDELETE /screening/trlink/customers/{customerId}Delete customer
TrLinkApidisconnectTRLinkIntegrationDELETE /screening/trlink/customers/integration/{customerIntegrationId}Disconnect customer integration
TrLinkApigetTRLinkCustomerByIdGET /screening/trlink/customers/{customerId}Get customer by ID
TrLinkApigetTRLinkCustomerIntegrationByIdGET /screening/trlink/customers/{customerId}/integrations/{customerIntegrationId}Get customer integration by ID
TrLinkApigetTRLinkCustomerIntegrationsGET /screening/trlink/customers/{customerId}/integrationsGet customer integrations
TrLinkApigetTRLinkCustomersGET /screening/trlink/customersGet all customers
TrLinkApigetTRLinkIntegrationPublicKeyGET /screening/trlink/customers/integration/{customerIntegrationId}/public_keyGet public key for PII encryption
TrLinkApigetTRLinkPartnersGET /screening/trlink/partnersList available TRSupport partners
TrLinkApigetTRLinkPolicyGET /screening/trlink/policyGet TRLink policy
TrLinkApigetTRLinkSupportedAssetGET /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId}Get supported asset by ID
TrLinkApigetTRLinkTrmByIdGET /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}Get TRM by ID
TrLinkApigetTRLinkTrmRequiredActionsGET /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/required_actionsGet required actions for a TRM
TrLinkApigetTRLinkVaspByIdGET /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId}Get VASP by ID
TrLinkApilistTRLinkSupportedAssetsGET /screening/trlink/customers/integration/{customerIntegrationId}/assetsList supported assets
TrLinkApilistTRLinkVaspsGET /screening/trlink/customers/integration/{customerIntegrationId}/vaspsList VASPs
TrLinkApiredirectTRLinkTrmPOST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirectRedirect Travel Rule Message
TrLinkApiresolveActionTRLinkTrmPOST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/resolve_actionResolve action for a TRM
TrLinkApisetTRLinkDestinationTravelRuleMessageIdPOST /screening/trlink/transaction/{txId}/destination/travel_rule_message_idSet destination travel rule message ID
TrLinkApisetTRLinkTransactionTravelRuleMessageIdPOST /screening/trlink/transaction/{txId}/travel_rule_message_idSet transaction travel rule message ID
TrLinkApitestTRLinkIntegrationConnectionPOST /screening/trlink/customers/integration/{customerIntegrationId}/test_connectionTest connection
TrLinkApiupdateTRLinkCustomerPUT /screening/trlink/customers/{customerId}Update customer
TradingBetaApicreateOrderPOST /trading/ordersCreate an order
TradingBetaApicreateQuotePOST /trading/quotesCreate a quote
TradingBetaApifetchAllOffersPOST /trading/offersGet all offers
TradingBetaApifetchRatesPOST /trading/ratesGet rates
TradingBetaApigetOrderGET /trading/orders/{orderId}Get order details
TradingBetaApigetOrderRequirementsGET /trading/orders/{orderId}/requirementGet order requirement details for an order
TradingBetaApigetOrdersGET /trading/ordersGet orders
TradingBetaApigetTradingProviderByIdGET /trading/providers/{providerId}Get trading provider by ID
TradingBetaApigetTradingProvidersGET /trading/providersGet providers
TradingBetaApisubmitOrderRequirementsPOST /trading/orders/{orderId}/requirement/dataSubmit a response to an order requirement
TradingBetaApiuploadOrderRequirementFilePOST /trading/orders/{orderId}/requirement/fileUpload a file for an order requirement
TransactionsApicancelTransactionPOST /transactions/{txId}/cancelCancel a transaction
TransactionsApicreateTransactionPOST /transactionsCreate a new transaction
TransactionsApidropTransactionPOST /transactions/{txId}/dropDrop ETH (EVM) transaction by ID
TransactionsApiestimateNetworkFeeGET /estimate_network_feeEstimate the required fee for an asset
TransactionsApiestimateTransactionFeePOST /transactions/estimate_feeEstimate transaction fee
TransactionsApifreezeTransactionPOST /transactions/{txId}/freezeFreeze a transaction
TransactionsApigetTransactionGET /transactions/{txId}Get a specific transaction by Fireblocks transaction ID
TransactionsApigetTransactionByExternalIdGET /transactions/external_tx_id/{externalTxId}Get a specific transaction by external transaction ID
TransactionsApigetTransactionsGET /transactionsGet transaction history
TransactionsApisetConfirmationThresholdByTransactionHashPOST /txHash/{txHash}/set_confirmation_thresholdSet confirmation threshold by transaction hash
TransactionsApisetTransactionConfirmationThresholdPOST /transactions/{txId}/set_confirmation_thresholdSet confirmation threshold by Fireblocks Transaction ID
TransactionsApiunfreezeTransactionPOST /transactions/{txId}/unfreezeUnfreeze a transaction
TransactionsApivalidateAddressGET /transactions/validate_address/{assetId}/{address}Validate destination address
TravelRuleApicreateTrustProofOfAddressPOST /screening/travel_rule/providers/trust/proof_of_addressCreate Trust Network Proof of Address
TravelRuleApigetTrustProofOfAddressGET /screening/travel_rule/providers/trust/proof_of_address/{transactionId}Retrieve Trust Network Proof of Address Signature
TravelRuleApigetVASPByDIDGET /screening/travel_rule/vasp/{did}Get VASP details
TravelRuleApigetVASPsGET /screening/travel_rule/vaspGet All VASPs
TravelRuleApigetVaspForVaultGET /screening/travel_rule/vault/{vaultAccountId}/vaspGet assigned VASP to vault
TravelRuleApisetVaspForVaultPOST /screening/travel_rule/vault/{vaultAccountId}/vaspAssign VASP to vault
TravelRuleApiupdateVaspPUT /screening/travel_rule/vasp/updateAdd jsonDidKey to VASP details
TravelRuleApivalidateFullTravelRuleTransactionPOST /screening/travel_rule/transaction/validate/fullValidate Full Travel Rule Transaction
UserGroupsBetaApicreateUserGroupPOST /management/user_groupsCreate user group
UserGroupsBetaApideleteUserGroupDELETE /management/user_groups/{groupId}Delete user group
UserGroupsBetaApigetUserGroupGET /management/user_groups/{groupId}Get user group
UserGroupsBetaApigetUserGroupsGET /management/user_groupsList user groups
UserGroupsBetaApiupdateUserGroupPUT /management/user_groups/{groupId}Update user group
UsersApigetUsersGET /usersList users
UtxoManagementBetaApigetUtxosGET /utxo_management/{vaultAccountId}/{assetId}/unspent_outputsList unspent outputs (UTXOs)
UtxoManagementBetaApiupdateUtxoLabelsPATCH /utxo_management/{vaultAccountId}/{assetId}/labelsAttach or detach labels to/from UTXOs
VaultsApiactivateAssetForVaultAccountPOST /vault/accounts/{vaultAccountId}/{assetId}/activateActivate a wallet in a vault account
VaultsApiactivateUsdcGatewayWalletBetaPOST /vault/accounts/{vaultAccountId}/usdc_gateway/activateActivate a USDC Gateway wallet
VaultsApiattachOrDetachTagsFromVaultAccountsPOST /vault/accounts/attached_tagsAttach or detach tags from vault accounts
VaultsApicreateLegacyAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacyConvert a segwit address to legacy format
VaultsApicreateMultipleAccountsPOST /vault/accounts/bulkBulk creation of new vault accounts
VaultsApicreateMultipleDepositAddressesPOST /vault/accounts/addresses/bulkBulk creation of new deposit addresses
VaultsApicreateVaultAccountPOST /vault/accountsCreate a new vault account
VaultsApicreateVaultAccountAssetPOST /vault/accounts/{vaultAccountId}/{assetId}Create a new vault wallet
VaultsApicreateVaultAccountAssetAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addressesCreate new asset deposit address
VaultsApideactivateUsdcGatewayWalletBetaPOST /vault/accounts/{vaultAccountId}/usdc_gateway/deactivateDeactivate a USDC Gateway wallet
VaultsApidisableUsdcGatewayDepositAutomationScheduleBetaDELETE /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation/{automationId}Stop a USDC Gateway deposit automation's schedule
VaultsApigetAssetWalletsGET /vault/asset_walletsGet vault wallets (Paginated)
VaultsApigetCreateMultipleDepositAddressesJobStatusGET /vault/accounts/addresses/bulk/{jobId}Get the job status of the bulk deposit address creation
VaultsApigetCreateMultipleVaultAccountsJobStatusGET /vault/accounts/bulk/{jobId}Get job status of bulk creation of new vault accounts
VaultsApigetMaxBipIndexUsedGET /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_usedGet maximum BIP44 index used
VaultsApigetMaxSpendableAmountGET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amountGet max spendable amount in a transaction
VaultsApigetPagedVaultAccountsGET /vault/accounts_pagedGet vault accounts (Paginated)
VaultsApigetPublicKeyInfoGET /vault/public_key_infoGet the public key for a derivation path
VaultsApigetPublicKeyInfoForAddressGET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_infoGet an asset's public key
VaultsApigetUnspentInputsGET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputsGet UTXO unspent inputs information
VaultsApigetUsdcGatewayDepositAutomationBetaGET /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automationRead the USDC Gateway deposit automations for a vault account
VaultsApigetUsdcGatewayWalletInfoBetaGET /vault/accounts/{vaultAccountId}/usdc_gatewayGet USDC Gateway wallet info
VaultsApigetVaultAccountGET /vault/accounts/{vaultAccountId}Get a vault account by ID
VaultsApigetVaultAccountAssetGET /vault/accounts/{vaultAccountId}/{assetId}Get the asset balance for a vault account
VaultsApigetVaultAccountAssetAddressesPaginatedGET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginatedGet addresses (Paginated)
VaultsApigetVaultAssetsGET /vault/assetsGet asset balance for chosen assets
VaultsApigetVaultBalanceByAssetGET /vault/assets/{assetId}Get vault balance by an asset
VaultsApihideVaultAccountPOST /vault/accounts/{vaultAccountId}/hideHide a vault account in the console
VaultsApilookupVaultByAddressGET /vault/lookup_by_addressLook up a vault account by blockchain address
VaultsApisetCustomerRefIdForAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_idAssign AML customer reference ID
VaultsApisetUsdcGatewayDepositAutomationBetaPOST /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automationSet up a USDC Gateway deposit automation for a vault account
VaultsApisetVaultAccountAutoFuelPOST /vault/accounts/{vaultAccountId}/set_auto_fuelSet auto fueling to on or off
VaultsApisetVaultAccountCustomerRefIdPOST /vault/accounts/{vaultAccountId}/set_customer_ref_idSet an AML/KYT ID for a vault account
VaultsApiunhideVaultAccountPOST /vault/accounts/{vaultAccountId}/unhideUnhide a vault account in the console
VaultsApiupdateUsdcGatewayDepositAutomationBetaPATCH /vault/accounts/{vaultAccountId}/virtual_asset_wallet/usdc_gateway/deposit_automation/{automationId}Change a USDC Gateway deposit automation
VaultsApiupdateVaultAccountPUT /vault/accounts/{vaultAccountId}Rename a vault account
VaultsApiupdateVaultAccountAssetAddressPUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}Update address description
VaultsApiupdateVaultAccountAssetBalancePOST /vault/accounts/{vaultAccountId}/{assetId}/balanceRefresh asset balance data
Web3ConnectionsApicreatePOST /connections/wcCreate a new Web3 connection.
Web3ConnectionsApigetGET /connectionsList all open Web3 connections.
Web3ConnectionsApiremoveDELETE /connections/wc/{id}Remove an existing Web3 connection.
Web3ConnectionsApisubmitPUT /connections/wc/{id}Respond to a pending Web3 connection request.
WebhooksApiresendTransactionWebhooksPOST /webhooks/resend/{txId}Resend webhooks for a transaction by ID
WebhooksApiresendWebhooksPOST /webhooks/resendResend failed webhooks
WebhooksV2ApicreateWebhookPOST /webhooksCreate a new webhook
WebhooksV2ApideleteWebhookDELETE /webhooks/{webhookId}Delete webhook
WebhooksV2ApigetMetricsGET /webhooks/{webhookId}/metrics/{metricName}Get webhook metrics
WebhooksV2ApigetMtlsCsrGET /webhooks/mtls/csrGet mTLS CSR
WebhooksV2ApigetNotificationGET /webhooks/{webhookId}/notifications/{notificationId}Get notification by id
WebhooksV2ApigetNotificationAttemptsGET /webhooks/{webhookId}/notifications/{notificationId}/attemptsGet notification attempts
WebhooksV2ApigetNotificationsGET /webhooks/{webhookId}/notificationsGet all notifications by webhook id
WebhooksV2ApigetResendByQueryJobStatusGET /webhooks/{webhookId}/notifications/resend_by_query/jobs/{jobId}Get resend by query job status
WebhooksV2ApigetResendJobStatusGET /webhooks/{webhookId}/notifications/resend_failed/jobs/{jobId}Get resend job status
WebhooksV2ApigetWebhookGET /webhooks/{webhookId}Get webhook by id
WebhooksV2ApigetWebhooksGET /webhooksGet all webhooks
WebhooksV2ApiresendFailedNotificationsPOST /webhooks/{webhookId}/notifications/resend_failedResend failed notifications
WebhooksV2ApiresendNotificationByIdPOST /webhooks/{webhookId}/notifications/{notificationId}/resendResend notification by id
WebhooksV2ApiresendNotificationsByQueryPOST /webhooks/{webhookId}/notifications/resend_by_queryResend notifications by query
WebhooksV2ApiresendNotificationsByResourceIdPOST /webhooks/{webhookId}/notifications/resend_by_resourceResend notifications by resource Id
WebhooksV2ApiupdateWebhookPATCH /webhooks/{webhookId}Update webhook
WhitelistIpAddressesApigetWhitelistIpAddressesGET /management/api_users/{userId}/whitelist_ip_addressesGet whitelisted ip addresses for an API Key
WorkspaceApigetWorkspaceGET /workspaceGet workspace
WorkspaceStatusBetaApigetWorkspaceStatusGET /management/workspace_statusReturns current workspace status

Documentation for Models

Author

developers@fireblocks.com

About

No description, website, or topics provided.

Resources

Stars

21 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages