Python (SDK)

from compass_api_sdk import CompassAPI, models


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

    res = compass_api.uniswap_v3.uniswap_liquidity_provision_increase(token_id=3432182, amount0_desired="0.3", amount1_desired="0.0", amount0_min="0.00", amount1_min="0.00", chain=models.UniswapIncreaseLiquidityProvisionRequestChain.BASE, sender="0x41096de529D54718a5600185F8C4460979ed75C9", 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.uniswapV3.uniswapLiquidityProvisionIncrease({
    tokenId: 3432182,
    amount0Desired: "0.3",
    amount1Desired: "0.0",
    amount0Min: "0.00",
    amount1Min: "0.00",
    chain: "base",
    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.compasslabs.ai/v1/uniswap/liquidity_provision/increase \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "chain": "base",
  "sender": "0x41096de529D54718a5600185F8C4460979ed75C9",
  "token_id": 3432182,
  "amount0_desired": "0.3",
  "amount1_desired": "0.0",
  "amount0_min": "0.00",
  "amount1_min": "0.00"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 'base',
    sender: '0x41096de529D54718a5600185F8C4460979ed75C9',
    token_id: 3432182,
    amount0_desired: '0.3',
    amount1_desired: '0.0',
    amount0_min: '0.00',
    amount1_min: '0.00'
  })
};

fetch('https://api.compasslabs.ai/v1/uniswap/liquidity_provision/increase', 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/uniswap/liquidity_provision/increase",
  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([
    'chain' => 'base',
    'sender' => '0x41096de529D54718a5600185F8C4460979ed75C9',
    'token_id' => 3432182,
    'amount0_desired' => '0.3',
    'amount1_desired' => '0.0',
    'amount0_min' => '0.00',
    'amount1_min' => '0.00'
  ]),
  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/uniswap/liquidity_provision/increase"

	payload := strings.NewReader("{\n  \"chain\": \"base\",\n  \"sender\": \"0x41096de529D54718a5600185F8C4460979ed75C9\",\n  \"token_id\": 3432182,\n  \"amount0_desired\": \"0.3\",\n  \"amount1_desired\": \"0.0\",\n  \"amount0_min\": \"0.00\",\n  \"amount1_min\": \"0.00\"\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/uniswap/liquidity_provision/increase")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chain\": \"base\",\n  \"sender\": \"0x41096de529D54718a5600185F8C4460979ed75C9\",\n  \"token_id\": 3432182,\n  \"amount0_desired\": \"0.3\",\n  \"amount1_desired\": \"0.0\",\n  \"amount0_min\": \"0.00\",\n  \"amount1_min\": \"0.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v1/uniswap/liquidity_provision/increase")

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  \"chain\": \"base\",\n  \"sender\": \"0x41096de529D54718a5600185F8C4460979ed75C9\",\n  \"token_id\": 3432182,\n  \"amount0_desired\": \"0.3\",\n  \"amount1_desired\": \"0.0\",\n  \"amount0_min\": \"0.00\",\n  \"amount1_min\": \"0.00\"\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>"
    }
  ]
}

Uniswap V3

Increase an LP position

This endpoint allows users to increase their existing Liquidity Provider (LP) positions on the Uniswap platform.

By providing the necessary parameters, users can add more liquidity to their current positions, thereby increasing their stake in the liquidity pool. This operation is beneficial for users who wish to enhance their potential earnings from trading fees within the pool. The endpoint requires details such as the token pair, additional amount to be added, and any other parameters necessary for the liquidity increase process.

Required Allowances

In order to make this transaction, token allowances need to be set for the following contracts.

AerodromeSlipstreamRouter

POST

uniswap

liquidity_provision

increase

Python (SDK)

