Official Fireblocks TypeScript SDK


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

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

Installation

To use the Fireblocks SDK, follow these steps:

Install the SDK using npm:

``shell
npm install @fireblocks/ts-sdk
`

Usage

$3

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:
`bash
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 code to initialize the Fireblocks SDK:
`typescript
import { Fireblocks } from "@fireblocks/ts-sdk";

// Create a Fireblocks API instance
const fireblocks = new Fireblocks();

`

Providing Local Variables

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

`typescript
import { readFileSync } from 'fs';
import { Fireblocks, BasePath } from "@fireblocks/ts-sdk";

const FIREBLOCKS_API_SECRET_PATH = "./fireblocks_secret.key";

// Initialize a Fireblocks API instance with local variables
const fireblocks = new Fireblocks({
apiKey: "my-api-key",
basePath: BasePath.Sandbox, // or assign directly to "https://sandbox-api.fireblocks.io/v1";
secretKey: readFileSync(FIREBLOCKS_API_SECRET_PATH, "utf8"),
});
`




Basic Api Examples

Creating a Vault Account

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

`typescript
async function createVault() {
try {
const vault = await fireblocks.vaults.createVaultAccount({
createVaultAccountRequest: {
name: 'My First Vault Account',
hiddenOnUI: false,
autoFuel: false
}
});
return vault;
} catch (e) {
console.log(e);
}
}
`

Retrieving Vault Accounts

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

`typescript
async function getVaultPagedAccounts(limit) {
try {
const vaults = await fireblocks.vaults.getPagedVaultAccounts({
limit
});
return vaults;
} catch (e) {
console.log(e);
}
}

`

Creating a Transaction

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

