Notus API
Liquidity pools

Change Liquidity

Change the amount of liquidity provided in a liquidity pool

POST
/api/v1/liquidity/change

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) who owns the liquidity.

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

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

  • Arbitrum One: 42161
  • Avalanche: 43114
  • Base: 8453
  • BNB Smart Chain: 56
  • Ethereum: 1
  • Gnosis: 100
  • OP Mainnet: 10
  • Polygon: 137
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"
transactionFeePercent?number

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

Default0
Range0 <= value <= 99.99
tokenIdstring

ID of the NFT that represents the liquidity

changeobject
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/change" \  -H "Content-Type: application/json" \  -d '{    "walletAddress": "0x6e397ddf51d9f15dbe0414538e7529f51f2e5464",    "chainId": 42161,    "payGasFeeToken": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",    "gasFeePaymentMethod": "ADD_TO_AMOUNT",    "tokenId": "2375619234",    "change": {      "token0": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",      "token1": "0xaf88d065e77c8cc2239327c5edb3a432268e5831",      "token0Amount": "26.2345",      "token1Amount": "1823.2"    }  }'
{
  "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"
}
{
  "statusCode": 500,
  "id": "BLOCKCHAIN_ERROR",
  "message": "We had a problem fetching the data from the blockchain. If the problem persists, contact our support."
}

Process a standard individual verification session POST

Processes a standard individual verification session after documents have been uploaded. This endpoint triggers the actual verification process using the uploaded document images and personal information provided during session creation.

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.