Aave V3

Unstake

This endpoint facilitates the withdrawal of collateral from the Aave protocol.

Users can withdraw a portion or all of their collateral, which may increase the risk of liquidation if there are outstanding borrows. The withdrawal process also includes the collection of any interest earned on the collateral. It is important for users to carefully consider their outstanding debts and the potential impact on their liquidation threshold before proceeding with a withdrawal. This endpoint is designed to provide a seamless and efficient way to manage your collateral within the Aave ecosystem.

POST

aave

withdraw

curl --request POST \
  --url https://api.compasslabs.ai/v0/aave/withdraw \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "sender": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
  "asset": "USDC",
  "amount": 1,
  "recipient": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
}'

{
  "chainId": 123,
  "data": "<string>",
  "from": "<string>",
  "gas": 123,
  "to": "<string>",
  "value": 123,
  "nonce": 123,
  "maxFeePerGas": 123,
  "maxPriorityFeePerGas": 123
}

Authorizations

x-api-key

string

header

required

Your Compass API key. Get your key here.

Body

application/json

asset

enum<string>

required

The symbol of the underlying asset to withdraw. Note the supported tokens per chain.

Available options:

1INCH,

AAVE,

BAL,

cbBTC,

cbETH,

CRV,

crvUSD,

DAI,

ENS,

ETHx,

FRAX,

FXS,

GHO,

KNC,

LDO,

LINK,

LUSD,

MKR,

osETH,

PYUSD,

rETH,

RPL,

rsETH,

sDAI,

SNX,

STG,

sUSDe,

tBTC,

UNI,

USDC,

USDe,

USDS,

USDT,

WBTC,

weETH,

WETH,

wstETH,

ARB,

EURS,

MAI,

USDCe,

AERO,

EUR,

VIRTUAL

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

The chain to use.

Available options:

base:mainnet,

ethereum:mainnet,

arbitrum:mainnet

sender

string

default:0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B

required

The address of the transaction sender

Response

200

application/json

Successful Response

chainId

integer

required

The chain id of the transaction

data

string

required

The data of the transaction

from

string

required

The sender of the transaction

gas

integer

required

The gas of the transaction

string

required

The recipient of the transaction

value

integer

required

The value of the transaction

nonce

integer

required

The nonce of the address

maxFeePerGas

integer

required

The max fee per gas of the transaction

maxPriorityFeePerGas

integer

required

The max priority fee per gas of the transaction

Was this page helpful?

Repay loans Token prices

curl --request POST \
  --url https://api.compasslabs.ai/v0/aave/withdraw \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "chain": "arbitrum:mainnet",
  "sender": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B",
  "asset": "USDC",
  "amount": 1,
  "recipient": "0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"
}'

{
  "chainId": 123,
  "data": "<string>",
  "from": "<string>",
  "gas": 123,
  "to": "<string>",
  "value": 123,
  "nonce": 123,
  "maxFeePerGas": 123,
  "maxPriorityFeePerGas": 123
}

Endpoints

Authorizations

Body

Response