Documentation - Notus API

List liquidity pools that exist on the blockchain. The pool can be in a broken state, like having nearly no liquidity. Use the data returned by this endpoint to asses if the pool is worth investing into. Choose the aggregation interval to control both granularity and time range: DAILY (last 30 days), WEEKLY (last 12 weeks), MONTHLY (last 12 months).

Authorization

x-api-key<token>

In: header

Query Parameters

take?integer

Maximum amount of pools per page.

Default10

Range1 <= value <= 50

offset?integer

Number of pools to skip. Used for paging the results.

Default0

Range0 <= value <= 9007199254740991

chainIds?array<number>

Filter by chains. Supported EVM chains:

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

tokensAddresses?array<string>

Filter by tokens

filterWhitelist?boolean

Filter results by the project whitelist, setting to false returns all pools regardless of your whitelist

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

ids?array<string>

Filter by pool ids

Response Body

curl -X GET "https://api.notuslabs.xyz/api/v1/liquidity/pools?take=10&offset=150&chainIds=42161%2C43114&tokensAddresses=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48%2C0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&filterWhitelist=false&rangeInDays=30&ids=137-0x5b5bf85e5dc1e76ff90025ac5d8e8595fb575443"

curl -X GET "https://api.notuslabs.xyz/api/v1/liquidity/pools?take=10&offset=150&chainIds=42161%2C43114&tokensAddresses=0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48%2C0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2&filterWhitelist=false&rangeInDays=30&ids=137-0x5b5bf85e5dc1e76ff90025ac5d8e8595fb575443"

{
  "pools": [
    {
      "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."
}

{
  "statusCode": 500,
  "id": "DB_API_FAILED",
  "message": "We had a problem fetching the data from our metadata servers. If the problem persists, contact our support."
}

List Liquidity Pools

Authorization

Query Parameters

Response Body

200

403

500