Notus API
Liquidity pools

Create Liquidity

This endpoint creates liquidity for a liquidity pool

POST
/api/v1/liquidity/create

Authorization

x-api-key<token>

In: header

Request Body

liquidityProvider?string

Optional provider for entering a liquidity pool. If not provided, Uniswap v3 will be used.

Value in"UNISWAP_V3"
walletAddressstring

The wallet address (in hexadecimal format) that will provide the liquidity.

Match^0x[a-fA-F0-9]{40}$
toAddressstring

The address (in hexadecimal format) receiving the token that represents the provided liquidity.

Match^0x[a-fA-F0-9]{40}$
chainIdnumber

The blockchain network where the liquidity will be provided. Supported EVM chains:

  • Arbitrum One: 42161
  • Avalanche: 43114
  • Base: 8453
  • BNB Smart Chain: 56
  • Ethereum: 1
  • Gnosis: 100
  • OP Mainnet: 10
  • Polygon: 137
transactionFeePercent?number

Percentage fee applied to the transaction (e.g., 5 for 5%).

Default0
Range0 <= value <= 99.99
payGasFeeTokenstring

The token address (in hexadecimal format) used to pay the transaction fee.

Match^0x[a-fA-F0-9]{40}$
gasFeePaymentMethodstring

Defines how the fee will be paid: "ADD_TO_AMOUNT" adds it to the input amount, while "DEDUCT_FROM_AMOUNT" subtracts it from the input amount.

Value in"ADD_TO_AMOUNT" | "DEDUCT_FROM_AMOUNT"
token0string

The address (in hexadecimal format) of one of the tokens of the pool.

Match^0x[a-fA-F0-9]{40}$
token1string

The address (in hexadecimal format) of the other token of the pool.

Match^0x[a-fA-F0-9]{40}$
poolFeePercentnumber

Defines the fee earned by providing liquidity. Lower values are recommended for more stable tokens, while higher values are better suited for volatile assets. The values allowed depend on the provider, so check the provider docs too to know which fee tiers are allowed.

Range0.01 <= value <= 100
token0Amountstring

The amount of token0 to add to the liquidity pool, expressed as a decimal string.

token1Amountstring

The amount of token1 to add to the liquidity pool, expressed as a decimal string.

minPricenumber

Minimum price the liquidity will be active. If the price goes below this, the liquidity won't be active and will generate no revenues. This will allow to concentrate the liquidity to a price range, thus enhancing the gains. Price is always p = token1 / token0

Range0 <= value
maxPricenumber

Maximum price the liquidity will be active. If the price goes above this, the liquidity won't be active and will generate no revenues. This will allow to concentrate the liquidity to a price range, thus enhancing the gains. Price is always p = token1 / token0

Range0 <= value
slippage?number

Optional parameter controlling the maximum deviation allowed of the expected price of a trade and the actual price at which the trade is executed, with a minimum value of 0.5 and a maximum value of 99, default is 0.5, where 1 unit equals 1%.

Default0.5
Range0.5 <= value <= 99
metadata?object

Empty Object

Response Body

curl -X POST "https://api.notus.team/api/v1/liquidity/create" \  -H "Content-Type: application/json" \  -d '{    "walletAddress": "0x6e397ddf51d9f15dbe0414538e7529f51f2e5464",    "toAddress": "0x1337133713371337133713371337133713371337",    "chainId": 42161,    "payGasFeeToken": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",    "gasFeePaymentMethod": "ADD_TO_AMOUNT",    "token0": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",    "token1": "0xaf88d065e77c8cc2239327c5edb3a432268e5831",    "poolFeePercent": 1,    "token0Amount": "26.2345",    "token1Amount": "1823.2",    "minPrice": 83475.12,    "maxPrice": 102300.5  }'
{
  "operation": {
    "liquidityProvider": "UNISWAP_V3",
    "walletAddress": "0x6e397ddf51d9f15dbe0414538e7529f51f2e5464",
    "toAddress": "0x1337133713371337133713371337133713371337",
    "chainId": 42161,
    "transactionFeePercent": 2.5,
    "payGasFeeToken": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
    "gasFeePaymentMethod": "ADD_TO_AMOUNT",
    "token0": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
    "token1": "0xaf88d065e77c8cc2239327c5edb3a432268e5831",
    "poolFeePercent": 1,
    "token0Amount": "26.2345",
    "token1Amount": "1823.2",
    "minPrice": 83475.12,
    "maxPrice": 102300.5,
    "slippage": 1.2,
    "metadata": {
      "key": "value"
    }
  }
}
{
  "statusCode": 400,
  "id": "NOT_AUTHORIZED_TOKENS",
  "message": ""
}
{
  "statusCode": 403,
  "id": "UNAVAILABLE_COMPUTE_UNITS",
  "message": "The project doesn't have enough compute units to perform this action. Please upgrade your plan."
}
{
  "statusCode": 404,
  "id": "ACCOUNT_ABSTRACTION_ADDRESS_NOT_REGISTERED_WITH_PROJECT",
  "message": "The requested wallet \"0x6e397ddf51d9f15dbe0414538e7529f51f2e5464\" is not registered with the project"
}

Collect fees from liquidity POST

Collects the fees received by the liquidity NFT. This will both create a user operation to be executed and will show how much will be collected, so you can choose if you really want to collect it or not. Always collects the full amount.

Get Liquidity Amounts GET

Get the amounts of tokens needed to provide liquidity to a pool based on the maximum you want to spend in one token. You can pass the max amount for both tokens and receive quotes for the two possible scenarios, this way you can check in a single call what option works based on the amounts your user has. E.g. your user wants to provide liquidity to the ETH-USDC pool, and they have 100 USDC and 100 ETH in their wallet. By passing both as the max amounts in `tokenXMaxAmount` you'll get two quotes. One telling how much ETH you need to provided if you send 100 USDC and another telling how much USDC you need to provide given 100 ETH. Then you can choose which one actually fits the liquidity your user has. **Note**: If only one of them is returned it means the price range is outside the current price, so only one token can be provided to create liquidity, the other will always be zero.