Socket
Book a DemoInstallSign in
Socket

@fireblocks/ts-sdk

Package Overview
Dependencies
Maintainers
11
Versions
51
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@fireblocks/ts-sdk

OpenAPI client for @fireblocks/ts-sdk

12.0.0
latest
Source
npmnpm
Version published
Weekly downloads
14K
-8.17%
Maintainers
11
Weekly downloads
 
Created
Source

Official Fireblocks TypeScript SDK

npm version

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

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

Installation

To use the Fireblocks SDK, follow these steps:

Install the SDK using npm:

npm install @fireblocks/ts-sdk

Usage

Initializing the SDK

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

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

use bash commands to set environment variables:

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

execute the following code to initialize the Fireblocks SDK:

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:

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:

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:

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:

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/

ClassMethodHTTP requestDescription
ApiUserApicreateApiUserPOST /management/api_usersCreate Api user
ApiUserApigetApiUsersGET /management/api_usersGet Api users
AssetsApicreateAssetsBulkPOST /vault/assets/bulkBulk creation of wallets
AuditLogsApigetAuditLogsGET /management/audit_logsGet audit logs
BlockchainsAssetsApigetAssetGET /assets/{id}Get an asset
BlockchainsAssetsApigetBlockchainGET /blockchains/{id}Get an blockchain
BlockchainsAssetsApigetSupportedAssetsGET /supported_assetsList all asset types supported by Fireblocks - legacy endpoint
BlockchainsAssetsApilistAssetsGET /assetsList assets
BlockchainsAssetsApilistBlockchainsGET /blockchainsList blockchains
BlockchainsAssetsApiregisterNewAssetPOST /assetsRegister an asset
BlockchainsAssetsApisetAssetPricePOST /assets/prices/{id}Set asset price
BlockchainsAssetsApiupdateAssetUserMetadataPATCH /assets/{id}Update the user’s metadata for an asset
ComplianceApigetAmlPostScreeningPolicyGET /screening/aml/post_screening_policyAML - View Post-Screening Policy
ComplianceApigetAmlScreeningPolicyGET /screening/aml/screening_policyAML - View Screening Policy
ComplianceApigetPostScreeningPolicyGET /screening/travel_rule/post_screening_policyTravel Rule - View Post-Screening Policy
ComplianceApigetScreeningFullDetailsGET /screening/transaction/{txId}Provides all the compliance details for the given screened transaction.
ComplianceApigetScreeningPolicyGET /screening/travel_rule/screening_policyTravel Rule - View Screening Policy
ComplianceApiretryRejectedTransactionBypassScreeningChecksPOST /screening/transaction/{txId}/bypass_screening_policyCalling the "Bypass Screening Policy" API endpoint triggers a new transaction, with the API user as the initiator, bypassing the screening policy check
ComplianceApisetAmlVerdictPOST /screening/aml/verdict/manualSet AML Verdict for Manual Screening Verdict.
ComplianceApiupdateAmlScreeningConfigurationPUT /screening/aml/policy_configurationUpdate AML Configuration
ComplianceApiupdateScreeningConfigurationPUT /screening/configurationsTenant - Screening Configuration
ComplianceApiupdateTravelRuleConfigPUT /screening/travel_rule/policy_configurationUpdate Travel Rule Configuration
ComplianceScreeningConfigurationApigetAmlScreeningConfigurationGET /screening/aml/policy_configurationGet AML Screening Policy Configuration
ComplianceScreeningConfigurationApigetScreeningConfigurationGET /screening/travel_rule/policy_configurationGet Travel Rule Screening Policy Configuration
ConsoleUserApicreateConsoleUserPOST /management/usersCreate console user
ConsoleUserApigetConsoleUsersGET /management/usersGet console users
ContractInteractionsApidecodeContractDataPOST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/decodeDecode a function call data, error, or event log
ContractInteractionsApigetDeployedContractAbiGET /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functionsReturn deployed contract's ABI
ContractInteractionsApigetTransactionReceiptGET /contract_interactions/base_asset_id/{baseAssetId}/tx_hash/{txHash}/receiptGet transaction receipt
ContractInteractionsApireadCallFunctionPOST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/readCall a read function on a deployed contract
ContractInteractionsApiwriteCallFunctionPOST /contract_interactions/base_asset_id/{baseAssetId}/contract_address/{contractAddress}/functions/writeCall a write function on a deployed contract
ContractTemplatesApideleteContractTemplateByIdDELETE /tokenization/templates/{contractTemplateId}Delete a contract template by id
ContractTemplatesApideployContractPOST /tokenization/templates/{contractTemplateId}/deployDeploy contract
ContractTemplatesApigetConstructorByContractTemplateIdGET /tokenization/templates/{contractTemplateId}/constructorReturn contract template's constructor
ContractTemplatesApigetContractTemplateByIdGET /tokenization/templates/{contractTemplateId}Return contract template by id
ContractTemplatesApigetContractTemplatesGET /tokenization/templatesList all contract templates
ContractTemplatesApigetFunctionAbiByContractTemplateIdGET /tokenization/templates/{contractTemplateId}/functionReturn contract template's function
ContractTemplatesApiuploadContractTemplatePOST /tokenization/templatesUpload contract template
ContractsApiaddContractAssetPOST /contracts/{contractId}/{assetId}Add an asset to a contract
ContractsApicreateContractPOST /contractsCreate a contract
ContractsApideleteContractDELETE /contracts/{contractId}Delete a contract
ContractsApideleteContractAssetDELETE /contracts/{contractId}/{assetId}Delete a contract asset
ContractsApigetContractGET /contracts/{contractId}Find a specific contract
ContractsApigetContractAssetGET /contracts/{contractId}/{assetId}Find a contract asset
ContractsApigetContractsGET /contractsList contracts
CosignersBetaApiaddCosignerPOST /cosignersAdd cosigner
CosignersBetaApigetApiKeyGET /cosigners/{cosignerId}/api_keys/{apiKeyId}Get API key
CosignersBetaApigetApiKeysGET /cosigners/{cosignerId}/api_keysGet all API keys
CosignersBetaApigetCosignerGET /cosigners/{cosignerId}Get cosigner
CosignersBetaApigetCosignersGET /cosignersGet all cosigners
CosignersBetaApigetRequestStatusGET /cosigners/{cosignerId}/api_keys/{apiKeyId}/{requestId}Get request status
CosignersBetaApipairApiKeyPUT /cosigners/{cosignerId}/api_keys/{apiKeyId}Pair API key
CosignersBetaApirenameCosignerPATCH /cosigners/{cosignerId}Rename cosigner
CosignersBetaApiunpairApiKeyDELETE /cosigners/{cosignerId}/api_keys/{apiKeyId}Unpair API key
CosignersBetaApiupdateCallbackHandlerPATCH /cosigners/{cosignerId}/api_keys/{apiKeyId}Update API key callback handler
DeployedContractsApiaddContractABIPOST /tokenization/contracts/abiSave contract ABI
DeployedContractsApifetchContractAbiPOST /tokenization/contracts/fetch_abiFetch the contract ABI
DeployedContractsApigetDeployedContractByAddressGET /tokenization/contracts/{assetId}/{contractAddress}Return deployed contract data
DeployedContractsApigetDeployedContractByIdGET /tokenization/contracts/{id}Return deployed contract data by id
DeployedContractsApigetDeployedContractsGET /tokenization/contractsList deployed contracts data
EmbeddedWalletsApiaddEmbeddedWalletAssetPOST /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}Add asset to account
EmbeddedWalletsApicreateEmbeddedWalletPOST /ncw/walletsCreate a new wallet
EmbeddedWalletsApicreateEmbeddedWalletAccountPOST /ncw/wallets/{walletId}/accountsCreate a new account
EmbeddedWalletsApigetEmbeddedWalletGET /ncw/wallets/{walletId}Get a wallet
EmbeddedWalletsApigetEmbeddedWalletAccountGET /ncw/wallets/{walletId}/accounts/{accountId}Get a account
EmbeddedWalletsApigetEmbeddedWalletAddressesGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/addressesRetrieve asset addresses
EmbeddedWalletsApigetEmbeddedWalletAssetGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}Retrieve asset
EmbeddedWalletsApigetEmbeddedWalletAssetBalanceGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balanceRetrieve asset balance
EmbeddedWalletsApigetEmbeddedWalletDeviceGET /ncw/wallets/{walletId}/devices/{deviceId}Get Embedded Wallet Device
EmbeddedWalletsApigetEmbeddedWalletDeviceSetupStateGET /ncw/wallets/{walletId}/devices/{deviceId}/setup_statusGet device key setup state
EmbeddedWalletsApigetEmbeddedWalletLatestBackupGET /ncw/wallets/{walletId}/backup/latestGet wallet Latest Backup details
EmbeddedWalletsApigetEmbeddedWalletPublicKeyInfoForAddressGET /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/{change}/{addressIndex}/public_key_infoGet the public key of an asset
EmbeddedWalletsApigetEmbeddedWalletSupportedAssetsGET /ncw/wallets/supported_assetsRetrieve supported assets
EmbeddedWalletsApigetEmbeddedWalletsGET /ncw/walletsList wallets
EmbeddedWalletsApigetPublicKeyInfoNcwGET /ncw/wallets/{walletId}/public_key_infoGet the public key for a derivation path
EmbeddedWalletsApirefreshEmbeddedWalletAssetBalancePUT /ncw/wallets/{walletId}/accounts/{accountId}/assets/{assetId}/balanceRefresh asset balance
ExchangeAccountsApiaddExchangeAccountPOST /exchange_accountsAdd an exchange account
ExchangeAccountsApiconvertAssetsPOST /exchange_accounts/{exchangeAccountId}/convertConvert exchange account funds from the source asset to the destination asset.
ExchangeAccountsApigetExchangeAccountGET /exchange_accounts/{exchangeAccountId}Find a specific exchange account
ExchangeAccountsApigetExchangeAccountAssetGET /exchange_accounts/{exchangeAccountId}/{assetId}Find an asset for an exchange account
ExchangeAccountsApigetExchangeAccountsCredentialsPublicKeyGET /exchange_accounts/credentials_public_keyGet public key to encrypt exchange credentials
ExchangeAccountsApigetPagedExchangeAccountsGET /exchange_accounts/pagedPagination list exchange accounts
ExchangeAccountsApiinternalTransferPOST /exchange_accounts/{exchangeAccountId}/internal_transferInternal transfer for exchange accounts
ExternalWalletsApiaddAssetToExternalWalletPOST /external_wallets/{walletId}/{assetId}Add an asset to an external wallet.
ExternalWalletsApicreateExternalWalletPOST /external_walletsCreate an external wallet
ExternalWalletsApideleteExternalWalletDELETE /external_wallets/{walletId}Delete an external wallet
ExternalWalletsApigetExternalWalletGET /external_wallets/{walletId}Find an external wallet
ExternalWalletsApigetExternalWalletAssetGET /external_wallets/{walletId}/{assetId}Get an asset from an external wallet
ExternalWalletsApigetExternalWalletsGET /external_walletsList external wallets
ExternalWalletsApiremoveAssetFromExternalWalletDELETE /external_wallets/{walletId}/{assetId}Delete an asset from an external wallet
ExternalWalletsApisetExternalWalletCustomerRefIdPOST /external_wallets/{walletId}/set_customer_ref_idSet an AML customer reference ID for an external wallet
FiatAccountsApidepositFundsFromLinkedDDAPOST /fiat_accounts/{accountId}/deposit_from_linked_ddaDeposit funds from DDA
FiatAccountsApigetFiatAccountGET /fiat_accounts/{accountId}Find a specific fiat account
FiatAccountsApigetFiatAccountsGET /fiat_accountsList fiat accounts
FiatAccountsApiredeemFundsToLinkedDDAPOST /fiat_accounts/{accountId}/redeem_to_linked_ddaRedeem funds to DDA
GasStationsApigetGasStationByAssetIdGET /gas_station/{assetId}Get gas station settings by asset
GasStationsApigetGasStationInfoGET /gas_stationGet gas station settings
GasStationsApiupdateGasStationConfigurationPUT /gas_station/configurationEdit gas station settings
GasStationsApiupdateGasStationConfigurationByAssetIdPUT /gas_station/configuration/{assetId}Edit gas station settings for an asset
InternalWalletsApicreateInternalWalletPOST /internal_walletsCreate an internal wallet
InternalWalletsApicreateInternalWalletAssetPOST /internal_wallets/{walletId}/{assetId}Add an asset to an internal wallet
InternalWalletsApideleteInternalWalletDELETE /internal_wallets/{walletId}Delete an internal wallet
InternalWalletsApideleteInternalWalletAssetDELETE /internal_wallets/{walletId}/{assetId}Delete a whitelisted address
InternalWalletsApigetInternalWalletGET /internal_wallets/{walletId}Get an asset from an internal wallet
InternalWalletsApigetInternalWalletAssetGET /internal_wallets/{walletId}/{assetId}Get an asset from an internal wallet
InternalWalletsApigetInternalWalletAssetsPaginatedGET /internal_wallets/{walletId}/assetsList assets in an internal wallet (Paginated)
InternalWalletsApigetInternalWalletsGET /internal_walletsList internal wallets
InternalWalletsApisetCustomerRefIdForInternalWalletPOST /internal_wallets/{walletId}/set_customer_ref_idSet an AML/KYT customer reference ID for an internal wallet
JobManagementApicancelJobPOST /batch/{jobId}/cancelCancel a running job
JobManagementApicontinueJobPOST /batch/{jobId}/continueContinue a paused job
JobManagementApigetJobGET /batch/{jobId}Get job details
JobManagementApigetJobTasksGET /batch/{jobId}/tasksReturn a list of tasks for given job
JobManagementApigetJobsGET /batch/jobsReturn a list of jobs belonging to tenant
JobManagementApipauseJobPOST /batch/{jobId}/pausePause a job
KeyLinkBetaApicreateSigningKeyPOST /key_link/signing_keysAdd a new signing key
KeyLinkBetaApicreateValidationKeyPOST /key_link/validation_keysAdd a new validation key
KeyLinkBetaApidisableValidationKeyPATCH /key_link/validation_keys/{keyId}Disables a validation key
KeyLinkBetaApigetSigningKeyGET /key_link/signing_keys/{keyId}Get a signing key by `keyId`
KeyLinkBetaApigetSigningKeysListGET /key_link/signing_keysGet list of signing keys
KeyLinkBetaApigetValidationKeyGET /key_link/validation_keys/{keyId}Get a validation key by `keyId`
KeyLinkBetaApigetValidationKeysListGET /key_link/validation_keysGet list of registered validation keys
KeyLinkBetaApisetAgentIdPATCH /key_link/signing_keys/{keyId}/agent_user_idSet agent user id that can sign with the signing key identified by the Fireblocks provided `keyId`
KeyLinkBetaApiupdateSigningKeyPATCH /key_link/signing_keys/{keyId}Modify the signing by Fireblocks provided `keyId`
KeysBetaApigetMpcKeysListGET /keys/mpc/listGet list of mpc keys
KeysBetaApigetMpcKeysListByUserGET /keys/mpc/list/{userId}Get list of mpc keys by `userId`
NFTsApigetNFTGET /nfts/tokens/{id}List token data by ID
NFTsApigetNFTsGET /nfts/tokensList tokens by IDs
NFTsApigetOwnershipTokensGET /nfts/ownership/tokensList all owned tokens (paginated)
NFTsApilistOwnedCollectionsGET /nfts/ownership/collectionsList owned collections (paginated)
NFTsApilistOwnedTokensGET /nfts/ownership/assetsList all distinct owned tokens (paginated)
NFTsApirefreshNFTMetadataPUT /nfts/tokens/{id}Refresh token metadata
NFTsApiupdateOwnershipTokensPUT /nfts/ownership/tokensRefresh vault account tokens
NFTsApiupdateTokenOwnershipStatusPUT /nfts/ownership/tokens/{id}/statusUpdate token ownership status
NFTsApiupdateTokensOwnershipSpamPUT /nfts/ownership/tokens/spamUpdate tokens ownership spam property
NFTsApiupdateTokensOwnershipStatusPUT /nfts/ownership/tokens/statusUpdate tokens ownership status
NetworkConnectionsApicheckThirdPartyRoutingGET /network_connections/{connectionId}/is_third_party_routing/{assetType}Retrieve third-party network routing validation by asset type.
NetworkConnectionsApicreateNetworkConnectionPOST /network_connectionsCreates a new network connection
NetworkConnectionsApicreateNetworkIdPOST /network_idsCreates a new Network ID
NetworkConnectionsApideleteNetworkConnectionDELETE /network_connections/{connectionId}Deletes a network connection by ID
NetworkConnectionsApideleteNetworkIdDELETE /network_ids/{networkId}Deletes specific network ID.
NetworkConnectionsApigetNetworkGET /network_connections/{connectionId}Get a network connection
NetworkConnectionsApigetNetworkConnectionsGET /network_connectionsList network connections
NetworkConnectionsApigetNetworkIdGET /network_ids/{networkId}Returns specific network ID.
NetworkConnectionsApigetNetworkIdsGET /network_idsReturns all network IDs, both local IDs and discoverable remote IDs
NetworkConnectionsApigetRoutingPolicyAssetGroupsGET /network_ids/routing_policy_asset_groupsReturns all enabled routing policy asset groups
NetworkConnectionsApisearchNetworkIdsGET /network_ids/searchSearch network IDs, both local IDs and discoverable remote IDs
NetworkConnectionsApisetNetworkIdDiscoverabilityPATCH /network_ids/{networkId}/set_discoverabilityUpdate network ID's discoverability.
NetworkConnectionsApisetNetworkIdNamePATCH /network_ids/{networkId}/set_nameUpdate network ID's name.
NetworkConnectionsApisetNetworkIdRoutingPolicyPATCH /network_ids/{networkId}/set_routing_policyUpdate network id routing policy.
NetworkConnectionsApisetRoutingPolicyPATCH /network_connections/{connectionId}/set_routing_policyUpdate network connection routing policy.
OTABetaApigetOtaStatusGET /management/otaReturns current OTA status
OTABetaApisetOtaStatusPUT /management/otaEnable or disable transactions to OTA
OffExchangesApiaddOffExchangePOST /off_exchange/addadd collateral
OffExchangesApigetOffExchangeCollateralAccountsGET /off_exchange/collateral_accounts/{mainExchangeAccountId}Find a specific collateral exchange account
OffExchangesApigetOffExchangeSettlementTransactionsGET /off_exchange/settlements/transactionsget settlements transactions from exchange
OffExchangesApiremoveOffExchangePOST /off_exchange/removeremove collateral
OffExchangesApisettleOffExchangeTradesPOST /off_exchange/settlements/tradercreate settlement for a trader
PaymentsPayoutApicreatePayoutPOST /payments/payoutCreate a payout instruction set
PaymentsPayoutApiexecutePayoutActionPOST /payments/payout/{payoutId}/actions/executeExecute a payout instruction set
PaymentsPayoutApigetPayoutGET /payments/payout/{payoutId}Get the status of a payout instruction set
PolicyEditorBetaApigetActivePolicyLegacyGET /tap/active_policyGet the active policy and its validation
PolicyEditorBetaApigetDraftLegacyGET /tap/draftGet the active draft
PolicyEditorBetaApipublishDraftLegacyPOST /tap/draftSend publish request for a certain draft id
PolicyEditorBetaApipublishPolicyRulesPOST /tap/publishSend publish request for a set of policy rules
PolicyEditorBetaApiupdateDraftLegacyPUT /tap/draftUpdate the draft with a new set of rules
PolicyEditorV2BetaApigetActivePolicyGET /policy/active_policyGet the active policy and its validation by policy type
PolicyEditorV2BetaApigetDraftGET /policy/draftGet the active draft by policy type
PolicyEditorV2BetaApipublishDraftPOST /policy/draftSend publish request for a certain draft id
PolicyEditorV2BetaApiupdateDraftPUT /policy/draftUpdate the draft with a new set of rules by policy types
ResetDeviceApiresetDevicePOST /management/users/{id}/reset_deviceResets device
SmartTransferApiapproveDvPTicketTermPUT /smart_transfers/{ticketId}/terms/{termId}/dvp/approveDefine funding source and give approve to contract to transfer asset
SmartTransferApicancelTicketPUT /smart-transfers/{ticketId}/cancelCancel Ticket
SmartTransferApicreateTicketPOST /smart-transfersCreate Ticket
SmartTransferApicreateTicketTermPOST /smart-transfers/{ticketId}/termsCreate leg (term)
SmartTransferApifindTicketByIdGET /smart-transfers/{ticketId}Search Tickets by ID
SmartTransferApifindTicketTermByIdGET /smart-transfers/{ticketId}/terms/{termId}Search ticket by leg (term) ID
SmartTransferApifulfillTicketPUT /smart-transfers/{ticketId}/fulfillFund ticket manually
SmartTransferApifundDvpTicketPUT /smart_transfers/{ticketId}/dvp/fundFund dvp ticket
SmartTransferApifundTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}/fundDefine funding source
SmartTransferApigetSmartTransferStatisticGET /smart_transfers/statisticGet smart transfers statistic
SmartTransferApigetSmartTransferUserGroupsGET /smart-transfers/settings/user-groupsGet user group
SmartTransferApimanuallyFundTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}/manually-fundManually add term transaction
SmartTransferApiremoveTicketTermDELETE /smart-transfers/{ticketId}/terms/{termId}Delete ticket leg (term)
SmartTransferApisearchTicketsGET /smart-transfersFind Ticket
SmartTransferApisetExternalRefIdPUT /smart-transfers/{ticketId}/external-idAdd external ref. ID
SmartTransferApisetTicketExpirationPUT /smart-transfers/{ticketId}/expires-inSet expiration
SmartTransferApisetUserGroupsPOST /smart-transfers/settings/user-groupsSet user group
SmartTransferApisubmitTicketPUT /smart-transfers/{ticketId}/submitSubmit ticket
SmartTransferApiupdateTicketTermPUT /smart-transfers/{ticketId}/terms/{termId}Update ticket leg (term)
StakingApiapproveTermsOfServiceByProviderIdPOST /staking/providers/{providerId}/approveTermsOfServiceApprove staking terms of service
StakingApiclaimRewardsPOST /staking/chains/{chainDescriptor}/claim_rewardsExecute a Claim Rewards operation
StakingApigetAllDelegationsGET /staking/positionsList staking positions details
StakingApigetChainInfoGET /staking/chains/{chainDescriptor}/chainInfoGet chain-specific staking summary
StakingApigetChainsGET /staking/chainsList staking supported chains
StakingApigetDelegationByIdGET /staking/positions/{id}Get staking position details
StakingApigetProvidersGET /staking/providersList staking providers details
StakingApigetSummaryGET /staking/positions/summaryGet staking summary details
StakingApigetSummaryByVaultGET /staking/positions/summary/vaultsGet staking summary details by vault
StakingApimergeStakeAccountsPOST /staking/chains/{chainDescriptor}/mergeMerge Solana on stake accounts
StakingApisplitPOST /staking/chains/{chainDescriptor}/splitExecute a Split operation on SOL/SOL_TEST stake account
StakingApistakePOST /staking/chains/{chainDescriptor}/stakeInitiate Stake Operation
StakingApiunstakePOST /staking/chains/{chainDescriptor}/unstakeExecute an Unstake operation
StakingApiwithdrawPOST /staking/chains/{chainDescriptor}/withdrawExecute a Withdraw operation
SwapBetaApiapproveTermsOfServicePOST /swap/providers/{providerId}/approve_termsApprove terms of service
SwapBetaApicreateQuotePOST /swap/providers/{providerId}/quoteCreate a quote
SwapBetaApicreateSwapOperationPOST /swap/operationsCreate swap operation
SwapBetaApigetSwapOperationByIdGET /swap/operations/{operationId}Get operation details
SwapBetaApigetSwapOperationsGET /swap/operationsGet Operations list
SwapBetaApigetSwapProvidersGET /swap/providersGet Providers List
TagsApicreateTagPOST /tagsCreate a tag
TagsApideleteTagDELETE /tags/{tagId}Delete a tag
TagsApigetTagGET /tags/{tagId}Get a tag
TagsApigetTagsGET /tagsGet list of tags
TagsApiupdateTagPATCH /tags/{tagId}Update a tag
TokenizationApiburnCollectionTokenPOST /tokenization/collections/{id}/tokens/burnBurn tokens
TokenizationApicreateNewCollectionPOST /tokenization/collectionsCreate a new collection
TokenizationApideactivateAndUnlinkAdaptersDELETE /tokenization/multichain/bridge/layerzeroRemove LayerZero adapters
TokenizationApideployAndLinkAdaptersPOST /tokenization/multichain/bridge/layerzeroDeploy LayerZero adapters
TokenizationApifetchCollectionTokenDetailsGET /tokenization/collections/{id}/tokens/{tokenId}Get collection token details
TokenizationApigetCollectionByIdGET /tokenization/collections/{id}Get a collection by id
TokenizationApigetDeployableAddressPOST /tokenization/multichain/deterministic_addressGet deterministic address for contract deployment
TokenizationApigetLayerZeroDvnConfigGET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/dvnsGet LayerZero DVN configuration
TokenizationApigetLayerZeroPeersGET /tokenization/multichain/bridge/layerzero/config/{adapterTokenLinkId}/peersGet LayerZero peers
TokenizationApigetLinkedCollectionsGET /tokenization/collectionsGet collections
TokenizationApigetLinkedTokenGET /tokenization/tokens/{id}Return a linked token
TokenizationApigetLinkedTokensGET /tokenization/tokensList all linked tokens
TokenizationApiissueNewTokenPOST /tokenization/tokensIssue a new token
TokenizationApiissueTokenMultiChainPOST /tokenization/multichain/tokensIssue a token on one or more blockchains
TokenizationApilinkPOST /tokenization/tokens/linkLink a contract
TokenizationApimintCollectionTokenPOST /tokenization/collections/{id}/tokens/mintMint tokens
TokenizationApireIssueTokenMultiChainPOST /tokenization/multichain/reissue/token/{tokenLinkId}Reissue a multichain token
TokenizationApiremoveLayerZeroPeersDELETE /tokenization/multichain/bridge/layerzero/config/peersRemove LayerZero peers
TokenizationApisetLayerZeroDvnConfigPOST /tokenization/multichain/bridge/layerzero/config/dvnsSet LayerZero DVN configuration
TokenizationApisetLayerZeroPeersPOST /tokenization/multichain/bridge/layerzero/config/peersSet LayerZero peers
TokenizationApiunlinkDELETE /tokenization/tokens/{id}Unlink a token
TokenizationApiunlinkCollectionDELETE /tokenization/collections/{id}Delete a collection link
TokenizationApivalidateLayerZeroChannelConfigGET /tokenization/multichain/bridge/layerzero/validateValidate LayerZero channel configuration
TransactionsApicancelTransactionPOST /transactions/{txId}/cancelCancel a transaction
TransactionsApicreateTransactionPOST /transactionsCreate a new transaction
TransactionsApidropTransactionPOST /transactions/{txId}/dropDrop ETH transaction by ID
TransactionsApiestimateNetworkFeeGET /estimate_network_feeEstimate the required fee for an asset
TransactionsApiestimateTransactionFeePOST /transactions/estimate_feeEstimate transaction fee
TransactionsApifreezeTransactionPOST /transactions/{txId}/freezeFreeze a transaction
TransactionsApigetTransactionGET /transactions/{txId}Find a specific transaction by Fireblocks transaction ID
TransactionsApigetTransactionByExternalIdGET /transactions/external_tx_id/{externalTxId}Find a specific transaction by external transaction ID
TransactionsApigetTransactionsGET /transactionsList transaction history
TransactionsApirescanTransactionsBetaPOST /transactions/rescanrescan array of transactions
TransactionsApisetConfirmationThresholdByTransactionHashPOST /txHash/{txHash}/set_confirmation_thresholdSet confirmation threshold by transaction hash
TransactionsApisetTransactionConfirmationThresholdPOST /transactions/{txId}/set_confirmation_thresholdSet confirmation threshold by transaction ID
TransactionsApiunfreezeTransactionPOST /transactions/{txId}/unfreezeUnfreeze a transaction
TransactionsApivalidateAddressGET /transactions/validate_address/{assetId}/{address}Validate destination address
TravelRuleApigetVASPByDIDGET /screening/travel_rule/vasp/{did}Get VASP details
TravelRuleApigetVASPsGET /screening/travel_rule/vaspGet All VASPs
TravelRuleApigetVaspForVaultGET /screening/travel_rule/vault/{vaultAccountId}/vaspGet assigned VASP to vault
TravelRuleApisetVaspForVaultPOST /screening/travel_rule/vault/{vaultAccountId}/vaspAssign VASP to vault
TravelRuleApiupdateVaspPUT /screening/travel_rule/vasp/updateAdd jsonDidKey to VASP details
TravelRuleApivalidateFullTravelRuleTransactionPOST /screening/travel_rule/transaction/validate/fullValidate Full Travel Rule Transaction
UserGroupsBetaApicreateUserGroupPOST /management/user_groupsCreate user group
UserGroupsBetaApideleteUserGroupDELETE /management/user_groups/{groupId}Delete user group
UserGroupsBetaApigetUserGroupGET /management/user_groups/{groupId}Get user group
UserGroupsBetaApigetUserGroupsGET /management/user_groupsList user groups
UserGroupsBetaApiupdateUserGroupPUT /management/user_groups/{groupId}Update user group
UsersApigetUsersGET /usersList users
VaultsApiactivateAssetForVaultAccountPOST /vault/accounts/{vaultAccountId}/{assetId}/activateActivate a wallet in a vault account
VaultsApiattachTagsToVaultAccountsPOST /vault/accounts/attached_tags/attachAttach tags to a vault accounts
VaultsApicreateLegacyAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/create_legacyConvert a segwit address to legacy format
VaultsApicreateMultipleAccountsPOST /vault/accounts/bulkBulk creation of new vault accounts
VaultsApicreateMultipleDepositAddressesPOST /vault/accounts/addresses/bulkBulk creation of new deposit addresses
VaultsApicreateVaultAccountPOST /vault/accountsCreate a new vault account
VaultsApicreateVaultAccountAssetPOST /vault/accounts/{vaultAccountId}/{assetId}Create a new wallet
VaultsApicreateVaultAccountAssetAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addressesCreate new asset deposit address
VaultsApidetachTagsFromVaultAccountsPOST /vault/accounts/attached_tags/detachDetach tags from a vault accounts
VaultsApigetAssetWalletsGET /vault/asset_walletsList asset wallets (Paginated)
VaultsApigetCreateMultipleDepositAddressesJobStatusGET /vault/accounts/addresses/bulk/{jobId}Get job status of bulk creation of new deposit addresses
VaultsApigetCreateMultipleVaultAccountsJobStatusGET /vault/accounts/bulk/{jobId}Get job status of bulk creation of new vault accounts
VaultsApigetMaxSpendableAmountGET /vault/accounts/{vaultAccountId}/{assetId}/max_spendable_amountGet the maximum spendable amount in a single transaction.
VaultsApigetPagedVaultAccountsGET /vault/accounts_pagedList vault accounts (Paginated)
VaultsApigetPublicKeyInfoGET /vault/public_key_infoGet the public key information
VaultsApigetPublicKeyInfoForAddressGET /vault/accounts/{vaultAccountId}/{assetId}/{change}/{addressIndex}/public_key_infoGet the public key for a vault account
VaultsApigetUnspentInputsGET /vault/accounts/{vaultAccountId}/{assetId}/unspent_inputsGet UTXO unspent inputs information
VaultsApigetVaultAccountGET /vault/accounts/{vaultAccountId}Find a vault account by ID
VaultsApigetVaultAccountAssetGET /vault/accounts/{vaultAccountId}/{assetId}Get the asset balance for a vault account
VaultsApigetVaultAccountAssetAddressesPaginatedGET /vault/accounts/{vaultAccountId}/{assetId}/addresses_paginatedList addresses (Paginated)
VaultsApigetVaultAssetsGET /vault/assetsGet asset balance for chosen assets
VaultsApigetVaultBalanceByAssetGET /vault/assets/{assetId}Get vault balance by asset
VaultsApihideVaultAccountPOST /vault/accounts/{vaultAccountId}/hideHide a vault account in the console
VaultsApisetCustomerRefIdForAddressPOST /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}/set_customer_ref_idAssign AML customer reference ID
VaultsApisetVaultAccountAutoFuelPOST /vault/accounts/{vaultAccountId}/set_auto_fuelTurn autofueling on or off
VaultsApisetVaultAccountCustomerRefIdPOST /vault/accounts/{vaultAccountId}/set_customer_ref_idSet an AML/KYT customer reference ID for a vault account
VaultsApiunhideVaultAccountPOST /vault/accounts/{vaultAccountId}/unhideUnhide a vault account in the console
VaultsApiupdateVaultAccountPUT /vault/accounts/{vaultAccountId}Rename a vault account
VaultsApiupdateVaultAccountAssetAddressPUT /vault/accounts/{vaultAccountId}/{assetId}/addresses/{addressId}Update address description
VaultsApiupdateVaultAccountAssetBalancePOST /vault/accounts/{vaultAccountId}/{assetId}/balanceRefresh asset balance data
Web3ConnectionsApicreatePOST /connections/wcCreate a new Web3 connection.
Web3ConnectionsApigetGET /connectionsList all open Web3 connections.
Web3ConnectionsApiremoveDELETE /connections/wc/{id}Remove an existing Web3 connection.
Web3ConnectionsApisubmitPUT /connections/wc/{id}Respond to a pending Web3 connection request.
WebhooksApiresendTransactionWebhooksPOST /webhooks/resend/{txId}Resend failed webhooks for a transaction by ID
WebhooksApiresendWebhooksPOST /webhooks/resendResend failed webhooks
WebhooksV2ApicreateWebhookPOST /webhooksCreate new webhook
WebhooksV2ApideleteWebhookDELETE /webhooks/{webhookId}Delete webhook
WebhooksV2ApigetNotificationGET /webhooks/{webhookId}/notifications/{notificationId}Get notification by id
WebhooksV2ApigetNotificationAttemptsGET /webhooks/{webhookId}/notifications/{notificationId}/attemptsGet notification attempts
WebhooksV2ApigetNotificationsGET /webhooks/{webhookId}/notificationsGet all notifications by webhook id
WebhooksV2ApigetResendJobStatusGET /webhooks/{webhookId}/notifications/resend_failed/jobs/{jobId}Get resend job status
WebhooksV2ApigetWebhookGET /webhooks/{webhookId}Get webhook by id
WebhooksV2ApigetWebhooksGET /webhooksGet all webhooks
WebhooksV2ApiresendFailedNotificationsPOST /webhooks/{webhookId}/notifications/resend_failedResend failed notifications
WebhooksV2ApiresendNotificationByIdPOST /webhooks/{webhookId}/notifications/{notificationId}/resendResend notification by id
WebhooksV2ApiresendNotificationsByResourceIdPOST /webhooks/{webhookId}/notifications/resend_by_resourceResend notifications by resource Id
WebhooksV2ApiupdateWebhookPATCH /webhooks/{webhookId}Update webhook
WhitelistIpAddressesApigetWhitelistIpAddressesGET /management/api_users/{userId}/whitelist_ip_addressesGets whitelisted ip addresses
WorkspaceStatusBetaApigetWorkspaceStatusGET /management/workspace_statusReturns current workspace status

Documentation for Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerTokenAuth

  • Type: Bearer authentication (JWT)

ApiKeyAuth

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

Author

support@fireblocks.com

Keywords

axios

FAQs

Package last updated on 01 Sep 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.