Skip to main content
POST
/
v1
/
aerodrome_slipstream
/
liquidity_provision
/
mint
Python (SDK)
from compass_api_sdk import CompassAPI, models


with CompassAPI(
    api_key_auth="<YOUR_API_KEY_HERE>",
) as compass_api:

    res = compass_api.aerodrome_slipstream.aerodrome_slipstream_liquidity_provision_mint(token0="USDC", token1="USDT", tick_spacing=1, tick_lower=100, tick_upper=200, amount0_desired=0.01, amount1_desired=0, amount0_min=0, amount1_min=0, chain=models.AerodromeSlipstreamMintLiquidityProvisionRequestChain.BASE, sender="0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a", recipient="0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a", 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

Request model for minting a new liquidity position.

token0
string
default:USDC
required

The symbol or address of the first token in the pair.

Example:

"WETH"

token1
string
default:USDT
required

The symbol or address of the second token in the pair.

Example:

"USDC"

tick_spacing
integer
default:1
required

The tick spacing of the pool

Required range: x >= 1
Examples:

100

300

400

500

1000

1500

2500

2700

3000

5000

6000

7000

8000

9000

10000

20000

tick_lower
integer
default:100
required

The lower tick of the range to mint the position in

Example:

-1000

tick_upper
integer
default:200
required

The upper tick of the range to mint the position in

Example:

1000

amount0_desired
default:0.01
required

The desired amount of the first token to deposit

Required range: x >= 0
Example:

"1.5"

amount1_desired
default:0
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
sender
string
default:0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a
required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type
string
default:AERODROME_SLIPSTREAM_MINT_LIQUIDITY_PROVISION
Allowed value: "AERODROME_SLIPSTREAM_MINT_LIQUIDITY_PROVISION"
recipient
string | null
default:0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a

The address that will receive the LP tokens

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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.