Jump to Content
Fireblocks Developer Portal
Explore & DesignDevelop & IntegrateEmbedded Wallet Guides
API ReferenceTry in SandboxFireblocks Developer Portal
Develop & Integrate
API ReferenceTry in Sandbox
Explore & DesignDevelop & IntegrateEmbedded Wallet Guides

Introduction

  • API Overview
  • REST API Guide
  • Authenticate
  • API Idempotency
  • Rate Limiting
  • Transaction Sources & Destinations

Errors & Data Objects

  • API Responses and Error Codes
  • Transaction Statuses
    • Statuses
    • Sub-Statuses
  • Data Objects
    • Vault Objects
    • Exchange Account Objects
    • Fiat Account Objects
    • Network Connection Objects
    • Internal/External Wallet Objects
    • Contract Objects
    • Blockchain & Asset Objects
    • Transaction Objects
    • Transaction Authorization Objects
    • Fee Estimation Objects
    • Transaction Screening Objects
    • Raw Signing Objects
    • Payments Objects
    • Gas Station Objects
    • User Object
    • Webhook Object
    • NFT Objects
    • Web3 Connection Objects
    • General Objects
  • Handle API Errors

SDKs & Dev Tools

  • Quickstart
  • SDK Migration Guide
  • Postman Guide
  • TypeScript SDK
  • Python SDK
  • Java SDK
  • JS SDK (Legacy)
  • Python SDK (Legacy)
  • EVM Web3 Provider
  • EVM Local JSON RPC
  • Hardhat Plugin
  • Solana Web3 Connection Adapter
  • Hedera Token Service SDK

Demo Apps

  • Retail Demo Application
    • Introduction
    • Structure
    • Setup

Webhooks & Notifications

  • Webhooks v1
    • Configure Webhook URLs
    • Validate Requests
    • Resend Webhook Notifications
    • Code Examples
    • Webhooks v1 Data Objects
      • Vault Webhooks
      • Exchange & Fiat Account Webhooks
      • Network Connection Webhooks
      • Smart Transfer Webhooks
      • Internal, External & Contract Wallet Webhooks
      • Transaction Webhooks
      • NFT Webhooks
      • Off Exchange Webhooks
  • Webhooks v2
    • Migration Guide
    • Configure Webhook v2 URL
    • Validate Requests
    • Webhook v2 Data Objects
      • Wallet Webhooks
      • CeFi Webhooks
      • Network Connection Webhooks v2
      • Smart Transfer Webhooks v2
      • Whitelist Webhooks
      • Transaction Webhooks v2
      • Off Exchange Webhooks v2

Manage Your Workspace

  • Create API Keys
  • Configure Transaction Authorization Policy

Manage Wallets

  • Create Vault Accounts
  • Create Vault Wallets
  • Create Omnibus Structure

Manage Transactions

  • Create Transactions
  • Boost Transactions
  • Sweep to Omnibus
  • Select UTXOs
  • Consolidate UTXOs
  • Monitoring Transaction Statuses

Manage Transaction Fees

  • Configure Gas Station
    • Enable Auto Fueling
    • Set the Gas Station values
    • Fund the Gas Station
    • Monitor the Gas Station
  • Estimate Transaction Fee

Manage Treasury

  • Execute Smart Transfers
  • Stake Assets
    • Overview
    • Create a Staking Position
    • Unstake & Withdraw
  • Connect to Exchanges & FIAT Providers

Comply with regulation

  • Validate Travel Rule
  • How to Use Fireblocks TypeScript SDK with Travel Rule Messages

Manage Smart Contracts

  • Upload Contract Template
  • Issue New ERC20F Tokens
  • Setting Up Roles in ERC20F Tokens
  • Operational Guide for ERC20F Token
  • Issue new ERC721F/ERC1155F Tokens
  • Interact with Solana Programs

Manage Assets

  • Get Supported Assets
  • Add Tokens
  • Manage NFTs
    • Deploy an NFT Collection
    • Mint an NFT
    • Retrieve NFTs
    • Transfer NFTs

SIGN OFFChain MESSAGES

  • Typed Message Signing
    • Structure the API Call
    • Sign Typed Messages in Ethereum
    • Sign Typed Messages in Tron
    • Sign Typed Messages in Bitcoin
  • RAW Signing
    • Structure the API Call
    • Code Examples
  • Caching Signatures

