Skip to main content
POST
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json
owner
string
default:0x06A9aF046187895AcFc7258450B15397CAc67400
required

The wallet address that owns the Earn Account.

Example:

"0x06A9aF046187895AcFc7258450B15397CAc67400"

chain
enum<string>
default:base
required

Blockchain network

Available options:
base,
ethereum,
arbitrum,
hyperevm,
tempo,
bsc,
ethereum_sepolia
Example:

"base"

token
string
default:USDT
required

The token you would like to transfer with gas sponsorship.

Examples:

"USDC"

"WETH"

"0xA0b86a33E6441ccF30EE5DdEF1E9b652C91ac1c8"

gas_sponsorship
boolean
default:false

Optionally request gas sponsorship. If set to true, EIP-712 signature data will be returned that must be signed by the owner and submitted to the /gas_sponsorship/prepare endpoint.

Response

Successful Response

transaction
UnsignedTransaction · object | null

Unsigned approval transaction. Present when gas_sponsorship=false.

Example:
eip_712
PermitTypedDataResponse · object | null

EIP-712 typed data for off-chain permit signing. Present when gas_sponsorship=true.

Example: