Skip to main content
POST
Python (SDK)

Authorizations

x-api-key
string
header
required

Your Compass API Key. Get your key here.

Body

application/json
token_id
integer
default:17570780
required

Token ID of the NFT representing the liquidity provisioned position.

Example:

17570780

amount0_desired
default:0.02
required

The desired amount of the first token to deposit

Required range: x >= 0
Example:

"1.5"

amount1_desired
default:0.01
required

The desired amount of the second token to deposit

Required range: x >= 0
Example:

"1.7"

amount0_min
default:0
required

The minimum amount of the first token to deposit

Required range: x >= 0
Example:

"1.4"

amount1_min
default:0
required

The minimum amount of the second token to deposit

Required range: x >= 0
Example:

"1.6"

chain
enum<string>
default:base
required
Available options:
base
Example:

"base"

sender
string
default:0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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

Example: