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)
import { CompassApiSDK } from "@compass-labs/api-sdk";

const compassApiSDK = new CompassApiSDK({
apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
const result = await compassApiSDK.aerodromeSlipstream.aerodromeSlipstreamLiquidityProvisionMint({
token0: "USDC",
token1: "USDT",
tickSpacing: 1,
tickLower: 100,
tickUpper: 200,
amount0Desired: 0.01,
amount1Desired: 0,
amount0Min: 0,
amount1Min: 0,
recipient: "0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a",
chain: "base",
sender: "0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a",
});

console.log(result);
}

run();
curl --request POST \
--url https://api.compasslabs.ai/v1/aerodrome_slipstream/liquidity_provision/mint \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"sender": "0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a",
"chain": "base",
"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,
"recipient": "0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a"
}
'
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
sender: '0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a',
chain: 'base',
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,
recipient: '0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a'
})
};

fetch('https://api.compasslabs.ai/v1/aerodrome_slipstream/liquidity_provision/mint', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.compasslabs.ai/v1/aerodrome_slipstream/liquidity_provision/mint",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sender' => '0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a',
'chain' => 'base',
'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,
'recipient' => '0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.compasslabs.ai/v1/aerodrome_slipstream/liquidity_provision/mint"

payload := strings.NewReader("{\n \"sender\": \"0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a\",\n \"chain\": \"base\",\n \"token0\": \"USDC\",\n \"token1\": \"USDT\",\n \"tick_spacing\": 1,\n \"tick_lower\": 100,\n \"tick_upper\": 200,\n \"amount0_desired\": 0.01,\n \"amount1_desired\": 0,\n \"amount0_min\": 0,\n \"amount1_min\": 0,\n \"recipient\": \"0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.compasslabs.ai/v1/aerodrome_slipstream/liquidity_provision/mint")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sender\": \"0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a\",\n \"chain\": \"base\",\n \"token0\": \"USDC\",\n \"token1\": \"USDT\",\n \"tick_spacing\": 1,\n \"tick_lower\": 100,\n \"tick_upper\": 200,\n \"amount0_desired\": 0.01,\n \"amount1_desired\": 0,\n \"amount0_min\": 0,\n \"amount1_min\": 0,\n \"recipient\": \"0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v1/aerodrome_slipstream/liquidity_provision/mint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sender\": \"0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a\",\n \"chain\": \"base\",\n \"token0\": \"USDC\",\n \"token1\": \"USDT\",\n \"tick_spacing\": 1,\n \"tick_lower\": 100,\n \"tick_upper\": 200,\n \"amount0_desired\": 0.01,\n \"amount1_desired\": 0,\n \"amount0_min\": 0,\n \"amount1_min\": 0,\n \"recipient\": \"0x46D00E3Dc6E9B788B9730Ab38433a16CB55EDd7a\"\n}"

response = http.request(request)
puts response.read_body
{
  "transaction": {
    "chainId": "0x2105",
    "data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
    "from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
    "gas": "0x7a120",
    "maxFeePerGas": "0x59682f00",
    "maxPriorityFeePerGas": "0x3b9aca00",
    "nonce": "0x5",
    "to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
    "value": "0x0"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<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
Example:

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

Example:
{
"chainId": "0x2105",
"data": "0x1688f0b900000000000000000000000029fcb43b46531bca003ddc8fcb67ffe91900c762000000000000000000000000000000000000000000000000000000000000006000000000000000000000000000000000000000000000000000000000675f4a3d",
"from": "0x4A83b4413CF41C3244027e1590E35a0F48403F0c",
"gas": "0x7a120",
"maxFeePerGas": "0x59682f00",
"maxPriorityFeePerGas": "0x3b9aca00",
"nonce": "0x5",
"to": "0x4e1DCf7AD4e460CfD30791CCC4F9c8a4f820ec67",
"value": "0x0"
}