Estimate transaction fee
Estimates the transaction fee for a specific transaction request. This endpoint simulates a transaction which means that the system will expect to have the requested asset and balance in the specified wallet. Note: Supports all Fireblocks assets except ZCash (ZEC). The PROGRAM_CALL operation is not supported by this endpoint — fee estimation for Solana program calls is not available. The SOROBAN_CALL operation is not supported by this endpoint - fee estimation for Stellar Soroban contract calls is not available. Learn more about Fireblocks Fee Management in the following guide. Endpoint Permission: Admin, Signer, Approver, Editor.
Headers
Body
-
TRANSFER- The default value for an operation. Transfers funds from one account to another. UTXO blockchains allow multi-input and multi-output transfers. All other blockchains allow transfers with one source address and one destination address. -
MINT- Mints new tokens. Supported for Stellar, Ripple and EVM-based blockchains. -
BURN- Burns tokens. Supported for Stellar, Ripple and EVM-based blockchains. -
CONTRACT_CALL- Calls a smart contract method for web3 operations on any EVM blockchain. The Fireblocks development libraries are recommended for building contract call transactions. -
PROGRAM_CALL- Execute multiple instructions on Solana blockchain. The @solana/web3.js library is recommended for building program call transactions. -
SOROBAN_CALL- Invokes a Soroban smart contract on the Stellar blockchain. The call is submitted as a base64-encoded, unsigned StellarTransactionEnvelopeinextraParameters.sorobanCallData.envelopeXdr, which is the same artifact a Soroban dApp hands a wallet. Fireblocks decodes the envelope, determines the footprint, resource fee, sequence number and authorization entries itself, and signs a transaction it rebuilt - the submitted envelope must therefore carry no signatures and no authorization entries.assetIdis the fee asset (XLMorXLM_TEST), not the token being moved, anddestinationis the contract wallet or, when enabled for your workspace, aONE_TIME_ADDRESSholding a Stellar contract address (C...).amountmust be omitted or0. Fee estimation is not supported for this operation. -
TYPED_MESSAGE- An off-chain message in either Ethereum Personal Message or EIP712 format. Use it to sign specific readable messages that are not actual transactions. Learn more about typed messages. -
RAW- An off-chain message with no predefined format. Use it to sign any message with your private key, including protocols such as blockchains and custom transaction types that are not natively supported by Fireblocks. Learn more about raw signing transactions. -
APPROVE- Enables the approve function for a smart contract or wallet to withdraw from a designated wallet. Learn more. -
ENABLE_ASSET- Algorand, DigitalBits, Solana, and Stellar require an on-chain transaction to create an asset wallet and enable the deposit address. This transaction is automatically created when adding assets on these blockchains at a vault account. -
CANTON_CALL- A customer-initiated Canton operation, such as withdrawing an allocation or responding to an onboarding offer. Note that not every Canton transaction carries this operation — an incoming Canton transfer offer is aTRANSFER— so use the top-levelcantonDetailsrather thanoperationto identify a Canton transaction.
TRANSFER, BURN, CONTRACT_CALL, PROGRAM_CALL, SOROBAN_CALL, MINT, RAW, TYPED_MESSAGE, APPROVE, ENABLE_ASSET, CANTON_CALL This parameter allows you to add a unique ID of your own to help prevent duplicate transactions. No specific format is required for this parameter. After you submit a transaction with an external ID, Fireblocks will automatically reject all future transactions with the same ID. Using an external ID primarily helps in situations where, even though a submitted transaction responds with an error due to an internet outage, the transaction was still sent to and processed on the blockchain. Use the Get a specific transaction by external transaction ID endpoint to validate whether these transactions have been processed.
"00000000-0000-0000-0000-000000000000"
For Tempo-based transactions only, the asset used to pay the transaction's network fee, as an asset ID (see supported assets). For any other blockchain, this value is ignored. This feature is currently in beta and might be subject to changes.
"PATHUSD_TEMPO_54V8"
The ID of the asset to transfer, for TRANSFER, MINT or BURN operations. See the list of supported assets and their IDs on Fireblocks.
"ETH"
"When set to true, the fee will be deducted from the requested amount."
Note: This parameter can only be considered if a transaction’s asset is a base asset, such as ETH or MATIC. If the asset can’t be used for transaction fees, like USDC, this parameter is ignored and the fee is deducted from the relevant base asset wallet in the source account.
false
For Polkadot, Kusama and Westend transactions only. When set to true, Fireblocks will empty the asset wallet.
Note: If set to true when the source account is exactly 1 DOT, the transaction will fail. Any amount more or less than 1 DOT succeeds. This is a Polkadot blockchain limitation.
Note: forceSweep and treatAsGrossAmount can also be used to empty a TON/GRAM wallet.
false
For EVM-based blockchains only. Units of gas required to process the transaction. Note: Only two of the three arguments can be specified in a single transaction: gasLimit, gasPrice and networkFee. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.
"21000"
For non-EIP-1559, EVM-based transactions. Price per gas unit (in Ethereum this is specified in Gwei). Note: Only two of the three arguments can be specified in a single transaction: gasLimit, gasPrice and networkFee. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated.
For EVM-based blockchains only. The total transaction fee in the blockchain’s largest unit. Note: Only two of the three arguments can be specified in a single transaction: gasLimit, gasPrice and networkFee. Fireblocks recommends using a numeric string for accurate precision. Although a number input exists, it is deprecated. - The transaction blockchain fee.
- For Ethereum, you can't pass gasPrice, gasLimit and networkFee all together.
- A numeric value representation is required.
For EVM-based blockchains only. In case a transaction is stuck, specify the hash of the stuck transaction to replace it by this transaction with a higher fee, or to replace it with this transaction with a zero fee and drop it from the blockchain.
"00000000-0000-0000-0000-000000000000"
Additional protocol / operation specific key-value parameters:
For UTXO-based blockchain input selection, add the key inputsSelection with the value set to the input selection structure. The inputs can be retrieved from the Retrieve Unspent Inputs endpoint.
For RAW operations, add the key rawMessageData with the value set to the raw message data structure.
For SOROBAN_CALL operations, add the key sorobanCallData with the value set to an object containing envelopeXdr - a base64 encoded, unsigned Stellar TransactionEnvelope holding the contract invocation.
For CONTRACT_CALL operations, add the key contractCallData with the value set to the Ethereum smart contract Application Binary Interface (ABI) payload. The Fireblocks development libraries are recommended for building contract call transactions.
For exchange compliance (e.g., Binance) and Travel Rule purposes, include the key piiData containing a custom JSON structure with Personally Identifiable Information (PII) relevant to the transaction. This data must be fully encrypted by the sender before being submitted to the Fireblocks API. The recommended encryption method is hybrid encryption using AES-256-GCM for the payload and RSA-OAEP for key exchange, with the recipient exchange's public key. development libraries
Note: rawMessageData, contractCallData, sorobanCallData, and inputsSelection cannot be used together in the same call.