🤽Pools

Endpoints and responses for SushiSwap UniSwap V3's Pool Data

Pool Specific

Get Pool

GET https://api.pepeanalytics.com/v1/pool/:address

Get data about a specific liquidity pool including quote token price, daily or hourly history, total value locked, and much more.

Path Parameters

Name	Type	Description
address*	String	Uniswap V3 pool address

Query Parameters

Name	Type	Description
history	day | hour	If wanting to see daily history or hourly history
txs_count	Number	If wanting to see pool transactions. Adds the txs property

200: OK Successful Response

{
    data: {
      pool:       {
        address: string
        createdAt: string (UTC)
        txCount: string
        volumeUSD: string
        protocol: 'uniswap' | 'sushiswap';
        usdPrice: string;
        tradeLink?: string;
        tvl: {
          usd: string
          eth: string
        },
        baseToken: {
          address: string
          symbol: string
          name: string
          decimals: string
          price: string
          volume: string
          tvl: string
        },
        quoteToken: {
          address: string
          symbol: string
          name: string
          decimals: string
          price: string
          volume: string
          tvl: string
        }
      }
      history?: [
        {
          timestamp: string (UTC)
          tick: string
          liquidity: string
          txCount: string
          tvlUSD: string
          feesUSD: string
          volumeUSD: string
          open: string
          close: string
          low: string
          high: string
          token0: {
            price: string
            volume: string
          },
          token1: {
            price: string
            volume: string
          }
        }
        ...
      ]
      txs?: [
        {
          pool: string
          address: string
          amount: string
          hash: string
          timestamp: string
          type: 'sell' | 'buy'
        }
        ...
      ]
    }
    message: 'Success'
    isError: false
}

500: Internal Server Error

{
    data: null
    isError: true
    message: any
}

400: Bad Request

{
    data: null
    isError: true
    message: string
}

Get Pool Transactions

GET https://api.pepeanalytics.com/v1/pool/:address/txs

Gets pool transactions

Includes: Wallet address, buy or sell, amount, etc

Path Parameters

Name	Type	Description
address*	String	Pool address

Query Parameters

Name	Type	Description
count	Number	Number of transactions to show (default: 300)
order	asc | desc	Order transactions by date ascending or descending

200: OK Successful response

{
    data: [
        {
              pool: string
              address: string
              amount: string
              hash: string
              timestamp: string
              type: 'sell' | 'buy'
        }
        ...
    ]
    message: 'Success'
    isError: false
}

Multiple Pools

Get Pools

GET https://api.pepeanalytics.com/v1/pools

Gets all available liquidity pools on UniswapV3 and SushiSwap.

Query Parameters

Name	Type	Description
days	String | Number	If wanting to see pools deployed X days since today (Example: '1' to see pools deployed since yesterday)
volume	String | Number	Dollar amount of volume done
liquidity	String | Number	Dollar amount of liquidity in pool
tx_count	String | Number	Minimum number of transactions in pool
show_all	Boolean	Show more than 1000 results
include_token_data	Boolean	Include full token data

200: OK Successful Response

{
    data: [
      {
        address: string
        createdAt: string (UTC)
        txCount: string
        volumeUSD: string
        protocol: 'uniswap' | 'sushiswap';
        usdPrice: string;
        tradeLink?: string;
        tvl: {
          usd: string
          eth: string
        },
        baseToken: {
          address: string
          symbol: string
          name: string
          decimals: string
          price: string
          volume: string
          tvl: string
        },
        quoteToken: {
          address: string
          symbol: string
          name: string
          decimals: string
          price: string
          volume: string
          tvl: string
        }
      }
      ...
    ]
    message: 'Success'
    isError: false
}

500: Internal Server Error Error

{
    data: null
    isError: true
    message: any
}

Get Pools Count

GET https://api.pepeanalytics.com/v1/pools/count

Displays number of liquidity pools deployed on various DEX's including UniswapV2, Sushiswap, and more.

200: OK Successful response

{
    data: number
    message: 'Success'
    isError: false
}