SDK Migration Guide

Learn how to migrate to the latest version of the Fireblocks SDK.

We've upgraded the Fireblocks SDK to enhance performance and streamline integration. To ensure uninterrupted functionality, we strongly recommend migrating to the new SDK as soon as possible. Upgrading promptly will give you access to the latest features, optimized performance, and ongoing support.

This document will help you to:

  • Understand the latest features and improvements.
  • Map changes between the old and new SDK.
  • Complete the migration to the new SDK with actionable steps.

❗️

Important:

The new SDK is being deprecated in phases, reducing its functionality and support over time. To avoid disruptions and maintain access to features and updates, developers should migrate to the new SDK.

  • February 15, 2025: Legacy SDKs enter maintenance mode.
    • No new API endpoints will be added.
    • Only critical bug fixes will be provided.
  • July 1, 2025: Legacy SDKs reach end-of-life (EOL).
    • No further updates, bug fixes, or support will be provided.
    • The SDK will no longer be actively maintained.
  • The new Fireblocks TS SDK does NOT include PII encryption.


Key Improvements

  • Fully Typed: Reduces runtime errors and improves code reliability.
  • Complete API Alignment: Fully consistent with the API specification.
  • Inline Guidance: Provides detailed descriptions for function arguments.
  • Code Samples: Includes practical examples for every function.
  • Comprehensive Documentation: Clear and detailed resources, including method explanations and HTTP request structures.


Key Actions for Migration:

  1. Upgrade your environment:
    1. Update your Python to 3.8 or newer for the latest Python SDK
    2. Upgrade to Node.js v16 or newer for the latest TypeScript SDK.
  2. Install the latest SDK versions:
    1. Ensure you have the latest SDK packages by checking all the relevant links for each SDK
      1. TypeScript SDK
      2. Java SDK
      3. Python SDK
  3. Update your codebase:
    1. Replace the outdated methods with the new ones here.
  4. Get support if needed:
    1. Reach out to your Customer Success Manager (CSM) or Support for any migration issues.


GitHub Repository Mapping: Old to New



SDK Mapping: JS SDK (Legacy) to New TypeScript SDK