`typescript
import { TransferPeerPathType } from "@fireblocks/ts-sdk";

async function createTransaction(assetId, amount, srcId, destId) {
let payload = {
assetId,
amount,
source: {
type: TransferPeerPathType.VaultAccount,
id: String(srcId)
},
destination: {
type: TransferPeerPathType.VaultAccount,
id: String(destId)
},
note: "Your first transaction!"
};
const result = await fireblocks.transactions.createTransaction({ transactionRequest: payload });
console.log(JSON.stringify(result, null, 2));
}
``

Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
ApiUserApi | createApiUser | POST /management/api_users | Create API Key
ApiUserApi | getApiUsers | GET /management/api_users | Get API Keys
AuditLogsApi | getAuditLogs | GET /management/audit_logs | Get audit logs
BlockchainsAssetsApi | getAsset | GET /assets/{id} | Get an asset
BlockchainsAssetsApi | getBlockchain | GET /blockchains/{id} | Get a Blockchain by ID
BlockchainsAssetsApi | getSupportedAssets | GET /supported_assets | List assets (Legacy)
BlockchainsAssetsApi | listAssets | GET /assets | List assets
BlockchainsAssetsApi | listBlockchains | GET /blockchains | List blockchains
BlockchainsAssetsApi | registerNewAsset | POST /assets | Register an asset
BlockchainsAssetsApi | setAssetPrice | POST /assets/prices/{id} | Set asset price
BlockchainsAssetsApi | updateAssetUserMetadata | PATCH /assets/{id} | Update the user’s metadata for an asset
ComplianceApi | getAmlPostScreeningPolicy | GET /screening/aml/post_screening_policy | AML - View Post-Screening Policy
ComplianceApi | getAmlScreeningPolicy | GET /screening/aml/screening_policy | AML - View Screening Policy
ComplianceApi | getPostScreeningPolicy | GET /screening/travel_rule/post_screening_policy | Travel Rule - View Post-Screening Policy
ComplianceApi | getScreeningFullDetails | GET /screening/transaction/{txId} | Provides all the compliance details for the given screened transaction.
ComplianceApi | getScreeningPolicy | GET /screening/travel_rule/screening_policy | Travel Rule - View Screening Policy
ComplianceApi | retryRejectedTransactionBypassScreeningChecks | POST /screening/transaction/{txId}/bypass_screening_policy | Calling the \"Bypass Screening Policy\" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
ComplianceApi | setAmlVerdict | POST /screening/aml/verdict/manual | Set AML Verdict for Manual Screening Verdict.
ComplianceApi | updateAmlScreeningConfiguration | PUT /screening/aml/policy_configuration | Update AML Configuration
ComplianceApi | updateScreeningConfiguration | PUT /screening/configurations | Tenant - Screening Configuration
ComplianceApi | updateTravelRuleConfig | PUT /screening/travel_rule/policy_configuration | Update Travel Rule Configuration
ComplianceScreeningConfigurationApi | getAmlScreeningConfiguration | GET /screening/aml/policy_configuration | Get AML Screening Policy Configuration
ComplianceScreeningConfigurationApi | getScreeningConfiguration | GET /screening/travel_rule/policy_configuration | Get Travel Rule Screening Policy Configuration
ConnectedAccountsBetaApi | disconnectConnectedAccount | DELETE /connected_accounts/{accountId} | Disconnect connected account
ConnectedAccountsBetaApi | getConnectedAccount | GET /connected_accounts/{accountId} | Get connected account
ConnectedAccountsBetaApi | getConnectedAccountBalances | GET /connected_accounts/{accountId}/balances | Get balances for an account
ConnectedAccountsBetaApi | getConnectedAccountRates | GET /connected_accounts/{accountId}/rates | Get exchange rates for an account
ConnectedAccountsBetaApi | getConnectedAccountTradingPairs | GET /connected_accounts/{accountId}/manifest/capabilities/trading/pairs | Get supported trading pairs for an account
ConnectedAccountsBetaApi | getConnectedAccounts | GET /connected_accounts | Get connected accounts
ConnectedAccountsBetaApi | renameConnectedAccount | POST /connected_accounts/{accountId}/rename | Rename Connected Account
ConsoleUserApi | createConsoleUser | POST /management/users | Create console user
ConsoleUserApi | getConsoleUsers | GET /management/users | Get console users
ContractInteractionsApi | decodeContractData | POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decode | Decode a function call data, error, or event log
ContractInteractionsApi | getContractAddress | GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash} | Get contract address by transaction hash
ContractInteractionsApi | getDeployedContractAbi | GET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions | Return deployed contract\'s ABI
ContractInteractionsApi | getTransactionReceipt | GET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receipt | Get transaction receipt
ContractInteractionsApi | readCallFunction | POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/read | Call a read function on a deployed contract
ContractInteractionsApi | writeCallFunction | POST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/write | Call a write function on a deployed contract
ContractTemplatesApi | deleteContractTemplateById | DELETE /tokenization/templates/{contractTemplateId} | Delete a contract template by id
ContractTemplatesApi | deployContract | POST /tokenization/templates/{contractTemplateId}/deploy | Deploy contract
ContractTemplatesApi | getConstructorByContractTemplateId | GET /tokenization/templates/{contractTemplateId}/constructor | Return contract template\'s constructor
ContractTemplatesApi | getContractTemplateById | GET /tokenization/templates/{contractTemplateId} | Return contract template by id
ContractTemplatesApi | getContractTemplates | GET /tokenization/templates | List all contract templates
ContractTemplatesApi | getFunctionAbiByContractTemplateId | GET /tokenization/templates/{contractTemplateId}/function | Return contract template\'s function
ContractTemplatesApi | getSupportedBlockchainsByTemplateId | GET /tokenization/templates/{contractTemplateId}/supported_blockchains | Get supported blockchains for the template
ContractTemplatesApi | uploadContractTemplate | POST /tokenization/templates | Upload contract template
ContractsApi | addContractAsset | POST /contracts/{contractId}/{assetId} | Add an asset to a whitelisted contract
ContractsApi | createContract | POST /contracts | Add a contract
ContractsApi | deleteContract | DELETE /contracts/{contractId} | Delete a contract
ContractsApi | deleteContractAsset | DELETE /contracts/{contractId}/{assetId} | Delete an asset from a whitelisted contract
ContractsApi | getContract | GET /contracts/{contractId} | Find a Specific Whitelisted Contract
ContractsApi | getContractAsset | GET /contracts/{contractId}/{assetId} | Find a whitelisted contract\'s asset
ContractsApi | getContracts | GET /contracts | List Whitelisted Contracts
CosignersBetaApi | addCosigner | POST /cosigners | Add cosigner
CosignersBetaApi | getApiKey | GET /cosigners/{cosignerId}/api_keys/{apiKeyId} | Get API key
CosignersBetaApi | getApiKeys | GET /cosigners/{cosignerId}/api_keys | Get all API keys
CosignersBetaApi | getCosigner | GET /cosigners/{cosignerId} | Get cosigner
CosignersBetaApi | getCosigners | GET /cosigners | Get all cosigners
CosignersBetaApi | getRequestStatus | GET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId} | Get request status
CosignersBetaApi | pairApiKey | PUT /cosigners/{cosignerId}/api_keys/{apiKeyId} | Pair API key
CosignersBetaApi | renameCosigner | PATCH /cosigners/{cosignerId} | Rename cosigner
CosignersBetaApi | unpairApiKey | DELETE /cosigners/{cosignerId}/api_keys/{apiKeyId} | Unpair API key
CosignersBetaApi | updateCallbackHandler | PATCH /cosigners/{cosignerId}/api_keys/{apiKeyId} | Update API key callback handler
DeployedContractsApi | addContractABI | POST /tokenization/contracts/abi | Save contract ABI
DeployedContractsApi | fetchContractAbi | POST /tokenization/contracts/fetch_abi | Fetch the contract ABI
DeployedContractsApi | getDeployedContractByAddress | GET /tokenization/contracts/{assetId}/{contractAddress} | Return deployed contract data
DeployedContractsApi | getDeployedContractById | GET /tokenization/contracts/{id} | Return deployed contract data by id
DeployedContractsApi | getDeployedContracts | GET /tokenization/contracts | List deployed contracts data
EmbeddedWalletsApi | addEmbeddedWalletAsset | POST /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} | Add asset to account
EmbeddedWalletsApi | assignEmbeddedWallet | POST /ncw/wallets/{walletId}/assign | Assign a wallet
EmbeddedWalletsApi | createEmbeddedWallet | POST /ncw/wallets | Create a new wallet
EmbeddedWalletsApi | createEmbeddedWalletAccount | POST /ncw/wallets/{walletId}/accounts | Create a new account
EmbeddedWalletsApi | getEmbeddedWallet | GET /ncw/wallets/{walletId} | Get a wallet
EmbeddedWalletsApi | getEmbeddedWalletAccount | GET /ncw/wallets/{walletId}/accounts/{accountId} | Get a account
EmbeddedWalletsApi | getEmbeddedWalletAddresses | GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addresses | Retrieve asset addresses
EmbeddedWalletsApi | getEmbeddedWalletAsset | GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId} | Retrieve asset
EmbeddedWalletsApi | getEmbeddedWalletAssetBalance | GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance | Retrieve asset balance
EmbeddedWalletsApi | getEmbeddedWalletAssets | GET /ncw/wallets/{walletId}/accounts/{accountId}/assets | Retrieve assets
EmbeddedWalletsApi | getEmbeddedWalletDevice | GET /ncw/wallets/{walletId}/devices/{deviceId} | Get Embedded Wallet Device
EmbeddedWalletsApi | getEmbeddedWalletDeviceSetupState | GET /ncw/wallets/{walletId}/devices/{deviceId}/setup_status | Get device key setup state
EmbeddedWalletsApi | getEmbeddedWalletDevicesPaginated | GET /ncw/wallets/{walletId}/devices_paginated | Get registered devices - paginated
EmbeddedWalletsApi | getEmbeddedWalletLatestBackup | GET /ncw/wallets/{walletId}/backup/latest | Get wallet Latest Backup details
EmbeddedWalletsApi | getEmbeddedWalletPublicKeyInfoForAddress | GET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_info | Get the public key of an asset
EmbeddedWalletsApi | getEmbeddedWalletSetupStatus | GET /ncw/wallets/{walletId}/setup_status | Get wallet key setup state
EmbeddedWalletsApi | getEmbeddedWalletSupportedAssets | GET /ncw/wallets/supported_assets | Retrieve supported assets
EmbeddedWalletsApi | getEmbeddedWallets | GET /ncw/wallets | List wallets
EmbeddedWalletsApi | getPublicKeyInfoNcw | GET /ncw/wallets/{walletId}/public_key_info | Get the public key for a derivation path
EmbeddedWalletsApi | refreshEmbeddedWalletAssetBalance | PUT /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balance | Refresh asset balance
EmbeddedWalletsApi | updateEmbeddedWalletDeviceStatus | PATCH /ncw/wallets/{walletId}/devices/{deviceId}/status | Update device status
EmbeddedWalletsApi | updateEmbeddedWalletStatus | PATCH /ncw/wallets/{walletId}/status | Update wallet status
ExchangeAccountsApi | addExchangeAccount | POST /exchange_accounts | Add an exchange account
ExchangeAccountsApi | convertAssets | POST /exchange_accounts/{exchangeAccountId}/convert | Convert exchange account funds
ExchangeAccountsApi | getExchangeAccount | GET /exchange_accounts/{exchangeAccountId} | Get a specific exchange account
ExchangeAccountsApi | getExchangeAccountAsset | GET /exchange_accounts/{exchangeAccountId}/{assetId} | Get an asset for an exchange account
ExchangeAccountsApi | getExchangeAccountsCredentialsPublicKey | GET /exchange_accounts/credentials_public_key | Get public key to encrypt exchange credentials
ExchangeAccountsApi | getPagedExchangeAccounts | GET /exchange_accounts/paged | List connected exchange accounts
ExchangeAccountsApi | internalTransfer | POST /exchange_accounts/{exchangeAccountId}/internal_transfer | Internal transfer for exchange accounts
ExternalWalletsApi | addAssetToExternalWallet | POST /external_wallets/{walletId}/{assetId} | Add an asset to an external wallet.
ExternalWalletsApi | createExternalWallet | POST /external_wallets | Create an external wallet
ExternalWalletsApi | deleteExternalWallet | DELETE /external_wallets/{walletId} | Delete an external wallet
ExternalWalletsApi | getExternalWallet | GET /external_wallets/{walletId} | Find an external wallet
ExternalWalletsApi | getExternalWalletAsset | GET /external_wallets/{walletId}/{assetId} | Get an asset from an external wallet
ExternalWalletsApi | getExternalWallets | GET /external_wallets | List external wallets
ExternalWalletsApi | removeAssetFromExternalWallet | DELETE /external_wallets/{walletId}/{assetId} | Delete an asset from an external wallet
ExternalWalletsApi | setExternalWalletCustomerRefId | POST /external_wallets/{walletId}/set_customer_ref_id | Set an AML customer reference ID for an external wallet
FiatAccountsApi | depositFundsFromLinkedDDA | POST /fiat_accounts/{accountId}/deposit_from_linked_dda | Deposit funds from DDA
FiatAccountsApi | getFiatAccount | GET /fiat_accounts/{accountId} | Find a specific fiat account
FiatAccountsApi | getFiatAccounts | GET /fiat_accounts | List fiat accounts
FiatAccountsApi | redeemFundsToLinkedDDA | POST /fiat_accounts/{accountId}/redeem_to_linked_dda | Redeem funds to DDA
GasStationsApi | getGasStationByAssetId | GET /gas_station/{assetId} | Get gas station settings by asset
GasStationsApi | getGasStationInfo | GET /gas_station | Get gas station settings
GasStationsApi | updateGasStationConfiguration | PUT /gas_station/configuration | Edit gas station settings
GasStationsApi | updateGasStationConfigurationByAssetId | PUT /gas_station/configuration/{assetId} | Edit gas station settings for an asset
InternalWalletsApi | createInternalWallet | POST /internal_wallets | Create an internal wallet
InternalWalletsApi | createInternalWalletAsset | POST /internal_wallets/{walletId}/{assetId} | Add an asset to an internal wallet
InternalWalletsApi | deleteInternalWallet | DELETE /internal_wallets/{walletId} | Delete an internal wallet
InternalWalletsApi | deleteInternalWalletAsset | DELETE /internal_wallets/{walletId}/{assetId} | Delete a whitelisted address
InternalWalletsApi | getInternalWallet | GET /internal_wallets/{walletId} | Get assets for internal wallet
InternalWalletsApi | getInternalWalletAsset | GET /internal_wallets/{walletId}/{assetId} | Get an asset from an internal wallet
InternalWalletsApi | getInternalWalletAssetsPaginated | GET /internal_wallets/{walletId}/assets | List assets in an internal wallet (Paginated)
InternalWalletsApi | getInternalWallets | GET /internal_wallets | List internal wallets
InternalWalletsApi | setCustomerRefIdForInternalWallet | POST /internal_wallets/{walletId}/set_customer_ref_id | Set an AML/KYT customer reference ID for internal wallet
KeyLinkBetaApi | createSigningKey | POST /key_link/signing_keys | Add a new signing key
KeyLinkBetaApi | createValidationKey | POST /key_link/validation_keys | Add a new validation key
KeyLinkBetaApi | disableValidationKey | PATCH /key_link/validation_keys/{keyId} | Disables a validation key
KeyLinkBetaApi | getSigningKey | GET /key_link/signing_keys/{keyId} | Get a signing key by `keyId`
KeyLinkBetaApi | getSigningKeysList | GET /key_link/signing_keys | Get list of signing keys
KeyLinkBetaApi | getValidationKey | GET /key_link/validation_keys/{keyId} | Get a validation key by `keyId`
KeyLinkBetaApi | getValidationKeysList | GET /key_link/validation_keys | Get list of registered validation keys
KeyLinkBetaApi | setAgentId | PATCH /key_link/signing_keys/{keyId}/agent_user_id | Set agent user id
KeyLinkBetaApi | updateSigningKey | PATCH /key_link/signing_keys/{keyId} | Modify the signing keyId
KeysBetaApi | getMpcKeysList | GET /keys/mpc/list | Get list of mpc keys
KeysBetaApi | getMpcKeysListByUser | GET /keys/mpc/list/{userId} | Get list of mpc keys by `userId`
NFTsApi | getNFT | GET /nfts/tokens/{id} | List token data by ID
NFTsApi | getNFTs | GET /nfts/tokens | List tokens by IDs
NFTsApi | getOwnershipTokens | GET /nfts/ownership/tokens | List all owned tokens (paginated)
NFTsApi | listOwnedCollections | GET /nfts/ownership/collections | List owned collections (paginated)
NFTsApi | listOwnedTokens | GET /nfts/ownership/assets | List all distinct owned tokens (paginated)
NFTsApi | refreshNFTMetadata | PUT /nfts/tokens/{id} | Refresh token metadata
NFTsApi | updateOwnershipTokens | PUT /nfts/ownership/tokens | Refresh vault account tokens
NFTsApi | updateTokenOwnershipStatus | PUT /nfts/ownership/tokens/{id}/status | Update token ownership status
NFTsApi | updateTokensOwnershipSpam | PUT /nfts/ownership/tokens/spam | Update tokens ownership spam property
NFTsApi | updateTokensOwnershipStatus | PUT /nfts/ownership/tokens/status | Update tokens ownership status
NetworkConnectionsApi | checkThirdPartyRouting | GET /network_connections/{connectionId}/is_third_party_routing/{assetType} | Retrieve third-party network routing validation
NetworkConnectionsApi | createNetworkConnection | POST /network_connections | Create a new network connection
NetworkConnectionsApi | createNetworkId | POST /network_ids | Creates a new Network ID
NetworkConnectionsApi | deleteNetworkConnection | DELETE /network_connections/{connectionId} | Deletes a network connection by ID
NetworkConnectionsApi | deleteNetworkId | DELETE /network_ids/{networkId} | Deletes specific network ID.
NetworkConnectionsApi | getNetwork | GET /network_connections/{connectionId} | Get a network connection
NetworkConnectionsApi | getNetworkConnections | GET /network_connections | List network connections
NetworkConnectionsApi | getNetworkId | GET /network_ids/{networkId} | Returns specific network ID.
NetworkConnectionsApi | getNetworkIds | GET /network_ids | Get all network IDs
NetworkConnectionsApi | getRoutingPolicyAssetGroups | GET /network_ids/routing_policy_asset_groups | Returns all enabled routing policy asset groups
NetworkConnectionsApi | searchNetworkIds | GET /network_ids/search | Get both local IDs and discoverable remote IDs
NetworkConnectionsApi | setNetworkIdDiscoverability | PATCH /network_ids/{networkId}/set_discoverability | Update network ID\'s discoverability.
NetworkConnectionsApi | setNetworkIdName | PATCH /network_ids/{networkId}/set_name | Update network ID\'s name.
NetworkConnectionsApi | setNetworkIdRoutingPolicy | PATCH /network_ids/{networkId}/set_routing_policy | Update network id routing policy.
NetworkConnectionsApi | setRoutingPolicy | PATCH /network_connections/{connectionId}/set_routing_policy | Update network connection routing policy.
OTABetaApi | getOtaStatus | GET /management/ota | Returns current OTA status
OTABetaApi | setOtaStatus | PUT /management/ota | Enable or disable transactions to OTA
OffExchangesApi | addOffExchange | POST /off_exchange/add | Add Collateral
OffExchangesApi | getOffExchangeCollateralAccounts | GET /off_exchange/collateral_accounts/{mainExchangeAccountId} | Find a specific collateral exchange account
OffExchangesApi | getOffExchangeSettlementTransactions | GET /off_exchange/settlements/transactions | Get Settlements Transactions
OffExchangesApi | removeOffExchange | POST /off_exchange/remove | Remove Collateral
OffExchangesApi | settleOffExchangeTrades | POST /off_exchange/settlements/trader | Create Settlement for a Trader
OnchainDataApi | getAccessRegistryCurrentState | GET /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/list | Get the current state of addresses in an access registry
OnchainDataApi | getAccessRegistrySummary | GET /onchain_data/base_asset_id/{baseAssetId}/access_registry_address/{accessRegistryAddress}/summary | Summary of access registry state
OnchainDataApi | getActiveRolesForContract | GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/roles | List of active roles for a given contract address and base asset ID
OnchainDataApi | getContractBalanceHistory | GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/account_address/{accountAddress}/balance_history | Get historical balance data for a specific account in a contract
OnchainDataApi | getContractBalancesSummary | GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/summary | Get summary for the token contract
OnchainDataApi | getContractTotalSupply | GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/total_supply | Get historical total supply data for a contract
OnchainDataApi | getLatestBalancesForContract | GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/balances | Get latest balances for all addresses holding tokens from a contract
OnchainDataApi | getOnchainTransactions | GET /onchain_data/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/transactions | Fetch onchain transactions for a contract
PaymentsPayoutApi | createPayout | POST /payments/payout | Create a payout instruction set
PaymentsPayoutApi | executePayoutAction | POST /payments/payout/{payoutId}/actions/execute | Execute a payout instruction set
PaymentsPayoutApi | getPayout | GET /payments/payout/{payoutId} | Get the status of a payout instruction set
PolicyEditorBetaApi | getActivePolicyLegacy | GET /tap/active_policy | Get the active policy and its validation
PolicyEditorBetaApi | getDraftLegacy | GET /tap/draft | Get the active draft
PolicyEditorBetaApi | publishDraftLegacy | POST /tap/draft | Send publish request for a certain draft id
PolicyEditorBetaApi | publishPolicyRules | POST /tap/publish | Send publish request for a set of policy rules
PolicyEditorBetaApi | updateDraftLegacy | PUT /tap/draft | Update the draft with a new set of rules
PolicyEditorV2BetaApi | getActivePolicy | GET /policy/active_policy | Get the active policy and its validation by policy type
PolicyEditorV2BetaApi | getDraft | GET /policy/draft | Get the active draft by policy type
PolicyEditorV2BetaApi | publishDraft | POST /policy/draft | Send publish request for a certain draft id
PolicyEditorV2BetaApi | updateDraft | PUT /policy/draft | Update the draft with a new set of rules by policy types
ResetDeviceApi | resetDevice | POST /management/users/{id}/reset_device | Resets device
SmartTransferApi | approveDvPTicketTerm | PUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approve | Set funding source and approval
SmartTransferApi | cancelTicket | PUT /smart-transfers/{ticketId}/cancel | Cancel Ticket
SmartTransferApi | createTicket | POST /smart-transfers | Create Ticket
SmartTransferApi | createTicketTerm | POST /smart-transfers/{ticketId}/terms | Create leg (term)
SmartTransferApi | findTicketById | GET /smart-transfers/{ticketId} | Search Ticket by ID
SmartTransferApi | findTicketTermById | GET /smart-transfers/{ticketId}/terms/{termId} | Get Smart Transfer ticket term
SmartTransferApi | fulfillTicket | PUT /smart-transfers/{ticketId}/fulfill | Fund ticket manually
SmartTransferApi | fundDvpTicket | PUT /smart_transfers/{ticketId}/dvp/fund | Fund dvp ticket
SmartTransferApi | fundTicketTerm | PUT /smart-transfers/{ticketId}/terms/{termId}/fund | Define funding source
SmartTransferApi | getSmartTransferStatistic | GET /smart_transfers/statistic | Get smart transfers statistic
SmartTransferApi | getSmartTransferUserGroups | GET /smart-transfers/settings/user-groups | Get user group
SmartTransferApi | manuallyFundTicketTerm | PUT /smart-transfers/{ticketId}/terms/{termId}/manually-fund | Manually add term transaction
SmartTransferApi | removeTicketTerm | DELETE /smart-transfers/{ticketId}/terms/{termId} | Delete ticket leg (term)
SmartTransferApi | searchTickets | GET /smart-transfers | Find Ticket
SmartTransferApi | setExternalRefId | PUT /smart-transfers/{ticketId}/external-id | Add external ref. ID
SmartTransferApi | setTicketExpiration | PUT /smart-transfers/{ticketId}/expires-in | Set expiration
SmartTransferApi | setUserGroups | POST /smart-transfers/settings/user-groups | Set user group
SmartTransferApi | submitTicket | PUT /smart-transfers/{ticketId}/submit | Submit ticket
SmartTransferApi | updateTicketTerm | PUT /smart-transfers/{ticketId}/terms/{termId} | Update ticket leg (term)
StakingApi | approveTermsOfServiceByProviderId | POST /staking/providers/{providerId}/approveTermsOfService | Approve provider terms of service
StakingApi | claimRewards | POST /staking/chains/{chainDescriptor}/claim_rewards | Claim accrued rewards
StakingApi | getAllDelegations | GET /staking/positions | List staking positions
StakingApi | getChainInfo | GET /staking/chains/{chainDescriptor}/chainInfo | Get chain-level staking parameters
StakingApi | getChains | GET /staking/chains | List supported staking chains
StakingApi | getDelegationById | GET /staking/positions/{id} | Get position details
StakingApi | getProviders | GET /staking/providers | List staking providers
StakingApi | getSummary | GET /staking/positions/summary | Get positions summary
StakingApi | getSummaryByVault | GET /staking/positions/summary/vaults | Get positions summary by vault
StakingApi | mergeStakeAccounts | POST /staking/chains/{chainDescriptor}/merge | Merge staking positions
StakingApi | split | POST /staking/chains/{chainDescriptor}/split | Split a staking position
StakingApi | stake | POST /staking/chains/{chainDescriptor}/stake | Initiate or add to existing stake
StakingApi | unstake | POST /staking/chains/{chainDescriptor}/unstake | Initiate unstake
StakingApi | withdraw | POST /staking/chains/{chainDescriptor}/withdraw | Withdraw staked funds
TRLinkApi | assessTRLinkTravelRuleRequirement | POST /screening/trlink/customers/integration/{customerIntegrationId}/trm/assess | Assess Travel Rule requirement
TRLinkApi | cancelTRLinkTrm | POST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/cancel | Cancel Travel Rule Message
TRLinkApi | connectTRLinkIntegration | PUT /screening/trlink/customers/integration/{customerIntegrationId} | Connect customer integration
TRLinkApi | createTRLinkCustomer | POST /screening/trlink/customers | Create customer
TRLinkApi | createTRLinkIntegration | POST /screening/trlink/customers/integration | Create customer integration
TRLinkApi | createTRLinkTrm | POST /screening/trlink/customers/integration/{customerIntegrationId}/trm | Create Travel Rule Message
TRLinkApi | deleteTRLinkCustomer | DELETE /screening/trlink/customers/{customerId} | Delete customer
TRLinkApi | disconnectTRLinkIntegration | DELETE /screening/trlink/customers/integration/{customerIntegrationId} | Disconnect customer integration
TRLinkApi | getTRLinkCustomerById | GET /screening/trlink/customers/{customerId} | Get customer by ID
TRLinkApi | getTRLinkCustomerIntegrationById | GET /screening/trlink/customers/{customerId}/integrations/{customerIntegrationId} | Get customer integration by ID
TRLinkApi | getTRLinkCustomerIntegrations | GET /screening/trlink/customers/{customerId}/integrations | Get customer integrations
TRLinkApi | getTRLinkCustomers | GET /screening/trlink/customers | Get all customers
TRLinkApi | getTRLinkIntegrationPublicKey | GET /screening/trlink/customers/integration/{customerIntegrationId}/public_key | Get public key for PII encryption
TRLinkApi | getTRLinkPartners | GET /screening/trlink/partners | List available TRLink partners
TRLinkApi | getTRLinkPolicy | GET /screening/trlink/policy | Get TRLink policy
TRLinkApi | getTRLinkSupportedAsset | GET /screening/trlink/customers/integration/{customerIntegrationId}/assets/{assetId} | Get supported asset by ID
TRLinkApi | getTRLinkTrmById | GET /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId} | Get TRM by ID
TRLinkApi | getTRLinkVaspById | GET /screening/trlink/customers/integration/{customerIntegrationId}/vasps/{vaspId} | Get VASP by ID
TRLinkApi | listTRLinkSupportedAssets | GET /screening/trlink/customers/integration/{customerIntegrationId}/assets | List supported assets
TRLinkApi | listTRLinkVasps | GET /screening/trlink/customers/integration/{customerIntegrationId}/vasps | List VASPs
TRLinkApi | redirectTRLinkTrm | POST /screening/trlink/customers/integration/{customerIntegrationId}/trm/{trmId}/redirect | Redirect Travel Rule Message
TRLinkApi | setTRLinkDestinationTravelRuleMessageId | POST /screening/trlink/transaction/{txId}/destination/travel_rule_message_id | Set destination travel rule message ID
TRLinkApi | setTRLinkTransactionTravelRuleMessageId | POST /screening/trlink/transaction/{txId}/travel_rule_message_id | Set transaction travel rule message ID
TRLinkApi | testTRLinkIntegrationConnection | POST /screening/trlink/customers/integration/{customerIntegrationId}/test_connection | Test connection
TRLinkApi | updateTRLinkCustomer | PUT /screening/trlink/customers/{customerId} | Update customer
TagsApi | cancelApprovalRequest | POST /tags/approval_requests/{id}/cancel | Cancel an approval request by id
TagsApi | createTag | POST /tags | Create a new tag
TagsApi | deleteTag | DELETE /tags/{tagId} | Delete a tag
TagsApi | getApprovalRequest | GET /tags/approval_requests/{id} | Get an approval request by id
TagsApi | getTag | GET /tags/{tagId} | Get a tag
TagsApi | getTags | GET /tags | Get list of tags
TagsApi | updateTag | PATCH /tags/{tagId} | Update a tag
TokenizationApi | burnCollectionToken | POST /tokenization/collections/{id}/tokens/burn | Burn tokens
TokenizationApi | createNewCollection | POST /tokenization/collections | Create a new collection
TokenizationApi | deactivateAndUnlinkAdapters | DELETE /tokenization/multichain/bridge/layerzero | Remove LayerZero adapters
TokenizationApi | deployAndLinkAdapters | POST /tokenization/multichain/bridge/layerzero | Deploy LayerZero adapters
TokenizationApi | fetchCollectionTokenDetails | GET /tokenization/collections/{id}/tokens/{tokenId} | Get collection token details
TokenizationApi | getCollectionById | GET /tokenization/collections/{id} | Get a collection by id
TokenizationApi | getDeployableAddress | POST /tokenization/multichain/deterministic_address | Get deterministic address for contract deployment
TokenizationApi | getLayerZeroDvnConfig | GET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/dvns | Get LayerZero DVN configuration
TokenizationApi | getLayerZeroPeers | GET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/peers | Get LayerZero peers
TokenizationApi | getLinkedCollections | GET /tokenization/collections | Get collections
TokenizationApi | getLinkedToken | GET /tokenization/tokens/{id} | Return a linked token
TokenizationApi | getLinkedTokens | GET /tokenization/tokens | List all linked tokens
TokenizationApi | getLinkedTokensCount | GET /tokenization/tokens/count | Get the total count of linked tokens
TokenizationApi | issueNewToken | POST /tokenization/tokens | Issue a new token
TokenizationApi | issueTokenMultiChain | POST /tokenization/multichain/tokens | Issue a token on one or more blockchains
TokenizationApi | link | POST /tokenization/tokens/link | Link a contract
TokenizationApi | mintCollectionToken | POST /tokenization/collections/{id}/tokens/mint | Mint tokens
TokenizationApi | reIssueTokenMultiChain | POST /tokenization/multichain/reissue/token/{tokenLinkId} | Reissue a multichain token
TokenizationApi | removeLayerZeroPeers | DELETE /tokenization/multichain/bridge/layerzero/config/peers | Remove LayerZero peers
TokenizationApi | setLayerZeroDvnConfig | POST /tokenization/multichain/bridge/layerzero/config/dvns | Set LayerZero DVN configuration
TokenizationApi | setLayerZeroPeers | POST /tokenization/multichain/bridge/layerzero/config/peers | Set LayerZero peers
TokenizationApi | unlink | DELETE /tokenization/tokens/{id} | Unlink a token
TokenizationApi | unlinkCollection | DELETE /tokenization/collections/{id} | Delete a collection link
TokenizationApi | validateLayerZeroChannelConfig | GET /tokenization/multichain/bridge/layerzero/validate | Validate LayerZero channel configuration
TradingBetaApi | createOrder | POST /trading/orders | Create an order
TradingBetaApi | createQuote | POST /trading/quotes | Create a quote
TradingBetaApi | getOrder | GET /trading/orders/{orderId} | Get order details
TradingBetaApi | getOrders | GET /trading/orders | Get orders
TradingBetaApi | getTradingProviders | GET /trading/providers | Get providers
TransactionsApi | cancelTransaction | POST /transactions/{txId}/cancel | Cancel a transaction
TransactionsApi | createTransaction | POST /transactions | Create a new transaction
TransactionsApi | dropTransaction | POST /transactions/{txId}/drop | Drop ETH (EVM) transaction by ID
TransactionsApi | estimateNetworkFee | GET /estimate_network_fee | Estimate the required fee for an asset
TransactionsApi | estimateTransactionFee | POST /transactions/estimate_fee | Estimate transaction fee
TransactionsApi | freezeTransaction | POST /transactions/{txId}/freeze | Freeze a transaction
TransactionsApi | getTransaction | GET /transactions/{txId} | Get a specific transaction by Fireblocks transaction ID
TransactionsApi | getTransactionByExternalId | GET /transactions/external_tx_id/{externalTxId} | Get a specific transaction by external transaction ID
TransactionsApi | getTransactions | GET /transactions | Get transaction history
TransactionsApi | setConfirmationThresholdByTransactionHash | POST /txHash/{txHash}/set_confirmation_threshold | Set confirmation threshold by transaction hash
TransactionsApi | setTransactionConfirmationThreshold | POST /transactions/{txId}/set_confirmation_threshold | Set confirmation threshold by Fireblocks Transaction ID
TransactionsApi | unfreezeTransaction | POST /transactions/{txId}/unfreeze | Unfreeze a transaction
TransactionsApi | validateAddress | GET /transactions/validate_address/{assetId}/{address} | Validate destination address
TravelRuleApi | createTrustProofOfAddress | POST /screening/travel_rule/providers/trust/proof_of_address | Create Trust Network Proof of Address
TravelRuleApi | getTrustProofOfAddress | GET /screening/travel_rule/providers/trust/proof_of_address/{transactionId} | Retrieve Trust Network Proof of Address Signature
TravelRuleApi | getVASPByDID | GET /screening/travel_rule/vasp/{did} | Get VASP details
TravelRuleApi | getVASPs | GET /screening/travel_rule/vasp | Get All VASPs
TravelRuleApi | getVaspForVault | GET /screening/travel_rule/vault/{vaultAccountId}/vasp | Get assigned VASP to vault
TravelRuleApi | setVaspForVault | POST /screening/travel_rule/vault/{vaultAccountId}/vasp | Assign VASP to vault
TravelRuleApi | updateVasp | PUT /screening/travel_rule/vasp/update | Add jsonDidKey to VASP details
TravelRuleApi | validateFullTravelRuleTransaction | POST /screening/travel_rule/transaction/validate/full | Validate Full Travel Rule Transaction
UserGroupsBetaApi | createUserGroup | POST /management/user_groups | Create user group
UserGroupsBetaApi | deleteUserGroup | DELETE /management/user_groups/{groupId} | Delete user group
UserGroupsBetaApi | getUserGroup | GET /management/user_groups/{groupId} | Get user group
UserGroupsBetaApi | getUserGroups | GET /management/user_groups | List user groups
UserGroupsBetaApi | updateUserGroup | PUT /management/user_groups/{groupId} | Update user group
UsersApi | getUsers | GET /users | List users
VaultsApi | activateAssetForVaultAccount | POST /vault/accounts/{vaultAccountId}/{assetId}/activate | Activate a wallet in a vault account
VaultsApi | attachOrDetachTagsFromVaultAccounts | POST /vault/accounts/attached_tags | Attach or detach tags from vault accounts
VaultsApi | createLegacyAddress | POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacy | Convert a segwit address to legacy format
VaultsApi | createMultipleAccounts | POST /vault/accounts/bulk | Bulk creation of new vault accounts
VaultsApi | createMultipleDepositAddresses | POST /vault/accounts/addresses/bulk | Bulk creation of new deposit addresses
VaultsApi | createVaultAccount | POST /vault/accounts | Create a new vault account
VaultsApi | createVaultAccountAsset | POST /vault/accounts/{vaultAccountId}/{assetId} | Create a new vault wallet
VaultsApi | createVaultAccountAssetAddress | POST /vault/accounts/{vaultAccountId}/{assetId}/addresses | Create new asset deposit address
VaultsApi | getAssetWallets | GET /vault/asset_wallets | Get vault wallets (Paginated)
VaultsApi | getCreateMultipleDepositAddressesJobStatus | GET /vault/accounts/addresses/bulk/{jobId} | Get the job status of the bulk deposit address creation
VaultsApi | getCreateMultipleVaultAccountsJobStatus | GET /vault/accounts/bulk/{jobId} | Get job status of bulk creation of new vault accounts
VaultsApi | getMaxBipIndexUsed | GET /vault/accounts/{vaultAccountId}/{assetId}/max_bip_index_used | Get maximum BIP44 index used
VaultsApi | getMaxSpendableAmount | GET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amount | Get max spendable amount in a transaction
VaultsApi | getPagedVaultAccounts | GET /vault/accounts_paged | Get vault accounts (Paginated)
VaultsApi | getPublicKeyInfo | GET /vault/public_key_info | Get the public key for a derivation path
VaultsApi | getPublicKeyInfoForAddress | GET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_info | Get an asset\'s public key
VaultsApi | getUnspentInputs | GET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputs | Get UTXO unspent inputs information
VaultsApi | getVaultAccount | GET /vault/accounts/{vaultAccountId} | Get a vault account by ID
VaultsApi | getVaultAccountAsset | GET /vault/accounts/{vaultAccountId}/{assetId} | Get the asset balance for a vault account
VaultsApi | getVaultAccountAssetAddressesPaginated | GET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginated | Get addresses (Paginated)
VaultsApi | getVaultAssets | GET /vault/assets | Get asset balance for chosen assets
VaultsApi | getVaultBalanceByAsset | GET /vault/assets/{assetId} | Get vault balance by an asset
VaultsApi | hideVaultAccount | POST /vault/accounts/{vaultAccountId}/hide | Hide a vault account in the console
VaultsApi | setCustomerRefIdForAddress | POST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_id | Assign AML customer reference ID
VaultsApi | setVaultAccountAutoFuel | POST /vault/accounts/{vaultAccountId}/set_auto_fuel | Set auto fueling to on or off
VaultsApi | setVaultAccountCustomerRefId | POST /vault/accounts/{vaultAccountId}/set_customer_ref_id | Set an AML/KYT ID for a vault account
VaultsApi | unhideVaultAccount | POST /vault/accounts/{vaultAccountId}/unhide | Unhide a vault account in the console
VaultsApi | updateVaultAccount | PUT /vault/accounts/{vaultAccountId} | Rename a vault account
VaultsApi | updateVaultAccountAssetAddress | PUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId} | Update address description
VaultsApi | updateVaultAccountAssetBalance | POST /vault/accounts/{vaultAccountId}/{assetId}/balance | Refresh asset balance data
Web3ConnectionsApi | create | POST /connections/wc | Create a new Web3 connection.
Web3ConnectionsApi | get | GET /connections | List all open Web3 connections.
Web3ConnectionsApi | remove | DELETE /connections/wc/{id} | Remove an existing Web3 connection.
Web3ConnectionsApi | submit | PUT /connections/wc/{id} | Respond to a pending Web3 connection request.
WebhooksApi | resendTransactionWebhooks | POST /webhooks/resend/{txId} | Resend webhooks for a transaction by ID
WebhooksApi | resendWebhooks | POST /webhooks/resend | Resend failed webhooks
WebhooksV2Api | createWebhook | POST /webhooks | Create a new webhook
WebhooksV2Api | deleteWebhook | DELETE /webhooks/{webhookId} | Delete webhook
WebhooksV2Api | getMetrics | GET /webhooks/{webhookId}/metrics/{metricName} | Get webhook metrics
WebhooksV2Api | getNotification | GET /webhooks/{webhookId}/notifications/{notificationId} | Get notification by id
WebhooksV2Api | getNotificationAttempts | GET /webhooks/{webhookId}/notifications/{notificationId}/attempts | Get notification attempts
WebhooksV2Api | getNotifications | GET /webhooks/{webhookId}/notifications | Get all notifications by webhook id
WebhooksV2Api | [getResendJobStatus](do