Notus API
Liquidity pools

Get Liquidity Pool

Get liquidity pool by pool ID with aggregated stats

GET
/api/v1/liquidity/pools/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

idstring

The unique identifier of the pool

Length1 <= length

Query Parameters

rangeInDays?integer

Number of days to aggregate pool statistics for. Must be between 1 and 365 days. Default is 30 days.

Default30
Range1 <= value <= 365

Response Body

curl -X GET "https://api.notus.team/api/v1/liquidity/pools/137-0x4CcD010148379ea531D6C587CfDd60180196F9b1?rangeInDays=30"
{
  "pool": {
    "provider": {
      "name": "XY",
      "logoUrl": "https://assets.notus.team/Lifi.png",
      "explorerURL": "https://explorer.li.fi"
    },
    "address": "0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640",
    "chain": {
      "id": 137,
      "name": "POLYGON",
      "logo": "https://logopolygon.com"
    },
    "fee": 0.05,
    "totalValueLockedUSD": "10000.453",
    "tokens": [
      {
        "name": "Wrapped Bitcoin",
        "symbol": "WBTC",
        "decimals": 18,
        "address": "0x2f2a2543b76a4166549f7aab2e75bef0aefc5b0f",
        "poolShareInPercentage": 50.5,
        "poolShare": 1000.25,
        "logo": "https://assets.notus.team/wbtc.png"
      }
    ],
    "stats": {
      "rangeInDays": 30,
      "feesInUSD": "1500.75",
      "volumeInUSD": "50000.25",
      "transactionsCount": 1250
    }
  }
}
{
  "statusCode": 403,
  "id": "UNAVAILABLE_COMPUTE_UNITS",
  "message": "The project doesn't have enough compute units to perform this action. Please upgrade your plan."
}

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.

Get Pool Historical Data GET

Get detailed historical data for a specific pool including volume and fees over time