Ctrl+K

Forward tokens from address

post/api/v2/{coin}/wallet/{walletId}/address/{addressId}/tokenforward

This API call is to manually forward tokens from an ETH or CELO address

Path Parameters

  • coinstringRequired
    A cryptocurrency symbol or token ticker symbol
    Example: btc
  • walletIdstringRequired
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$
  • addressIdstringRequired
    Address or Id which will be used for information lookup
    Example: 59cd72485007a239fb00282ed480da1f
    Pattern: ^[0-9a-f]{32}$

Request Body

tokenName string
Name of token that needs to be forwarded from the address
forceFlush boolean
Use forceFlush: true to flush the tokens from forwarder irrespective of the balance of the forwarders
Default: false
gasPrice number
Explicit gas price to use when forwarding token from the forwarder contract (ETH and Celo only). If not given, defaults to the current estimated network gas price.
eip1559 object
Specify eip1559 fee parameters in token forwarding transaction.
maxFeePerGas number required
Max total gasPrice for EIP1559 transactions. Only for ETH and ERC20 tokens.
maxPriorityFeePerGas number required
Max priority tip price for EIP1559 transactions. Only for ETH and ERC20 tokens.

200 Response

txId string required

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id

401 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id