Automate Flows

  • Set API Co-Signer Callback Handler
    • Authenticating the Callback Handler Request
  • API Co-signer Management
    • API Co-signer Deployment Options and Installation Flow
      • Add a New Co-signer to the Workspace
      • Install SGX Azure API Co-signer
      • Install SGX Azure Marketplace API Co-signer
      • Install SGX On-prem API Co-signer
      • Install SGX IBM Cloud API Co-signer
      • Install SGX Alibaba Cloud API Co-signer
      • Install AWS Nitro API Co-signer
      • Install Google Cloud Confidential Space API Co-signer
    • Using the Communal Test Co-signer
    • Setup API Co-signer Callback Handler
      • Establishing Secure Communication Between the Co-signer and the Callback Handler
      • Callback Handler Response Object
      • Approve Transactions
      • Approve Configuration Changes
      • Basic Callback Handler Code Example
      • Use the Plugin Based Callback Handler
      • Validate ETH Raw Transactions
    • Operating the API Co-signer
    • API Co-signer Maintenance
      • SGX API Co-signer Maintenance
      • AWS Nitro API Co-signer Maintenance
      • GCP Confidential Space API Co-signer Maintenance
    • API Co-signers Versions
      • SGX API Co-signer Version History
      • AWS Nitro API Co-signer Version History
      • GCP Confidential Space API Co-signer Version History
    • API Co-Signer Troubleshooting

Create Payments

  • Execute Payouts
  • Create Payment Flows
    • Workflow Data Objects
    • Create Workflow Configuration
    • Create Workflow Execution
    • Launch Workflow Execution

