API Reference

Estimate fee for a transfer transaction

posthttps://api.circle.com/v1/w3s/transactions/transfer/estimateFee

Reference
Playground

Estimates gas fees that will be incurred for a transfer transaction; given its amount, blockchain, and token.

Header parameters

X-Request-Id

string

Developer-provided parameter used to identify this request. Useful when communicating with Circle Support.

Body parameters

destinationAddress

string

Required

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

amounts

array of strings

Required

Transfer amounts in decimal number format, at least one element is required for transfer. For ERC721 token transfer, the amounts field is required to be ["1"] (array with "1" as the only element).

nftTokenIds

array of strings

List of NFT token IDs corresponding with the NFTs to transfer. Batch transfers are supported only for ERC-1155 tokens. The length of NFT token IDs must match the length of amounts.

sourceAddress

string

Source address of the transaction. Required along with blockchain if walletId is not provided. The sourceAddress and walletId fields are mutually exclusive.

tokenId

string

System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.

tokenAddress

string

Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId.

blockchain

string

Blockchain of the transferred token. Required if tokenId is not provided. The blockchain and tokenId fields are mutually exclusive.

Allowed valuesETHETH-SEPOLIAAVAXAVAX-FUJIMATICMATIC-AMOYSOLSOL-DEVNETARBARB-SEPOLIAUNIUNI-SEPOLIABASEBASE-SEPOLIAOPOP-SEPOLIAAPTOSAPTOS-TESTNET

walletId

string

Unique system generated identifier of the wallet. For contract deploys this wallet ID will be used as the source.

Response

200EstimateTransactionFeeResponse

Response Body

object

data

object

Required

Show 6 properties

high

object

Show 8 properties

gasLimit

string

The maximum units of gas to use for the transaction. Required if feeLevel is not provided. Estimates for this limit can be obtained through the POST /transactions/transfer/estimateFee API. GasLimit override (only supported for EOA wallets): Using gasLimit together with feeLevel, the provided gasLimit is required to be greater or equal to feeLevel estimation and will override the estimation's gasLimit.

gasPrice

string

For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see gasLimit). Requires gasLimit. Cannot be used with feeLevel, priorityFee, or maxFee. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

maxFee

string

For blockchains with EIP-1559 support, the maximum price per unit of gas (see gasLimit), in gwei. Requires priorityFee, and gasLimit to be present. Cannot be used with feeLevel or gasPrice. Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

priorityFee

string

For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators. Please note that the maxFee and gasLimit parameters are required alongside the priorityFee. The feeLevel and gasPrice parameters cannot be used with the priorityFee. Estimations for this fee can be obtained through the POST /transactions/transfer/estimateFee API.

baseFee

string

For blockchains with EIP-1559 support, the estimated base fee represents the minimum fee required for a transaction to be included in a block on the blockchain. It is measured in gwei and compensates for the computational resources validators consume to process the transaction. The base fee is supplemented by a separate "tip" called the priority fee, which acts as an extra incentive for validators to prioritize the transaction. The priority fee is added to the base fee to calculate the final transaction fee.

networkFee

string

The estimated network fee is the maximum amount of cryptocurrency (such as ETH, ARB, or SOL) that you will pay for your transaction. This fee depends on the parameters you set, including Gas Limit, Priority Fee, and Max Fee. It compensates for the computational resources that validators consume to process the transaction. It is measured in native token such as ETH, SOL. For blockchains with L1 data fees such as OP/BASE, the network fee is a combination of the Execution Gas Fee and the L1 Data Fee. Each blockchain might use different formula for network fee. Refer to each specific blockchain's documentation to understand how networkFee is calculated.

networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

l1Fee

string

This is the L1 rollup fee incurred for Layer 2 blockchain transactions. The value is returned in native currency, e.g. ETH.

low

object

Show 8 properties

gasLimit

string

gasPrice

string

maxFee

string

priorityFee

string

baseFee

string

networkFee

string

networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

l1Fee

string

This is the L1 rollup fee incurred for Layer 2 blockchain transactions. The value is returned in native currency, e.g. ETH.

medium

object

Show 8 properties

gasLimit

string

gasPrice

string

maxFee

string

priorityFee

string

baseFee

string

networkFee

string

networkFeeRaw

string

Similar to networkFee, networkFeeRaw is an estimation with lower buffer and thus should be closer to the actual on-chain expense. This field will only be returned in the estimation response.

l1Fee

string

This is the L1 rollup fee incurred for Layer 2 blockchain transactions. The value is returned in native currency, e.g. ETH.

callGasLimit

string

One of ERC-4337 gas fields. The amount of gas to allocate for the main execution call. Only in smart contract account estimation response.

verificationGasLimit

string

One of ERC-4337 gas fields. The amount of gas to allocate for the verification step. Only in smart contract account estimation response.

preVerificationGas

string

One of ERC-4337 gas fields. The amount of gas to pay to compensate the bundler for pre-verification execution and call data. Only in smart contract account estimation response.

400Error

404NotFoundResponse

RequestChoose a language

ResponseChoose an example

1{
2  "data": {
3    "high": {
4      "gasLimit": "21000",
5      "gasPrice": "",
6      "maxFee": "5.935224468",
7      "priorityFee": "1.022783914",
8      "baseFee": "1.022783914",
9      "networkFee": "0.0001246397138",
10      "networkFeeRaw": "0.0001246397138",
11      "l1Fee": "0.000000000000140021"
12    },
13    "low": {
14      "gasLimit": "21000",
15      "gasPrice": "",
16      "maxFee": "5.935224468",
17      "priorityFee": "1.022783914",
18      "baseFee": "1.022783914",
19      "networkFee": "0.0001246397138",
20      "networkFeeRaw": "0.0001246397138",
21      "l1Fee": "0.000000000000140021"
22    },
23    "medium": {
24      "gasLimit": "21000",
25      "gasPrice": "",
26      "maxFee": "5.935224468",
27      "priorityFee": "1.022783914",
28      "baseFee": "1.022783914",
29      "networkFee": "0.0001246397138",
30      "networkFeeRaw": "0.0001246397138",
31      "l1Fee": "0.000000000000140021"
32    },
33    "callGasLimit": "69222",
34    "verificationGasLimit": "56863",
35    "preVerificationGas": "44112"
36  }
37}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy