POST
/
v0
/
uniswap
/
liquidity_provision
/
mint
from compassapisdk import CompassAPISDK, models


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

    res = compass_api_sdk.uniswap_v3.liquidity_provision_mint(token0=models.TokenEnum.CB_ETH, token1=models.TokenEnum.BAL, fee=models.FeeEnum.ZERO_DOT_01, tick_lower=-1000, tick_upper=1000, amount0_desired="1.5", amount1_desired="1.7", amount0_min="1.4", amount1_min="1.6", chain=models.Chain.BASE_MAINNET, sender="0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B", recipient="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

Request model for minting a new liquidity position.

​
token0
enum<string>
required

The symbol of the first token in the pair.

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
​
token1
enum<string>
required

The symbol of the second token in the pair.

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
​
fee
enum<string>
required

The swap fee of the pool

Available options:
0.01,
0.05,
0.3,
1.0
​
tick_lower
integer
required

The lower tick of the range to mint the position in

Required range: -887272 <= x <= 887272
Examples:

-1000

​
tick_upper
integer
required

The upper tick of the range to mint the position in

Required range: -887272 <= x <= 887272
Examples:

1000

​
amount0_desired
required

The desired amount of the first token to deposit

Required range: x >= 0
Examples:

"1.5"

​
amount1_desired
required

The desired amount of the second token to deposit

Required range: x >= 0
Examples:

"1.7"

​
amount0_min
required

The minimum amount of the first token to deposit

Required range: x >= 0
Examples:

"1.4"

​
amount1_min
required

The minimum amount of the second token to deposit

Required range: x >= 0
Examples:

"1.6"

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

​
recipient
string | null

The address that will receive the LP tokens

Examples:

"0x29F20a192328eF1aD35e1564aBFf4Be9C5ce5f7B"

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