Skip to main content
POST
/
v1
/
aave
/
borrow
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_borrow(token="WETH", amount=150.5, interest_rate_mode=models.InterestRateMode.VARIABLE, chain=models.AaveBorrowRequestChain.BASE, sender="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B", 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 borrow..

Examples:

"WETH"

amount
required

The amount of the asset to borrow

Required range: x > 0
Examples:

150.5

interest_rate_mode
enum<string>
required

The interest rate mode to borrow

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

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:AAVE_BORROW
Allowed value: "AAVE_BORROW"
on_behalf_of
string | null

The address on behalf of whom the supply is made

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

The unsigned transaction data. User must sign and broadcast to network.

  • UnsignedTransaction
  • UserOperationResponse