Skip to main content
POST
/
v2
/
gas_sponsorship
/
approve_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.gas_sponsorship.gas_sponsorship_approve_transfer(owner="0x06A9aF046187895AcFc7258450B15397CAc67400", chain=models.Chain.BASE, token="USDT", gas_sponsorship=False)

    # Handle response
    print(res)
{
  "eip_712": {
    "domain": {
      "chainId": 8453,
      "name": "USD Coin",
      "verifyingContract": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
      "version": "2"
    },
    "message": {
      "deadline": "1735689600",
      "nonce": "0",
      "owner": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
      "spender": "0x000000000022D473030F116dDEE9F6B43aC78BA3",
      "value": "115792089237316195423570985008687907853269984665640564039457584007913129639935"
    },
    "primaryType": "Permit",
    "types": {
      "EIP712Domain": [
        {
          "name": "name",
          "type": "string"
        },
        {
          "name": "version",
          "type": "string"
        },
        {
          "name": "chainId",
          "type": "uint256"
        },
        {
          "name": "verifyingContract",
          "type": "address"
        }
      ],
      "Permit": [
        {
          "name": "owner",
          "type": "address"
        },
        {
          "name": "spender",
          "type": "address"
        },
        {
          "name": "value",
          "type": "uint256"
        },
        {
          "name": "nonce",
          "type": "uint256"
        },
        {
          "name": "deadline",
          "type": "uint256"
        }
      ]
    }
  }
}

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
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

Unsigned approval transaction. Present when gas_sponsorship=false.

Example:
{
  "chainId": "0x2105",
  "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
  "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
  "gas": "0x7a120",
  "maxFeePerGas": "0x59682f00",
  "maxPriorityFeePerGas": "0x3b9aca00",
  "nonce": "0x5",
  "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
  "value": "0x0"
}
​
eip_712
PermitTypedDataResponse · object

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

Example:
{
  "domain": {
    "chainId": 8453,
    "name": "USD Coin",
    "verifyingContract": "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
    "version": "2"
  },
  "message": {
    "deadline": "1735689600",
    "nonce": "0",
    "owner": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
    "spender": "0x6B90E8B4E3E971E74C1A47a3a20976377E2dB4b1",
    "value": "100000000"
  },
  "primaryType": "Permit",
  "types": {
    "EIP712Domain": [
      { "name": "name", "type": "string" },
      { "name": "version", "type": "string" },
      { "name": "chainId", "type": "uint256" },
      {
        "name": "verifyingContract",
        "type": "address"
      }
    ],
    "Permit": [
      { "name": "owner", "type": "address" },
      { "name": "spender", "type": "address" },
      { "name": "value", "type": "uint256" },
      { "name": "nonce", "type": "uint256" },
      { "name": "deadline", "type": "uint256" }
    ]
  }
}