Fireblocks API

  • Workspace Management
    • Freezepost
    • List user groupsget
    • Create user grouppost
    • Get user groupget
    • Update user groupput
    • Delete user groupdelete
    • List usersget
    • Get audit logsget
    • Get audit logsget
    • Update admin quorum thresholdput
    • Enable or disable transactions to OTAput
    • Returns current OTA statusget
    • Returns current workspace statusget
    • Get console usersget
    • Create console userpost
    • Get API Keysget
    • Create API Keypost
    • Resets devicepost
    • Get whitelisted ip addresses for an API Keyget
  • Policy Editor (Beta)
    • Get the active policy and its validationget
    • Get the active draftget
    • Update the draft with a new set of rulesput
    • Send publish request for a certain draft idpost
    • Send publish request for a set of policy rulespost
  • Compliance
    • Validate Travel Rule Transactionpost
    • Validate Full Travel Rule Transactionpost
    • Get VASP detailsget
    • Get All VASPsget
    • Update VASP Detailsput
    • Travel Rule - View Post-Screening Policyget
    • Travel Rule - View Screening Policyget
    • Get assigned VASP to vaultget
    • Assign VASP to vaultpost
    • Get Travel Rule Screening Policy Configurationget
    • Update Travel Rule Configurationput
    • Get AML Screening Policy Configurationget
    • Update AML Configurationput
    • AML - View Screening Policyget
    • AML - View Post-Screening Policyget
    • Screening Configuration Updateput
    • Bypass Screening Policypost
    • Get Screening Full Detailsget
  • Blockchains & Assets
    • List assetsget
    • Register an assetpost
    • Get an asset by IDget
    • Set asset pricepost
    • List blockchainsget
    • Get a Blockchain by IDget
    • Validate destination addressget
    • Estimate the required fee for an assetget
    • Legacy - List Assetsget
  • Vaults
    • Get vault accountsget
    • Create a new vault accountpost
    • Bulk creation of new deposit addressespost
    • Get the job status of the bulk deposit address creationget
    • Get vault accounts (Paginated)get
    • Get a vault account by IDget
    • Rename a vault accountput
    • Get vault wallets (Paginated)get
    • Hide a vault account in the consolepost
    • Unhide a vault account in the consolepost
    • Activate a wallet in a vault accountpost
    • Set an AML/KYT ID for a vault accountpost
    • Set auto fueling to on or offpost
    • Get the asset balance for a vault accountget
    • Create a new vault walletpost
    • Refresh asset balance datapost
    • Get asset addressesget
    • Create new asset deposit addresspost
    • Get addresses (Paginated)get
    • Get the max spendable amount in a transaction.get
    • Update address descriptionput
    • Assign AML customer reference IDpost
    • Convert a segwit address to legacy formatpost
    • Get UTXO unspent inputs informationget
    • Get the public key for a derivation pathget
    • Get an asset's public keyget
    • Get asset balance for chosen assetsget
    • Get vault balance by an assetget
  • Transactions
    • Get transaction historyget
    • Create a new transactionpost
    • Estimate transaction feepost
    • Get a specific transaction by Fireblocks transaction IDget
    • Get a specific transaction by external transaction IDget
    • Set confirmation threshold by Fireblocks Transaction IDpost
    • Drop ETH (EVM) transaction by IDpost
    • Cancel a transactionpost
    • Freeze a transactionpost
    • Unfreeze a transactionpost
    • Rescan an array of transactionspost
    • Set confirmation threshold by transaction hashpost
  • Gas Station
    • Get gas station settingsget
    • Get gas station settings by assetget
    • Edit gas station settingsput
    • Edit gas station settings for an assetput
  • Whitelisted Internal Wallets
    • List internal walletsget
    • Create an internal walletpost
    • Get assets for internal walletget
    • Delete an internal walletdelete
    • List assets in an internal wallet (Paginated)get
    • Set an AML/KYT customer reference ID for internal walletpost
    • Get an asset from an internal walletget
    • Add an asset to an internal walletpost
    • Delete a whitelisted addressdelete
  • Whitelisted External Wallets
    • List external walletsget
    • Create an external walletpost
    • Find an external walletget
    • Delete an external walletdelete
    • Set an AML customer reference ID for an external walletpost
    • Get an asset from an external walletget
    • Add an asset to an external wallet.post
    • Delete an asset from an external walletdelete
  • Whitelisted Contracts
    • List Whitelisted Contractsget
    • Create a Whitelisted Contractpost
    • Find a Specific Whitelisted Contractget
    • Delete a Whitelisted Contractdelete
    • Find a whitelisted contract's assetget
    • Add an Asset to a Whitelisted Contractpost
    • Delete a Whitelisted Contract's Assetdelete
  • Fireblocks Network
    • List network connectionsget
    • Creates a new network connectionpost
    • Update network connection routing policy.patch
    • Retrieve third-party network routing validationget
    • Get a network connectionget
    • Deletes a network connection by IDdelete
    • Get all network IDsget
    • Creates a new Network IDpost
    • Returns all enabled routing policy asset groupsget
    • Get both local IDs and discoverable remote IDsget
    • Returns specific network ID.get
    • Deletes specific network ID.delete
    • Update network id routing policy.patch
    • Update network ID's discoverability.patch
    • Update network ID's name.patch
  • Smart Transfers
    • Create Ticketpost
    • Find Ticketget
    • Search Ticket by IDget
    • Set expirationput
    • Add external ref. IDput
    • Submit ticketput
    • Fund ticket manuallyput
    • Fund dvp ticketput
    • Cancel Ticketput
    • Create leg (term)post
    • Get Smart Transfer ticket termget
    • Update ticket leg (term)put
    • Delete ticket leg (term)delete
    • Define funding sourceput
    • Set funding source and approvalput
    • Manually add term transactionput
    • Set user grouppost
    • Get user groupget
    • Get smart transfers statisticget
  • Exchange Accounts
    • List exchange accountsget
    • Add an Exchange Accountpost
    • List connected exchange accountsget
    • Get a specific exchange accountget
    • Internal transfer for exchange accountspost
    • Convert exchange account fundspost
    • Get an asset for an exchange accountget
    • Get public key to encrypt exchange credentialsget
  • Fiat Accounts
    • List fiat accountsget
    • Find a specific fiat accountget
    • Redeem funds to DDApost
    • Deposit funds from DDApost
  • Tokenization
    • Issue a new tokenpost
    • List all linked tokensget
    • Link a contractpost
    • Create a new collectionpost
    • Get collectionsget
    • Get a collection by idget
    • Delete a collection linkdelete
    • Get collection token detailsget
    • Mint tokenspost
    • Burn tokenspost
    • Unlink a tokendelete
    • Return a linked tokenget
  • Contract Templates
    • List all contract templatesget
    • Upload contract templatepost
    • Return contract template by idget
    • Delete a contract template by iddelete
    • Return contract template's constructorget
    • Return contract template's functionget
    • Deploy contractpost
  • Deployed Contracts
    • List deployed contracts dataget
    • Return deployed contract data by idget
    • Return deployed contract dataget
    • Fetch the contract ABIpost
    • Save contract ABIpost
  • Contract Interactions
    • Return deployed contract's ABIget
    • Call a read functionpost
    • Call a write functionpost
    • Get transaction receiptget
  • Staking
    • List supported chains for Fireblocks Stakingget
    • Get chain-specific staking summaryget
    • Initiate Stake Operationpost
    • Execute an Unstake operationpost
    • Execute a Withdraw operationpost
    • Execute a Claim Rewards operationpost
    • Execute a Split operationpost
    • List staking positions detailsget
    • Get staking summary detailsget
    • Get staking summary details by vaultget
    • Get staking position detailsget
    • List staking providers detailsget
    • Approve staking terms of servicepost
  • NFTs
    • Refresh vault account tokensput
    • List all owned tokens (paginated)get
    • List all distinct owned tokens (paginated)get
    • List owned collections (paginated)get
    • Refresh token metadataput
    • List token data by IDget
    • List tokens by IDsget
    • Update token ownership statusput
    • Update tokens ownership statusput
    • Update tokens ownership spam propertyput
  • dApp Connections
    • List all open Web3 connectionsget
    • Create a new Web3 connection.post
    • Respond to a pending connectionput
    • Remove an existing Web3 connectiondelete
  • Job Management
    • Return a list of jobs belonging to tenantget
    • Get job detailsget
    • Pause a jobpost
    • Continue a paused jobpost
    • Cancel a running jobpost
    • Return a list of tasks for given jobget
  • Cosigners (Beta)
    • Get all cosignersget
    • Add cosignerpost
    • Get cosignerget
    • Rename cosignerpatch
    • Get all API keysget
    • Get API keyget
    • Pair API keyput
    • Unpair API keydelete
    • Update API key callback handlerpatch
    • Get request statusget
  • Webhooks
    • Resend failed webhookspost
    • Resend webhooks for a transaction by IDpost
  • Webhooks V2 (Beta)
    • Create a new webhookpost
    • Get all webhooksget
    • Get webhook by idget
    • Update webhookpatch
    • Delete a webhookdelete
    • Get all notifications by webhook idget
    • Resend notification by idpost
    • Resend notifications by resource Idpost
    • Get notification by idget
  • Off Exchange
    • Add Collateralpost
    • Remove Collateralpost
    • Create Settlement for a Traderpost
    • Get Settlements Transactionsget
    • Find a specific collateral exchange accountget
  • Payments - Payout
    • Create a payout instruction setpost
    • Execute a payout instruction setpost
    • Get the status of a payout instruction setget
  • Payments - Flows
    • Create payment flow configurationpost
    • Retrieve workflow configurationget
    • Delete workflow configurationdelete
    • Create workflow executionpost
    • Get workflow execution detailsget
    • Execute the payments workflowpost
  • Key Link
    • Add a new signing keypost
    • Get list of signing keysget
    • Get a signing key by `keyId`get
    • Modify the signing keyIdpatch
    • Set agent user idpatch
    • Add a new validation keypost
    • Get list of registered validation keysget
    • Get a validation key by `keyId`get
    • Disables a validation keypatch
  • Keys (Beta)
    • Get list of mpc keysget
    • Get list of mpc keys by `userId`get