Class Method HTTP Request Legacy Method Name New SDK Legacy SDK
ApiUserApi createApiUser POST /management/api_users createApiUser
ApiUserApi getApiUsers GET /management/api_users getApiUsers
AssetsApi createAssetsBulk POST /vault/assets/bulk createVaultAssetsBulk
AuditLogsApi getAuditLogs GET /management/audit_logs getPaginatedAuditLogs
BlockchainsAssetsApi getSupportedAssets GET /supported_assets getSupportedAssets
BlockchainsAssetsApi registerNewAsset POST /assets registerNewAsset
BlockchainsAssetsApi setAssetPrice POST /assets/prices/{id} setAssetPrice
BlockchainsAssetsBetaApi getAssetById GET /assets/{assetId} getAssetById
BlockchainsAssetsBetaApi getBlockchainById GET /blockchains/{blockchainId} getBlockchainById
BlockchainsAssetsBetaApi listAssets GET /assets listAssets
BlockchainsAssetsBetaApi listBlockchains GET /blockchains listBlockchains
ComplianceApi getAmlPostScreeningPolicy GET /screening/aml/post_screening_policy getPOSTScreeningPolicy
ComplianceApi getAmlScreeningPolicy GET /screening/aml/screening_policy getScreeningPolicy
ComplianceApi getPostScreeningPolicy GET /screening/travel_rule/post_screening_policy getPOSTScreeningPolicy
ComplianceApi getScreeningPolicy GET /screening/travel_rule/screening_policy getScreeningPolicy
ComplianceApi retryRejectedTransactionBypassScreeningChecks POST /screening/transaction/{txId}/bypass_screening_policy -
ComplianceApi updateAmlScreeningConfiguration PUT /screening/aml/policy_configuration updatePolicyConfiguration
ComplianceApi updateScreeningConfiguration PUT /screening/configurations -
ComplianceApi updateTravelRuleConfig PUT /screening/travel_rule/policy_configuration updatePolicyConfiguration
ComplianceScreeningConfigurationApi getAmlScreeningConfiguration GET /screening/aml/policy_configuration getScreeningConfiguration
ComplianceScreeningConfigurationApi getScreeningConfiguration GET /screening/travel_rule/policy_configuration getScreeningConfiguration
ConsoleUserApi createConsoleUser POST /management/users createConsoleUser
ConsoleUserApi getConsoleUsers GET /management/users getConsoleUsers
ContractInteractionsApi getDeployedContractAbi GET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions getContractAbi
ContractInteractionsApi getTransactionReceipt GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt getTransactionReceipt
ContractInteractionsApi readCallFunction POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read readContractCallFunction
ContractInteractionsApi writeCallFunction POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/write writeContractCallFunction
ContractTemplatesApi deleteContractTemplateById DELETE /tokenization/templates/{contractTemplateId} deleteContractTemplate
ContractTemplatesApi deployContract POST /tokenization/templates/{contractTemplateId}/deploy deployContract
ContractTemplatesApi getConstructorByContractTemplateId GET /tokenization/templates/{contractTemplateId}/constructor -
ContractTemplatesApi getContractTemplateById GET /tokenization/templates/{contractTemplateId} getContractTemplate
ContractTemplatesApi getContractTemplates GET /tokenization/templates getContractTemplates
ContractTemplatesApi getFunctionAbiByContractTemplateId GET /tokenization/templates/{contractTemplateId}/function -
ContractTemplatesApi uploadContractTemplate POST /tokenization/templates uploadContractTemplate
ContractsApi addContractAsset POST /contracts/{contractId}/{assetId} createContractWalletAsset
ContractsApi createContract POST /contracts createContractWallet
ContractsApi deleteContract DELETE /contracts/{contractId} deleteContractWallet
ContractsApi deleteContractAsset DELETE /contracts/{contractId}/{assetId} deleteContractWalletAsset
ContractsApi getContract GET /contracts/{contractId} getContractWallet
ContractsApi getContractAsset GET /contracts/{contractId}/{assetId} getContractWalletAsset
ContractsApi getContracts GET /contracts getContractWallets
CosignersBetaApi addCosigner POST /cosigners -
CosignersBetaApi getApiKey GET /cosigners/{cosignerId}/api_keys/{apiKeyId} -
CosignersBetaApi getApiKeys GET /cosigners/{cosignerId}/api_keys -
CosignersBetaApi getCosigner GET /cosigners/{cosignerId} -
CosignersBetaApi getCosigners GET /cosigners -
CosignersBetaApi getRequestStatus GET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} -
CosignersBetaApi pairApiKey PUT /cosigners/{cosignerId}/api_keys/{apiKeyId} -
CosignersBetaApi renameCosigner PATCH /cosigners/{cosignerId} -
CosignersBetaApi unpairApiKey DELETE /cosigners/{cosignerId}/api_keys/{apiKeyId} -
CosignersBetaApi updateCallbackHandler PATCH /cosigners/{cosignerId}/api_keys/{apiKeyId} -
DeployedContractsApi addContractABI POST /tokenization/contracts/abi saveABI
DeployedContractsApi fetchContractAbi POST /tokenization/contracts/fetch_abi fetchOrScrapeABI
DeployedContractsApi getDeployedContractByAddress GET /tokenization/contracts/{assetId}/{contractAddress} -
DeployedContractsApi getDeployedContractById GET /tokenization/contracts/{id} -
DeployedContractsApi getDeployedContracts GET /tokenization/contracts getContractsByFilter
EmbeddedWalletsApi getPublicKeyInfoForAddressNcw GET /ncw/{walletId}/accounts/{accountId}/{assetId}/{change}/{addressIndex}/public_key_info getPublicKeyInfoByAccountAsset
EmbeddedWalletsApi getPublicKeyInfoNcw GET /ncw/{walletId}/public_key_info getPublicKeyInfo
ExchangeAccountsApi convertAssets POST /exchange_accounts/{exchangeAccountId}/convert convertExchangeAsset
ExchangeAccountsApi getExchangeAccount GET /exchange_accounts/{exchangeAccountId} getExchangeAccountById
ExchangeAccountsApi getExchangeAccountAsset GET /exchange_accounts/{exchangeAccountId}/{assetId} getExchangeAsset
ExchangeAccountsApi getPagedExchangeAccounts GET /exchange_accounts/paged getExchangeAccountsPaged
ExchangeAccountsApi internalTransfer POST /exchange_accounts/{exchangeAccountId}/internal_transfer -
ExternalWalletsApi addAssetToExternalWallet POST /external_wallets/{walletId}/{assetId} createExternalWalletAsset
ExternalWalletsApi createExternalWallet POST /external_wallets createExternalWallet
ExternalWalletsApi deleteExternalWallet DELETE /external_wallets/{walletId} deleteExternalWallet
ExternalWalletsApi getExternalWallet GET /external_wallets/{walletId} getExternalWallet
ExternalWalletsApi getExternalWalletAsset GET /external_wallets/{walletId}/{assetId} getExternalWalletAsset
ExternalWalletsApi getExternalWallets GET /external_wallets getExternalWallets
ExternalWalletsApi removeAssetFromExternalWallet DELETE /external_wallets/{walletId}/{assetId} deleteExternalWalletAsset
ExternalWalletsApi setExternalWalletCustomerRefId POST /external_wallets/{walletId}/set_customer_ref_id setCustomerRefIdForExternalWallet
FiatAccountsApi depositFundsFromLinkedDDA POST /fiat_accounts/{accountId}/deposit_from_linked_dda depositFromLinkedDDA
FiatAccountsApi getFiatAccount GET /fiat_accounts/{accountId} getFiatAccountById
FiatAccountsApi getFiatAccounts GET /fiat_accounts getFiatAccounts
FiatAccountsApi redeemFundsToLinkedDDA POST /fiat_accounts/{accountId}/redeem_to_linked_dda redeemToLinkedDDA
GasStationsApi getGasStationByAssetId GET /gas_station/{assetId} getGasStationInfo
GasStationsApi getGasStationInfo GET /gas_station getGasStationInfo
GasStationsApi updateGasStationConfiguration PUT /gas_station/configuration setGasStationConfiguration
GasStationsApi updateGasStationConfigurationByAssetId PUT /gas_station/configuration/{assetId} setGasStationConfiguration
InternalWalletsApi createInternalWallet POST /internal_wallets createInternalWallet
InternalWalletsApi createInternalWalletAsset POST /internal_wallets/{walletId}/{assetId} createInternalWalletAsset
InternalWalletsApi deleteInternalWallet DELETE /internal_wallets/{walletId} deleteInternalWallet
InternalWalletsApi deleteInternalWalletAsset DELETE /internal_wallets/{walletId}/{assetId} deleteInternalWalletAsset
InternalWalletsApi getInternalWallet GET /internal_wallets/{walletId} getInternalWallet
InternalWalletsApi getInternalWalletAsset GET /internal_wallets/{walletId}/{assetId} getInternalWalletAsset
InternalWalletsApi getInternalWallets GET /internal_wallets getInternalWallets
InternalWalletsApi setCustomerRefIdForInternalWallet POST /internal_wallets/{walletId}/set_customer_ref_id setCustomerRefIdForInternalWallet
JobManagementApi cancelJob POST /batch/{jobId}/cancel cancelJob
JobManagementApi continueJob POST /batch/{jobId}/continue continueJob
JobManagementApi getJob GET /batch/{jobId} getJobById
JobManagementApi getJobTasks GET /batch/{jobId}/tasks getTasksByJobId
JobManagementApi getJobs GET /batch/jobs getJobsForTenant
JobManagementApi pauseJob POST /batch/{jobId}/pause pauseJob
KeyLinkBetaApi createSigningKey POST /key_link/signing_keys -
KeyLinkBetaApi createValidationKey POST /key_link/validation_keys -
KeyLinkBetaApi disableValidationKey PATCH /key_link/validation_keys/{keyId} -
KeyLinkBetaApi getSigningKey GET /key_link/signing_keys/{keyId} -
KeyLinkBetaApi getSigningKeysList GET /key_link/signing_keys -
KeyLinkBetaApi getValidationKey GET /key_link/validation_keys/{keyId} -
KeyLinkBetaApi getValidationKeysList GET /key_link/validation_keys -
KeyLinkBetaApi setAgentId PATCH /key_link/signing_keys/{keyId}/agent_user_id -
KeyLinkBetaApi updateSigningKey PATCH /key_link/signing_keys/{keyId} -
KeysBetaApi getMpcKeysList GET /keys/mpc/list -
KeysBetaApi getMpcKeysListByUser GET /keys/mpc/list/{userId} -
NFTsApi getNFT GET /nfts/tokens/{id} getNFT
NFTsApi getNFTs GET /nfts/tokens getNFTs
NFTsApi getOwnershipTokens GET /nfts/ownership/tokens getOwnedNFTs
NFTsApi listOwnedCollections GET /nfts/ownership/collections listOwnedCollections
NFTsApi listOwnedTokens GET /nfts/ownership/assets listOwnedAssets
NFTsApi refreshNFTMetadata PUT /nfts/tokens/{id} refreshNFTMetadata
NFTsApi updateOwnershipTokens PUT /nfts/ownership/tokens refreshNFTOwnershipByVault
NFTsApi updateTokenOwnershipStatus PUT /nfts/ownership/tokens/{id}/status updateNFTOwnershipStatus
NFTsApi updateTokensOwnershipSpam PUT /nfts/ownership/tokens/spam updateNFTTokenOwnershipSpamStatus
NFTsApi updateTokensOwnershipStatus PUT /nfts/ownership/tokens/status updateNFTOwnershipsStatus
NetworkConnectionsApi checkThirdPartyRouting GET /network_connections/{connectionId}/is_third_party_routing/{assetType} -
NetworkConnectionsApi createNetworkConnection POST /network_connections createNetworkConnection
NetworkConnectionsApi createNetworkId POST /network_ids createNetworkId
NetworkConnectionsApi deleteNetworkConnection DELETE /network_connections/{connectionId} removeNetworkConnection
NetworkConnectionsApi deleteNetworkId DELETE /network_ids/{networkId} deleteNetworkId
NetworkConnectionsApi getNetwork GET /network_connections/{connectionId} getNetworkConnectionById
NetworkConnectionsApi getNetworkConnections GET /network_connections getNetworkConnections
NetworkConnectionsApi getNetworkId GET /network_ids/{networkId} getNetworkId
NetworkConnectionsApi getNetworkIds GET /network_ids getDiscoverableNetworkIds
NetworkConnectionsApi getRoutingPolicyAssetGroups GET /network_ids/routing_policy_asset_groups -
NetworkConnectionsApi searchNetworkIds GET /network_ids/search -
NetworkConnectionsApi setNetworkIdDiscoverability PATCH /network_ids/{networkId}/set_discoverability setNetworkIdDiscoverability
NetworkConnectionsApi setNetworkIdName PATCH /network_ids/{networkId}/set_name setNetworkIdName
NetworkConnectionsApi setNetworkIdRoutingPolicy PATCH /network_ids/{networkId}/set_routing_policy setNetworkIdRoutingPolicy
NetworkConnectionsApi setRoutingPolicy PATCH /network_connections/{connectionId}/set_routing_policy setNetworkConnectionRoutingPolicy
OTABetaApi getOtaStatus GET /management/ota getOtaConfiguration
OTABetaApi setOtaStatus PUT /management/ota updateOtaConfiguration
OffExchangesApi addOffExchange POST /off_exchange/add addCollateral
OffExchangesApi getOffExchangeCollateralAccounts GET /off_exchange/collateral_accounts/{mainExchangeAccountId} -
OffExchangesApi getOffExchangeSettlementTransactions GET /off_exchange/settlements/transactions getSettlementTransactions
OffExchangesApi removeOffExchange POST /off_exchange/remove removeCollateral
OffExchangesApi settleOffExchangeTrades POST /off_exchange/settlements/trader settlement
PaymentsPayoutApi createPayout POST /payments/payout -
PaymentsPayoutApi executePayoutAction POST /payments/payout/{payoutId}/actions/execute -
PaymentsPayoutApi getPayout GET /payments/payout/{payoutId} -
PolicyEditorBetaApi getActivePolicy GET /tap/active_policy getActivePolicy
PolicyEditorBetaApi getDraft GET /tap/draft getDraft
PolicyEditorBetaApi publishDraft POST /tap/draft publishDraft
PolicyEditorBetaApi publishPolicyRules POST /tap/publish publishPolicyRules
PolicyEditorBetaApi updateDraft PUT /tap/draft updateDraft
ResetDeviceApi resetDevice POST /management/users/{id}/reset_device resetDeviceRequest
SmartTransferApi approveDvPTicketTerm PUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approve -
SmartTransferApi cancelTicket PUT /smart-transfers/{ticketId}/cancel cancelSmartTransferTicket
SmartTransferApi createTicket POST /smart-transfers createSmartTransferTicket
SmartTransferApi createTicketTerm POST /smart-transfers/{ticketId}/terms createSmartTransferTicketTerm
SmartTransferApi findTicketById GET /smart-transfers/{ticketId} getSmartTransferTicket
SmartTransferApi findTicketTermById GET /smart-transfers/{ticketId}/terms/{termId} getSmartTransferTicketTerms
SmartTransferApi fulfillTicket PUT /smart-transfers/{ticketId}/fulfill fulfillSmartTransferTicket
SmartTransferApi fundDvpTicket PUT /smart_transfers/{ticketId}/dvp/fund -
SmartTransferApi fundTicketTerm PUT /smart-transfers/{ticketId}/terms/{termId}/fund fundSmartTransferTicketTerm
SmartTransferApi getSmartTransferStatistic GET /smart_transfers/statistic -
SmartTransferApi getSmartTransferUserGroups GET /smart-transfers/settings/user-groups getSmartTransferTicketUserGroups
SmartTransferApi manuallyFundTicketTerm PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund manuallyFundSmartTransferTicketTerms
SmartTransferApi removeTicketTerm DELETE /smart-transfers/{ticketId}/terms/{termId} deleteSmartTransferTicketTerms
SmartTransferApi searchTickets GET /smart-transfers getSmartTransferTickets
SmartTransferApi setExternalRefId PUT /smart-transfers/{ticketId}/external-id setSmartTransferTicketExternalId
SmartTransferApi setTicketExpiration PUT /smart-transfers/{ticketId}/expires-in setSmartTransferTicketExpiresIn
SmartTransferApi setUserGroups POST /smart-transfers/settings/user-groups setSmartTransferTicketUserGroups
SmartTransferApi submitTicket PUT /smart-transfers/{ticketId}/submit submitSmartTransferTicket
SmartTransferApi updateTicketTerm PUT /smart-transfers/{ticketId}/terms/{termId} updateSmartTransferTicketTerms
StakingApi approveTermsOfServiceByProviderId POST /staking/providers/{providerId}/approveTermsOfService approveStakingProviderTermsOfService
StakingApi claimRewards POST /staking/chains/{chainDescriptor}/claim_rewards executeStakingClaimRewards
StakingApi getAllDelegations GET /staking/positions getStakingPositions
StakingApi getChainInfo GET /staking/chains/{chainDescriptor}/chainInfo getStakingChainInfo
StakingApi getChains GET /staking/chains getStakingChains
StakingApi getDelegationById GET /staking/positions/{positionId} getStakingPosition
StakingApi getProviders GET /staking/providers getStakingProviders
StakingApi getSummary GET /staking/positions/summary getStakingPositionsSummary
StakingApi getSummaryByVault GET /staking/positions/summary/vaults getStakingPositionsSummaryByVault
StakingApi split POST /staking/chains/{chainDescriptor}/split executeStakingSplit
StakingApi stake POST /staking/chains/{chainDescriptor}/stake executeStakingStake
StakingApi unstake POST /staking/chains/{chainDescriptor}/unstake executeStakingUnstake
StakingApi withdraw POST /staking/chains/{chainDescriptor}/withdraw executeStakingWithdraw
TokenizationApi burnCollectionToken POST /tokenization/collections/{collectionId}/tokens/burn burnNFT
TokenizationApi createNewCollection POST /tokenization/collections createNewCollection
TokenizationApi fetchCollectionTokenDetails GET /tokenization/collections/{collectionId}/tokens/{tokenId} getLinkedCollectionTokenDetails
TokenizationApi getCollectionById GET /tokenization/collections/{id} getLinkedCollection
TokenizationApi getLinkedCollections GET /tokenization/collections getLinkedCollections
TokenizationApi getLinkedToken GET /tokenization/tokens/{id} getLinkedToken
TokenizationApi getLinkedTokens GET /tokenization/tokens getLinkedTokens
TokenizationApi issueNewToken POST /tokenization/tokens issueNewToken
TokenizationApi link POST /tokenization/tokens/link linkToken
TokenizationApi mintCollectionToken POST /tokenization/collections/{collectionId}/tokens/mint mintNFT
TokenizationApi unlink DELETE /tokenization/tokens/{id} unlinkToken
TokenizationApi unlinkCollection DELETE /tokenization/collections/{id} unlinkCollection
TransactionsApi cancelTransaction POST /transactions/{txId}/cancel cancelTransactionById
TransactionsApi createTransaction POST /transactions createTransaction
TransactionsApi dropTransaction POST /transactions/{txId}/drop dropTransaction
TransactionsApi estimateNetworkFee GET /estimate_network_fee getFeeForAsset
TransactionsApi estimateTransactionFee POST /transactions/estimate_fee estimateFeeForTransaction
TransactionsApi freezeTransaction POST /transactions/{txId}/freeze freezeTransactionById
TransactionsApi getTransaction GET /transactions/{txId} getTransactionById
TransactionsApi getTransactionByExternalId GET /transactions/external_tx_id/{externalTxId} getTransactionByExternalTxId
TransactionsApi getTransactions GET /transactions getTransactions
TransactionsApi rescanTransactionsBeta POST /transactions/rescan rescanTransactionsBeta
TransactionsApi setConfirmationThresholdByTransactionHash POST /txHash/{txHash}/set_confirmation_threshold setConfirmationThresholdForTxHash
TransactionsApi setTransactionConfirmationThreshold POST /transactions/{txId}/set_confirmation_threshold setConfirmationThresholdForTxId
TransactionsApi unfreezeTransaction POST /transactions/{txId}/unfreeze unfreezeTransactionById
TransactionsApi validateAddress GET /transactions/validate_address/{assetId}/{address} validateAddress
TravelRuleBetaApi getVASPByDID GET /screening/travel_rule/vasp/{did} getTravelRuleVASPDetails
TravelRuleBetaApi getVASPs GET /screening/travel_rule/vasp getAllTravelRuleVASPs
TravelRuleBetaApi getVaspForVault GET /screening/travel_rule/vault/{vaultAccountId}/vasp getVaspForVault
TravelRuleBetaApi setVaspForVault POST /screening/travel_rule/vault/{vaultAccountId}/vasp setVaspForVault
TravelRuleBetaApi updateVasp PUT /screening/travel_rule/vasp/update updateVasp
TravelRuleBetaApi validateFullTravelRuleTransaction POST /screening/travel_rule/transaction/validate/full validateFullTravelRuleTransaction
TravelRuleBetaApi validateTravelRuleTransaction POST /screening/travel_rule/transaction/validate validateTravelRuleTransaction
UserGroupsBetaApi createUserGroup POST /management/user_groups createUserGroup
UserGroupsBetaApi deleteUserGroup DELETE /management/user_groups/{id} deleteUserGroup
UserGroupsBetaApi getUserGroup GET /management/user_groups/{id} getUserGroup
UserGroupsBetaApi getUserGroups GET /management/user_groups getUserGroups
UserGroupsBetaApi updateUserGroup PUT /management/user_groups/{id} updateUserGroup
UsersApi getUsers GET /users getUsers
VaultsApi activateAssetForVaultAccount POST /vault/accounts/{vaultAccountId}/{assetId}/activate activateVaultAsset
VaultsApi createLegacyAddress POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy -
VaultsApi createMultipleAccounts POST /vault/accounts/bulk createVaultAccountsBulk
VaultsApi createVaultAccount POST /vault/accounts createVaultAccount
VaultsApi createVaultAccountAsset POST /vault/accounts/{vaultAccountId}/{assetId} createVaultAsset
VaultsApi createVaultAccountAssetAddress POST /vault/accounts/{vaultAccountId}/{assetId}/addresses generateNewAddress
VaultsApi getAssetWallets GET /vault/asset_wallets getAssetWallets
VaultsApi getMaxSpendableAmount GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount getMaxSpendableAmount
VaultsApi getPagedVaultAccounts GET /vault/accounts_paged getVaultAccountsWithPageInfo
VaultsApi getPublicKeyInfo GET /vault/public_key_info getPublicKeyInfo
VaultsApi getPublicKeyInfoForAddress GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info getPublicKeyInfoForVaultAccount
VaultsApi getUnspentInputs GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs getUnspentInputs
VaultsApi getVaultAccount GET /vault/accounts/{vaultAccountId} getVaultAccountById
VaultsApi getVaultAccountAsset GET /vault/accounts/{vaultAccountId}/{assetId} getVaultAccountAsset
VaultsApi getVaultAccountAssetAddressesPaginated GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated getPaginatedAddresses
VaultsApi getVaultAssets GET /vault/assets getVaultAssetsBalance
VaultsApi getVaultBalanceByAsset GET /vault/assets/{assetId} getVaultBalanceByAsset
VaultsApi hideVaultAccount POST /vault/accounts/{vaultAccountId}/hide hideVaultAccount
VaultsApi setCustomerRefIdForAddress POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id setCustomerRefIdForAddress
VaultsApi setVaultAccountAutoFuel POST /vault/accounts/{vaultAccountId}/set_auto_fuel setAutoFuel
VaultsApi setVaultAccountCustomerRefId POST /vault/accounts/{vaultAccountId}/set_customer_ref_id setCustomerRefIdForVaultAccount
VaultsApi unhideVaultAccount POST /vault/accounts/{vaultAccountId}/unhide unhideVaultAccount
VaultsApi updateVaultAccount PUT /vault/accounts/{vaultAccountId} updateVaultAccount
VaultsApi updateVaultAccountAssetAddress PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} setAddressDescription
VaultsApi updateVaultAccountAssetBalance POST /vault/accounts/{vaultAccountId}/{assetId}/balance refreshVaultAssetBalance
Web3ConnectionsApi create POST /connections/wc createWeb3Connection
Web3ConnectionsApi get GET /connections getWeb3Connections
Web3ConnectionsApi remove DELETE /connections/wc/{id} -
Web3ConnectionsApi submit PUT /connections/wc/{id} -
WebhooksApi resendTransactionWebhooks POST /webhooks/resend/{txId} resendTransactionWebhooksById
WebhooksApi resendWebhooks POST /webhooks/resend resendWebhooks
WebhooksV2BetaApi createWebhook POST /webhooks -
WebhooksV2BetaApi deleteWebhook DELETE /webhooks/{webhookId} -
WebhooksV2BetaApi getNotification GET /webhooks/{webhookId}/notifications/{notificationId} -
WebhooksV2BetaApi getNotifications GET /webhooks/{webhookId}/notifications -
WebhooksV2BetaApi getWebhook GET /webhooks/{webhookId} -
WebhooksV2BetaApi getWebhooks GET /webhooks -
WebhooksV2BetaApi updateWebhook PATCH /webhooks/{webhookId} -
WhitelistIpAddressesApi getWhitelistIpAddresses GET /management/api_users/{userId}/whitelist_ip_addresses getWhitelistedAddresses
WorkspaceStatusBetaApi getWorkspaceStatus GET /management/workspace_status -
- - GET /vault/accounts/{vaultAccountId}/{assetId}/addresses getDepositAddresses
- - GET /exchange_accounts getExchangeAccounts
- - POST /exchange_accounts/{exchangeAccountId}/{assetId}/transfer_to_subaccount transferToSubaccount
- - POST /exchange_accounts/{exchangeAccountId}/{assetId}/transfer_from_subaccount transferFromSubaccount
- - GET /transactions getTransactionsWithPageInfo
- - POST /vault/accounts/{vaultAccountId}/{asset}/lock_allocation allocateFundsToPrivateLedger
- - POST /vault/accounts/{vaultAccountId}/{asset}/release_allocation deallocateFundsFromPrivateLedger
- - GET /vault/accounts/{vaultAccountId}/{assetId}/max_bip44_index_used getMaxBip44IndexUsed
- - GET /off_exchange_accounts getOffExchangeAccounts
- - GET /off_exchange_accounts/{id} getOffExchangeAccountById
- - POST /off_exchange_accounts/{id}/settle settleOffExchangeAccountById
- - POST /fee_payer/{baseAsset} setFeePayerConfiguration
- - GET /fee_payer/{baseAsset} getFeePayerConfiguration
- - DELETE /fee_payer/{baseAsset} removeFeePayerConfiguration
- - PUT /connections/wc/{sessionId} submitWeb3Connection
- - DELETE /connections/wc/{sessionId} removeWeb3Connection
- - GET /audits getAudits
- - GET /tokenization/templates/{contractTemplateId}/deploy_function getContractTemplateDeployFunction
- - GET /tokenization/templates/{contractTemplateId}/supported_blockchains getSupportedBlockchains
- - GET /contract-service/contract/{contractId}/function getContractAbiFunction
- - GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash} getContractAddress
- - GET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress} getContractByAddress
- - GET /tokenization/tokens/count getLinkedTokensCount
- - POST /tokenization/tokens/link linkContractByAddress
- - GET /tokenization/tokens getPendingLinkedTokens
- - PUT /screening/travel-rule/vasp/update updateVasp
- - PUT /screening/config updateTenantScreeningConfiguration
- - GET /screening/supported_assets/{provider} getSupportedAssetsForScreening
- - POST /staking/chains/{chainDescriptor}/claimRewards executeStakingClaimRewards
- - GET /ncw/wallets/supported_assets getSupportedAssets
- - POST /ncw/wallets createWallet
- - GET /ncw/wallets/{walletId} getWallet
- - GET /ncw/wallets/{walletId}/backup/latest getLatestBackup
- - PUT /ncw/wallets/{walletId}/enable enableWallet
- - GET /ncw/wallets/{walletId}/devices/{deviceId} getWalletDevice
- - GET /ncw/wallets/{walletId}/devices/ getWalletDevices
- - PUT /ncw/wallets/{walletId}/devices/{deviceId}/enable enableWalletDevice
- - POST /ncw/wallets/{walletId}/devices/{deviceId}/invoke invokeWalletRpc
- - POST /ncw/wallets/{walletId}/accounts createWalletAccount
- - GET /ncw/wallets getWallets
- - GET /ncw/wallets/{walletId}/accounts getWalletAccounts
- - GET /ncw/wallets/{walletId}/accounts/{accountId} getWalletAccount
- - GET /ncw/wallets/{walletId}/accounts/{accountId}/assets getWalletAssets
- - GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} getWalletAsset
- - POST /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} activateWalletAsset
- - GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses getWalletAssetAddresses
- - GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance getWalletAssetBalance
- - PUT /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance refreshWalletAssetBalance
- - GET /ncw/wallets/{walletId}/setup_status getWalletSetupStatus
- - GET /ncw/wallets/{walletId}/devices/{deviceId}/setup_status getDeviceSetupStatus
- - PATCH /ncw/wallets/{walletId}/required_algorithms setWalletRequiredAlgorithms
- - GET /ncw/{walletId}/accounts/{accountId}/{assetId}/unspent_inputs getUnspentInputs
- - DELETE /ncw/wallets/{walletId}/remove_signing_algorithm/{algorithm} deleteSigningAlgorithm



