estimateTransferFeeNode.js,latest
Go to NPMEstimates gas fees for a transfer transaction.
Parameters
input
object
Required
Represents the input parameters for estimating transfer fees.
option 1:
userId
string
Required
Unique system-generated identifier for the user.
tokenId
string
Required
System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.
amount
array of strings
Required
Specifies the transfer amount in decimal format.
destinationAddress
string
Required
The recipient's blockchain address.
nftTokenIds
array of strings
The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.
sourceAddress
string
The source blockchain address of the transaction.
walletId
string
Identifier for the originating wallet.
option 2:
userId
string
Required
Unique system-generated identifier for the user.
blockchain
string
Blockchain of the transferred token. Required if tokenId is not provided. The blockchain and tokenId fields are mutually exclusive.
Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
tokenAddress
string
Required
Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId.
amount
array of strings
Required
Specifies the transfer amount in decimal format.
destinationAddress
string
Required
The recipient's blockchain address.
nftTokenIds
array of strings
The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.
sourceAddress
string
The source blockchain address of the transaction.
walletId
string
Identifier for the originating wallet.
option 3:
userToken
string
Required
The JSON Web Token (JWT) representing the user.
tokenId
string
Required
System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.
amount
array of strings
Required
Specifies the transfer amount in decimal format.
destinationAddress
string
Required
The recipient's blockchain address.
nftTokenIds
array of strings
The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.
sourceAddress
string
The source blockchain address of the transaction.
walletId
string
Identifier for the originating wallet.
option 4:
userToken
string
Required
The JSON Web Token (JWT) representing the user.
blockchain
string
Blockchain of the transferred token. Required if tokenId is not provided. The blockchain and tokenId fields are mutually exclusive.
Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
tokenAddress
string
Required
Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId.
amount
array of strings
Required
Specifies the transfer amount in decimal format.
destinationAddress
string
Required
The recipient's blockchain address.
nftTokenIds
array of strings
The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only ERC-1155 tokens support safeBatchTransferFrom.
sourceAddress
string
The source blockchain address of the transaction.
walletId
string
Identifier for the originating wallet.
Responses
Example
1const response = await client.estimateTransferFee({
2 amount: ["0.01"],
3 destinationAddress: "address",
4 tokenId: "token-id",
5 userToken: "dummy-user-token",
6})
7console.log(response.data)Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
