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


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

    res = compass_api.aave_v3.aave_withdraw(token="USDC", amount="0.5", recipient="0x388f03DABdc414E11da8Da63198D183C82836866", chain=models.AaveWithdrawRequestChain.BASE, sender="0x388f03DABdc414E11da8Da63198D183C82836866", 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
token
string
required

The symbol of the underlying asset to withdraw..

Example:

"WETH"

amount
required

The amount of the asset to withdraw

Required range: x > 0
Example:

1.5

recipient
string
required

The address of the recipient of the withdrawn funds.

Example:

"0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"

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

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:AAVE_WITHDRAW
Allowed value: "AAVE_WITHDRAW"
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.