Fireblocks NCW

  • Non Custodial Wallets
    • Create a new walletpost
    • List walletsget
    • Get a walletget
    • Get wallet Latest Backup detailsget
    • Get wallet key setup stateget
    • Enable or disable a walletput
    • Get the public key of an assetget
    • Get the public key for a derivation pathget
  • Non Custodial Wallet Accounts
    • Create a new accountpost
    • Get accountsget
    • Get an accountget
  • Non Custodial Wallet Assets
    • Retrieve assetsget
    • Retrieve assetget
    • Add asset to accountpost
    • Refresh asset balanceput
    • Retrieve asset balanceget
    • Retrieve asset addressesget
    • Retrieve supported assetsget
  • Non Custodial Wallet Devices
    • Get registered devicesget
    • Enable or Disable deviceput
    • Get device key setup stateget
  • Non Custodial Wallets RPC
    • Invoke RPCpost

API Co-signers Versions

Below are the version details for each of the Co-signer types:

  • SGX Co-signer version history
  • AWS Nitro Co-signer version history
  • Google Cloud Confidential Space Co-signer version history
Fireblocks logo

Fireblocks is an enterprise-grade platform delivering a secure infrastructure for moving, storing, and issuing digital assets. Fireblocks enables exchanges, custodians, banks, trading desks, and hedge funds to securely scale digital asset operations through patent-pending SGX & MPC technology.

  • Feedback
  • Changelog
  • Documentation
  • Status
  • Community
  • API Reference
  • Corporate Website
  • Try in Sandbox
  • Privacy Policy
  • Terms of use