from compass_api_sdk import CompassAPI, models


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

    res = compass_api.uniswap_v3.uniswap_liquidity_provision_increase(token_id=3432182, amount0_desired="0.3", amount1_desired="0.0", amount0_min="0.00", amount1_min="0.00", chain=models.UniswapIncreaseLiquidityProvisionRequestChain.BASE, sender="0x41096de529D54718a5600185F8C4460979ed75C9", 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.uniswapV3.uniswapLiquidityProvisionIncrease({
    tokenId: 3432182,
    amount0Desired: "0.3",
    amount1Desired: "0.0",
    amount0Min: "0.00",
    amount1Min: "0.00",
    chain: "base",
    sender: "0x41096de529D54718a5600185F8C4460979ed75C9",
  });

  console.log(result);
}

run();

curl --request POST \
  --url https://api.compasslabs.ai/v1/uniswap/liquidity_provision/increase \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "chain": "base",
  "sender": "0x41096de529D54718a5600185F8C4460979ed75C9",
  "token_id": 3432182,
  "amount0_desired": "0.3",
  "amount1_desired": "0.0",
  "amount0_min": "0.00",
  "amount1_min": "0.00"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    chain: 'base',
    sender: '0x41096de529D54718a5600185F8C4460979ed75C9',
    token_id: 3432182,
    amount0_desired: '0.3',
    amount1_desired: '0.0',
    amount0_min: '0.00',
    amount1_min: '0.00'
  })
};

fetch('https://api.compasslabs.ai/v1/uniswap/liquidity_provision/increase', 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/uniswap/liquidity_provision/increase",
  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([
    'chain' => 'base',
    'sender' => '0x41096de529D54718a5600185F8C4460979ed75C9',
    'token_id' => 3432182,
    'amount0_desired' => '0.3',
    'amount1_desired' => '0.0',
    'amount0_min' => '0.00',
    'amount1_min' => '0.00'
  ]),
  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/uniswap/liquidity_provision/increase"

	payload := strings.NewReader("{\n  \"chain\": \"base\",\n  \"sender\": \"0x41096de529D54718a5600185F8C4460979ed75C9\",\n  \"token_id\": 3432182,\n  \"amount0_desired\": \"0.3\",\n  \"amount1_desired\": \"0.0\",\n  \"amount0_min\": \"0.00\",\n  \"amount1_min\": \"0.00\"\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/uniswap/liquidity_provision/increase")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"chain\": \"base\",\n  \"sender\": \"0x41096de529D54718a5600185F8C4460979ed75C9\",\n  \"token_id\": 3432182,\n  \"amount0_desired\": \"0.3\",\n  \"amount1_desired\": \"0.0\",\n  \"amount0_min\": \"0.00\",\n  \"amount1_min\": \"0.00\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.compasslabs.ai/v1/uniswap/liquidity_provision/increase")

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  \"chain\": \"base\",\n  \"sender\": \"0x41096de529D54718a5600185F8C4460979ed75C9\",\n  \"token_id\": 3432182,\n  \"amount0_desired\": \"0.3\",\n  \"amount1_desired\": \"0.0\",\n  \"amount0_min\": \"0.00\",\n  \"amount1_min\": \"0.00\"\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 increasing liquidity provision in Uniswap V3.

token_id

integer

default:3432182

required

Token ID of the NFT representing the liquidity provisioned position.

Example:

3432182

amount0_desired

default:0.3

required

The desired amount of the first token to deposit

Example:

"1.5"

amount1_desired

default:0.0

required

The desired amount of the second token to deposit

Example:

"1.7"

amount0_min

default:0.00

required

The minimum amount of the first token to deposit

Example:

"1.4"

amount1_min

default:0.00

required

The minimum amount of the second token to deposit

Example:

"1.6"

chain

enum<string>

default:base

required

Available options:

arbitrum,

base,

ethereum

Example:

"base"

sender

string

default:0x41096de529D54718a5600185F8C4460979ed75C9

required

The address of the transaction sender.

Example:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

action_type

string

default:UNISWAP_ADD_LIQUIDITY

Allowed value: "UNISWAP_ADD_LIQUIDITY"

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.

UnsignedTransaction
UserOperationResponse

Show child attributes

Example:

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

⌘I