SDK Mapping: Python (Legacy) to New Python SDK

Class Method HTTP Request Legacy Method Name New SDK Legacy SDK
ApiUserApi create_api_user POST /management/api_users create_api_user
ApiUserApi get_api_users GET /management/api_users get_api_users
AssetsApi create_assets_bulk POST /vault/assets/bulk -
AuditLogsApi get_audit_logs GET /management/audit_logs get_paginated_audit_logs
BlockchainsAssetsApi get_supported_assets GET /supported_assets get_supported_assets
BlockchainsAssetsApi register_new_asset POST /assets register_new_asset
BlockchainsAssetsApi set_asset_price POST /assets/prices/{id} -
BlockchainsAssetsBetaApi get_asset_by_id GET /assets/{id} get_asset_by_id
BlockchainsAssetsBetaApi get_blockchain_by_id GET /blockchains/{id} get_blockchain_by_id
BlockchainsAssetsBetaApi list_assets GET /assets list_assets
BlockchainsAssetsBetaApi list_blockchains GET /blockchains list_blockchains
ComplianceApi get_aml_post_screening_policy GET /screening/aml/post_screening_policy -
ComplianceApi get_aml_screening_policy GET /screening/aml/screening_policy -
ComplianceApi get_post_screening_policy GET /screening/travel_rule/post_screening_policy -
ComplianceApi get_screening_full_details GET /screening/transaction/{txId} -
ComplianceApi get_screening_policy GET /screening/travel_rule/screening_policy -
ComplianceApi retry_rejected_transaction_bypass_screening_checks POST /screening/transaction/{txId}/bypass_screening_policy -
ComplianceApi update_aml_screening_configuration PUT /screening/aml/policy_configuration -
ComplianceApi update_screening_configuration PUT /screening/configurations -
ComplianceApi update_travel_rule_config PUT /screening/travel_rule/policy_configuration -
ComplianceScreeningConfigurationApi get_aml_screening_configuration GET /screening/aml/policy_configuration -
ComplianceScreeningConfigurationApi get_screening_configuration GET /screening/travel_rule/policy_configuration -
ConsoleUserApi create_console_user POST /management/users create_console_user
ConsoleUserApi get_console_users GET /management/users get_console_users
ContractInteractionsApi get_deployed_contract_abi GET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions get_contract_abi
ContractInteractionsApi get_transaction_receipt GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt -
ContractInteractionsApi read_call_function POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read read_contract_call_function
ContractInteractionsApi write_call_function POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/write write_contract_call_function
ContractsApi add_contract_asset POST /contracts/{contractId}/{assetId} create_contract_wallet_asset
ContractsApi create_contract POST /contracts create_contract_wallet
ContractsApi delete_contract_asset DELETE /contracts/{contractId}/{assetId} delete_contract_wallet_asset
ContractsApi get_contract_asset GET /contracts/{contractId}/{assetId} get_contract_wallet_asset
ContractsApi get_contracts GET /contracts get_contract_wallets
ContractTemplatesApi delete_contract_template_by_id DELETE /tokenization/templates/{contractTemplateId} delete_contract_template
ContractTemplatesApi deploy_contract POST /tokenization/templates/{contractTemplateId}/deploy deploy_contract
ContractTemplatesApi get_constructor_by_contract_template_id GET /tokenization/templates/{contractTemplateId}/constructor -
ContractTemplatesApi get_contract_template_by_id GET /tokenization/templates/{contractTemplateId} get_contract_template_deploy_function
ContractTemplatesApi get_contract_templates GET /tokenization/templates get_contract_templates
ContractTemplatesApi get_function_abi_by_contract_template_id GET /tokenization/templates/{contractTemplateId}/function -
ContractTemplatesApi upload_contract_template POST /tokenization/templates upload_contract_template
CosignersBetaApi add_cosigner POST /cosigners -
CosignersBetaApi get_request_status GET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} -
CosignersBetaApi get_api_keys GET /cosigners/{cosignerId}/api_keys -
CosignersBetaApi get_cosigners GET /cosigners -
CosignersBetaApi pair_api_key PUT /cosigners/{cosignerId}/api_keys/{apiKeyId} -
CosignersBetaApi update_callback_handler PATCH /cosigners/{cosignerId}/api_keys/{apiKeyId} -
CosignersBetaApi unpair_api_key DELETE /cosigners/{cosignerId}/api_keys/{apiKeyId} -
DeployedContractsApi add_contract_abi POST /tokenization/contracts/abi save_abi
DeployedContractsApi fetch_contract_abi POST /tokenization/contracts/fetch_abi fetch_or_scrape_abi
DeployedContractsApi get_deployed_contract_by_id GET /tokenization/contracts/{id} -
DeployedContractsApi get_deployed_contracts GET /tokenization/contracts get_contracts_by_filter
EmbeddedWalletsApi get_public_key_info_ncw GET /ncw/{walletId}/public_key_info -
ExchangeAccountsApi add_exchange_account POST /exchange_accounts -
ExchangeAccountsApi convert_assets POST /exchange_accounts/{exchangeAccountId}/convert -
ExchangeAccountsApi get_exchange_account_asset GET /exchange_accounts/{exchangeAccountId}/{assetId} get_exchange_account_asset
ExchangeAccountsApi get_exchange_accounts_credentials_public_key GET /exchange_accounts/credentials_public_key -
ExchangeAccountsApi get_paged_exchange_accounts GET /exchange_accounts/paged get_exchange_accounts_paged
ExchangeAccountsApi internal_transfer POST /exchange_accounts/{exchangeAccountId}/internal_transfer -
ExternalWalletsApi add_asset_to_external_wallet POST /external_wallets/{walletId}/{assetId} create_external_wallet_asset
ExternalWalletsApi create_external_wallet POST /external_wallets create_external_wallet
ExternalWalletsApi remove_asset_from_external_wallet DELETE /external_wallets/{walletId}/{assetId} delete_external_wallet_asset
ExternalWalletsApi get_external_wallet_asset GET /external_wallets/{walletId}/{assetId} get_external_wallet_asset
ExternalWalletsApi get_external_wallets GET /external_wallets get_external_wallets
ExternalWalletsApi set_external_wallet_customer_ref_id POST /external_wallets/{walletId}/set_customer_ref_id set_customer_ref_id_for_external_wallet
FiatAccountsApi deposit_funds_from_linked_dda POST /fiat_accounts/{accountId}/deposit_from_linked_dda deposit_from_linked_dda
FiatAccountsApi get_fiat_account GET /fiat_accounts/{accountId} get_fiat_account_by_id
FiatAccountsApi get_fiat_accounts GET /fiat_accounts get_fiat_accounts
FiatAccountsApi redeem_funds_to_linked_dda POST /fiat_accounts/{accountId}/redeem_to_linked_dda redeem_to_linked_dda
GasStationsApi get_gas_station_by_asset_id GET /gas_station/{assetId} -
GasStationsApi get_gas_station_info GET /gas_station get_gas_station_info
GasStationsApi update_gas_station_configuration PUT /gas_station/configuration set_gas_station_configuration
GasStationsApi update_gas_station_configuration_by_asset_id PUT /gas_station/configuration/{assetId} -
InternalWalletsApi create_internal_wallet POST /internal_wallets create_internal_wallet
InternalWalletsApi create_internal_wallet_asset POST /internal_wallets/{walletId}/{assetId} create_internal_wallet_asset
InternalWalletsApi delete_internal_wallet_asset DELETE /internal_wallets/{walletId}/{assetId} delete_internal_wallet_asset
InternalWalletsApi get_internal_wallet_asset GET /internal_wallets/{walletId}/{assetId} get_internal_wallet_asset
InternalWalletsApi get_internal_wallets GET /internal_wallets get_internal_wallets
InternalWalletsApi set_customer_ref_id_for_internal_wallet POST /internal_wallets/{walletId}/set_customer_ref_id set_customer_ref_id_for_internal_wallet
JobManagementApi cancel_job POST /batch/{jobId}/cancel -
JobManagementApi continue_job POST /batch/{jobId}/continue -
JobManagementApi get_job GET /batch/{jobId} -
JobManagementApi get_job_tasks GET /batch/{jobId}/tasks -
JobManagementApi get_jobs GET /batch/jobs -
JobManagementApi pause_job POST /batch/{jobId}/pause -
KeyLinkBetaApi create_signing_key POST /key_link/signing_keys -
KeyLinkBetaApi create_validation_key POST /key_link/validation_keys -
KeyLinkBetaApi disable_validation_key PATCH /key_link/validation_keys/{keyId} -
KeyLinkBetaApi get_signing_key GET /key_link/signing_keys/{keyId} -
KeyLinkBetaApi get_signing_keys_list GET /key_link/signing_keys -
KeyLinkBetaApi get_validation_key GET /key_link/validation_keys/{keyId} -
KeyLinkBetaApi get_validation_keys_list GET /key_link/validation_keys -
KeyLinkBetaApi set_agent_id PATCH /key_link/signing_keys/{keyId}/agent_user_id -
KeyLinkBetaApi update_signing_key PATCH /key_link/signing_keys/{keyId} -
KeysBetaApi get_mpc_keys_list GET /keys/mpc/list -
KeysBetaApi get_mpc_keys_list_by_user GET /keys/mpc/list/{userId} -
NetworkConnectionsApi get_network GET /network_connections/{connectionId} get_network_connection_by_id
NetworkConnectionsApi create_network_connection POST /network_connections create_network_connection
NetworkConnectionsApi create_network_id POST /network_ids create_network_id
NetworkConnectionsApi delete_network_connection DELETE /network_connections/{connectionId} remove_network_connection
NetworkConnectionsApi delete_network_id DELETE /network_ids/{networkId} delete_network_id
NetworkConnectionsApi get_network_connections GET /network_connections get_network_connections
NetworkConnectionsApi get_network_id GET /network_ids/{networkId} get_network_id
NetworkConnectionsApi get_network_ids GET /network_ids get_discoverable_network_ids
NetworkConnectionsApi get_routing_policy_asset_groups GET /network_ids/routing_policy_asset_groups -
NetworkConnectionsApi search_network_ids GET /network_ids/search -
NetworkConnectionsApi set_network_id_discoverability PATCH /network_ids/{networkId}/set_discoverability set_network_id_discoverability
NetworkConnectionsApi set_network_id_name PATCH /network_ids/{networkId}/set_name set_network_id_name
NetworkConnectionsApi set_network_id_routing_policy PATCH /network_ids/{networkId}/set_routing_policy set_network_id_routing_policy
NetworkConnectionsApi set_routing_policy PATCH /network_connections/{connectionId}/set_routing_policy set_network_connection_routing_policy
NFTsApi get_nft GET /nfts/tokens/{id} -
NFTsApi get_nfts GET /nfts/tokens get_nfts
NFTsApi get_ownership_tokens GET /nfts/ownership/tokens get_owned_nfts
NFTsApi list_owned_collections GET /nfts/ownership/collections list_owned_collections
NFTsApi list_owned_tokens GET /nfts/ownership/assets list_owned_assets
NFTsApi refresh_nft_metadata PUT /nfts/tokens/{id} -
NFTsApi update_ownership_tokens PUT /nfts/ownership/tokens refresh_nft_ownership_by_vault
NFTsApi update_token_ownership_status PUT /nfts/ownership/tokens/{id}/status -
NFTsApi update_tokens_ownership_spam PUT /nfts/ownership/tokens/spam update_nft_token_ownerships_spam_status
NFTsApi update_tokens_ownership_status PUT /nfts/ownership/tokens/status update_nft_ownerships_status
OffExchangesApi add_off_exchange POST /off_exchange/add -
OffExchangesApi get_off_exchange_collateral_accounts GET /off_exchange/collateral_accounts/{mainExchangeAccountId} -
OffExchangesApi get_off_exchange_settlement_transactions GET /off_exchange/settlements/transactions -
OffExchangesApi remove_off_exchange POST /off_exchange/remove -
OffExchangesApi settle_off_exchange_trades POST /off_exchange/settlements/trader -
OTABetaApi get_ota_status GET /management/ota get_ota_configuration
OTABetaApi set_ota_status PUT /management/ota update_ota_configuration
PaymentsPayoutApi create_payout POST /payments/payout -
PaymentsPayoutApi execute_payout_action POST /payments/payout/{payoutId}/actions/execute -
PaymentsPayoutApi get_payout GET /payments/payout/{payoutId} -
PolicyEditorBetaApi get_active_policy GET /tap/active_policy get_active_policy
PolicyEditorBetaApi get_draft GET /tap/draft get_draft
PolicyEditorBetaApi publish_draft POST /tap/draft publish_draft
PolicyEditorBetaApi publish_policy_rules POST /tap/publish publish_policy_rules
PolicyEditorBetaApi update_draft PUT /tap/draft update_draft
ResetDeviceApi reset_device POST /management/users/{id}/reset_device reset_device_request
SmartTransferApi approve_dv_p_ticket_term PUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approve -
SmartTransferApi cancel_ticket PUT /smart-transfers/{ticketId}/cancel cancel_smart_transfer_ticket
SmartTransferApi create_ticket POST /smart-transfers create_smart_transfer_ticket
SmartTransferApi create_ticket_term POST /smart-transfers/{ticketId}/terms create_smart_transfer_ticket_term
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 fulfill_smart_transfer_ticket
SmartTransferApi fund_dvp_ticket PUT /smart_transfers/{ticketId}/dvp/fund -
SmartTransferApi fund_ticket_term PUT /smart-transfers/{ticketId}/terms/{termId}/fund fund_smart_transfer_ticket_term
SmartTransferApi get_smart_transfer_statistic GET /smart_transfers/statistic -
SmartTransferApi get_smart_transfer_user_groups GET /smart-transfers/settings/user-groups get_smart_transfer_user_group_ids
SmartTransferApi manually_fund_ticket_term PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund manually_fund_smart_transfer_ticket_term
SmartTransferApi remove_ticket_term DELETE /smart-transfers/{ticketId}/terms/{termId} delete_smart_transfer_ticket_term
SmartTransferApi search_tickets GET /smart-transfers get_smart_transfer_tickets
SmartTransferApi set_external_ref_id PUT /smart-transfers/{ticketId}/external-id set_smart_transfer_ticket_external_ref_id
SmartTransferApi set_ticket_expiration PUT /smart-transfers/{ticketId}/expires-in set_smart_transfer_ticket_expires_in
SmartTransferApi set_user_groups POST /smart-transfers/settings/user-groups set_smart_transfer_user_group_ids
SmartTransferApi submit_ticket PUT /smart-transfers/{ticketId}/submit submit_smart_transfer_ticket
SmartTransferApi update_ticket_term PUT /smart-transfers/{ticketId}/terms/{termId} update_smart_transfer_ticket_term
StakingApi approve_terms_of_service_by_provider_id POST /staking/providers/{providerId}/approveTermsOfService approve_staking_provider_terms_of_service
StakingApi claim_rewards POST /staking/chains/{chainDescriptor}/claim_rewards -
StakingApi get_all_delegations GET /staking/positions get_staking_positions
StakingApi get_chain_info GET /staking/chains/{chainDescriptor}/chainInfo get_staking_chain_info
StakingApi get_chains GET /staking/chains get_staking_chains
StakingApi get_delegation_by_id GET /staking/positions/{id} get_staking_position
StakingApi get_providers GET /staking/providers get_staking_providers
StakingApi get_summary GET /staking/positions/summary get_staking_positions_summary
StakingApi get_summary_by_vault GET /staking/positions/summary/vaults get_staking_positions_summary_by_vault
StakingApi split POST /staking/chains/{chainDescriptor}/split execute_staking_split
StakingApi stake POST /staking/chains/{chainDescriptor}/stake execute_staking_stake
StakingApi unstake POST /staking/chains/{chainDescriptor}/unstake execute_staking_unstake
StakingApi withdraw POST /staking/chains/{chainDescriptor}/withdraw execute_staking_withdraw
TokenizationApi burn_collection_token POST /tokenization/collections/{id}/tokens/burn -
TokenizationApi create_new_collection POST /tokenization/collections create_new_collection
TokenizationApi get_collection_by_id GET /tokenization/collections/{id} get_linked_collection
TokenizationApi get_linked_collections GET /tokenization/collections get_linked_collections
TokenizationApi get_linked_token GET /tokenization/tokens/{id} get_linked_token
TokenizationApi get_linked_tokens GET /tokenization/tokens get_linked_tokens
TokenizationApi issue_new_token POST /tokenization/tokens issue_new_token
TokenizationApi link POST /tokenization/tokens/link link_contract_by_address
TokenizationApi mint_collection_token POST /tokenization/collections/{id}/tokens/mint -
TokenizationApi unlink DELETE /tokenization/tokens/{id} unlink_token
TokenizationApi unlink_collection DELETE /tokenization/collections/{id} unlinked_collection
TransactionsApi cancel_transaction POST /transactions/{txId}/cancel cancel_transaction_by_id
TransactionsApi create_transaction POST /transactions undefined
TransactionsApi drop_transaction POST /transactions/{txId}/drop drop_transaction
TransactionsApi estimate_network_fee GET /estimate_network_fee -
TransactionsApi estimate_transaction_fee POST /transactions/estimate_fee estimate_fee_for_transaction
TransactionsApi freeze_transaction POST /transactions/{txId}/freeze freeze_transaction_by_id
TransactionsApi get_transaction GET /transactions/{txId} get_transaction_by_id
TransactionsApi get_transaction_by_external_id GET /transactions/external_tx_id/{externalTxId} -
TransactionsApi get_transactions GET /transactions _get_transactions
TransactionsApi rescan_transactions_beta POST /transactions/rescan rescan_transactions_beta
TransactionsApi set_confirmation_threshold_by_transaction_hash POST /txHash/{txHash}/set_confirmation_threshold set_confirmation_threshold_for_txhash
TransactionsApi set_transaction_confirmation_threshold POST /transactions/{txId}/set_confirmation_threshold set_confirmation_threshold_for_txid
TransactionsApi unfreeze_transaction POST /transactions/{txId}/unfreeze unfreeze_transaction_by_id
TransactionsApi validate_address GET /transactions/validate_address/{assetId}/{address} validate_address
TravelRuleBetaApi get_vasp_for_vault GET /screening/travel_rule/vault/{vaultAccountId}/vasp -
TravelRuleBetaApi get_vaspby_did GET /screening/travel_rule/vasp/{did} -
TravelRuleBetaApi get_vasps GET /screening/travel_rule/vasp -
TravelRuleBetaApi set_vasp_for_vault POST /screening/travel_rule/vault/{vaultAccountId}/vasp -
TravelRuleBetaApi update_vasp PUT /screening/travel_rule/vasp/update -
TravelRuleBetaApi validate_full_travel_rule_transaction POST /screening/travel_rule/transaction/validate/full -
TravelRuleBetaApi validate_travel_rule_transaction POST /screening/travel_rule/transaction/validate -
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 get_user_groups
UserGroupsBetaApi update_user_group PUT /management/user_groups/{groupId} update_user_group
UsersApi get_users GET /users get_users
VaultsApi activate_asset_for_vault_account POST /vault/accounts/{vaultAccountId}/{assetId}/activate activate_vault_asset
VaultsApi create_legacy_address POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy -
VaultsApi create_multiple_accounts POST /vault/accounts/bulk -
VaultsApi create_vault_account POST /vault/accounts create_vault_account
VaultsApi create_vault_account_asset POST /vault/accounts/{vaultAccountId}/{assetId} create_vault_asset
VaultsApi create_vault_account_asset_address POST /vault/accounts/{vaultAccountId}/{assetId}/addresses generate_new_address
VaultsApi get_asset_wallets GET /vault/asset_wallets get_asset_wallets
VaultsApi get_max_spendable_amount GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount -
VaultsApi get_paged_vault_accounts GET /vault/accounts_paged get_vault_accounts_with_page_info
VaultsApi get_public_key_info GET /vault/public_key_info get_public_key_info
VaultsApi get_public_key_info_for_address GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info get_public_key_info_for_vault_account
VaultsApi get_unspent_inputs GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs get_unspent_inputs
VaultsApi get_vault_account_asset GET /vault/accounts/{vaultAccountId}/{assetId} get_max_spendable_amount
VaultsApi get_vault_account_asset_addresses_paginated GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated get_paginated_addresses
VaultsApi get_vault_assets GET /vault/assets get_vault_balance_by_asset
VaultsApi get_vault_balance_by_asset GET /vault/assets/{assetId} -
VaultsApi hide_vault_account POST /vault/accounts/{vaultAccountId}/hide hide_vault_account
VaultsApi set_vault_account_customer_ref_id POST /vault/accounts/{vaultAccountId}/set_customer_ref_id set_vault_account_customer_ref_id_for_address
VaultsApi set_vault_account_auto_fuel POST /vault/accounts/{vaultAccountId}/set_auto_fuel set_auto_fuel
VaultsApi unhide_vault_account POST /vault/accounts/{vaultAccountId}/unhide unhide_vault_account
VaultsApi update_vault_account_asset_address PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} update_vault_account
VaultsApi update_vault_account_asset_balance POST /vault/accounts/{vaultAccountId}/{assetId}/balance refresh_vault_asset_balance
Web3ConnectionsApi create POST /connections/wc create_web3_connection
Web3ConnectionsApi get GET /connections get_web3_connections
Web3ConnectionsApi remove DELETE /connections/wc/{id} remove_web3_connection
Web3ConnectionsApi submit PUT /connections/wc/{id} submit_web3_connection
WebhooksApi resend_transaction_webhooks POST /webhooks/resend/{txId} resend_transaction_webhooks_by_id
WebhooksApi resend_webhooks POST /webhooks/resend resend_webhooks
WebhooksV2BetaApi create_webhook POST /webhooks -
WebhooksV2BetaApi delete_webhook DELETE /webhooks/{webhookId} -
WebhooksV2BetaApi get_webhook GET /webhooks/{webhookId} -
WebhooksV2BetaApi get_notifications GET /webhooks/{webhookId}/notifications -
WebhooksV2BetaApi get_webhooks GET /webhooks -
WebhooksV2BetaApi update_webhook PATCH /webhooks/{webhookId} -
WhitelistIpAddressesApi get_whitelist_ip_addresses GET /management/api_users/{userId}/whitelist_ip_addresses get_whitelisted_ip_addresses
WorkspaceStatusBetaApi get_workspace_status GET /management/workspace_status -
- - POST /staking/chains/{chain_descriptor}/claimRewards execute_staking_claim_rewards
- - GET /nfts/tokens/ get_nft
- - PUT /nfts/tokens/ refresh_nft_metadata
- - PUT /nfts/ownership/tokens/ update_nft_ownership_status
- - POST /assets/prices/${id} set_asset_price
- - GET /vault/accounts/{vault_account_id}/{asset_id}/addresses get_deposit_addresses
- - GET /exchange_accounts get_exchange_accounts
- - POST /exchange_accounts/{exchange_account_id}/{asset_id}/transfer_to_subaccount transfer_to_subaccount
- - POST /exchange_accounts/{exchange_account_id}/{asset_id}/transfer_from_subaccount transfer_from_subaccount
- - GET /estimate_network_fee?assetId={asset_id} get_fee_for_asset
- - GET /transfer_tickets get_transfer_tickets
- - POST /transfer_tickets create_transfer_ticket
- - GET /transfer_tickets/{ticket_id}/{term_id} get_transfer_ticket_term
- - POST /transfer_tickets/{ticket_id}/cancel cancel_transfer_ticket
- - POST /transfer_tickets/{ticket_id}/{term_id}/transfer execute_ticket_term
- - POST /vault/accounts/{vault_account_id}/{asset}/lock_allocation allocate_funds_to_private_ledger
- - POST /vault/accounts/{vault_account_id}/{asset}/release_allocation deallocate_funds_from_private_ledger
- - GET /vault/accounts/{vault_account_id}/{asset_id}/max_bip44_index_used get_max_bip44_index_used
- - GET /off_exchange_accounts get_off_exchanges
- - GET /audits get_audit_logs
- - GET /off_exchange_accounts/{off_exchange_id} get_off_exchange_by_id
- - POST /off_exchanges/{off_exchange_id}/settle settle_off_exchange_by_id
- - POST /fee_payer/{base_asset} set_fee_payer_configuration
- - GET /fee_payer/{base_asset} get_fee_payer_configuration
- - DELETE /fee_payer/{base_asset} remove_fee_payer_configuration
- - GET /tokenization/tokens/count get_linked_tokens_count
- - POST /tokenization/collections/tokens/mint mint_nft
- - POST /tokenization/collections/tokens/burn burn_nft
- - GET /tokenization/templates/{template_id}/supported_blockchains get_contract_template_supported_blockchains
- - GET /contract_interactions/base_asset_id/{base_asset_id}/contract_address/{contract_address} get_contract_by_address



FAQs

Why is the current SDK being deprecated? The legacy SDK is being phased out to provide a more reliable, efficient and developer-friendly experience with our new SDK. The new version is fully typed, better aligned with our API, and includes improved documentation and inline guidance.
Can I continue using the legacy SDK after July 1, 2025? Yes, but we strongly advise against it. The SDK will no longer be maintained, meaning security risks, compatibility issues, and lack of support may impact your application.
Which programming languages are supported in the new SDK? We offer SDKs for:
  • TypeScript
  • Python
  • Java
Developers using other languages should directly integrate with our API.
What happens if I don’t migrate before July 1, 2025? If you continue using the legacy SDK:
  • It will no longer receive updates or bug fixes.
  • Security vulnerabilities may arise over time.
  • New API endpoints and features will not be available.
  • Fireblocks support will no longer assist with issues related to the legacy SDK.
Will Fireblocks provide extended support for the legacy SDK? No, there will be no extended support after July 1, 2025. To avoid disruptions, migrate as soon as possible.