Skip to main content
POST
/
v1
/
token
/
transfer
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.token.token_transfer(to="0x0000000000000000000000000000000000000000", token="USDC", amount=0.1, chain=models.TokenTransferRequestChain.BASE, sender="0xA06a2D62D71BeAf93FA0a684A92c28729297eC81", estimate_gas=True)

    # Handle response
    print(res)
{
  "transaction": {
    "chainId": "<string>",
    "data": "<string>",
    "from": "<string>",
    "gas": "<string>",
    "to": "<string>",
    "value": "<string>",
    "nonce": "<string>",
    "maxFeePerGas": "<string>",
    "maxPriorityFeePerGas": "<string>"
  }
}

Authorizations

​
x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json

Request model for transferring ETH or ERC20 tokens.

​
to
string
required

The recipient of the tokens.

Example:

"0x68b3465833fb72A70ecDF485E0e4C7bD8665Fc44"

​
token
string
required

The symbol or address of the token to transfer.

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

​
amount
required

Amount of token to transfer

Required range: x > 0
Example:

1.5

​
chain
enum<string>
required
Available options:
arbitrum,
base,
ethereum
​
sender
string
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

​
action_type
string
default:TOKEN_TRANSFER
Allowed value: "TOKEN_TRANSFER"
​
estimate_gas
boolean
default:true

Determines whether to estimate gas costs for transactions, also verifying that the transaction can be successfully executed.

Response

Successful Response

​
transaction
UnsignedTransaction · object
required

The unsigned transaction data. User must sign and broadcast to network.