Skip to main content
POST
/
v1
/
aave
/
supply
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_supply(token="USDC", amount="0.5", chain=models.AaveSupplyRequestChain.BASE, sender="0x466C298e40c57e1DfD364443B364DFB2717BF882", 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 or address of the underlying asset to supply as collateral. You can borrow against it..

Example:

"WETH"

​
amount
required

The amount of the asset to supply

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:AAVE_SUPPLY
Allowed value: "AAVE_SUPPLY"
​
on_behalf_of
string | null

The address on behalf of whom the supply is made. Defaults to the transaction sender.

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