POST
/
v0
/
aave
/
borrow
from compassapisdk import CompassAPISDK, models


with CompassAPISDK(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api_sdk:

    res = compass_api_sdk.aave_v3.borrow(token=models.TokenEnum.USDC, amount=150.5, interest_rate_mode=models.InterestRateMode.VARIABLE, chain=models.Chain.ARBITRUM_MAINNET, sender="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B")

    # Handle response
    print(res)
{
  "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
​
token
enum<string>
required

The symbol of the underlying asset to borrow..

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

The chain to use.

Available options:
base:mainnet,
ethereum:mainnet,
arbitrum:mainnet
​
sender
string
required

The address of the transaction sender.

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

​
on_behalf_of
string | null

The address on behalf of whom the supply is made

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

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