Pools

Pool management endpoints

get

Authorizations

x-api-keystringRequired

API key for authentication

Query parameters

networkstringRequired

The address of the blockchain network

Example: arbitrum

pagenumberOptional

The page number to retrieve

Default: 0

limitnumberOptional

The number of items to return per page

Default: 100

Responses

200

Successful response

application/json

401

Unauthorized.

403

Forbidden.

408

Request timeout.

429

Too many requests.

500

Internal server error

get

/api/v1/pools

GET /api/v1/pools?network=arbitrum HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "data": {
    "totalItems": 1,
    "pools": [
      {
        "positionId": "0xba264514ca70c33a0e71939717c11fde99e74b779ae1c0f60e9fe2bef91a8d8d",
        "name": "My Pool Party Position",
        "description": "This is a description of my pool party position.",
        "pool": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "poolView": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "poolManager": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "poolManagerFee": "0.01",
        "currency0": {
          "address": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
          "symbol": "WETH",
          "name": "Wrapped Ether",
          "decimals": 18,
          "imageUrl": "https://example.com/images/weth.png"
        },
        "currency1": {
          "address": "0x82af49447d8a07e3bd95bd0d56f35241523fbab1",
          "symbol": "WETH",
          "name": "Wrapped Ether",
          "decimals": 18,
          "imageUrl": "https://example.com/images/weth.png"
        },
        "poolTvlUsd": 1000000,
        "feesApr": 0.05,
        "poolFeeTier": "500",
        "tokenId": "34567",
        "version": 1,
        "inRange": true,
        "tickLower": -100,
        "tickUpper": 100,
        "closed": false,
        "totalInvestors": "100",
        "dexPoolAddress": "0x10dc9E9fB8DB5F51Cb192407D30c71f02433c810",
        "dexPoolTvlUsd": 500000,
        "creationTime": "1674820641",
        "totalSupply0": "1000000000000000000",
        "totalSupply1": "2000000000000000000",
        "refund0": "50000000000000000",
        "refund1": "100000000000000000",
        "tokensOwed0": "30000000000000000",
        "tokensOwed1": "60000000000000000",
        "totalDepositedFees0": "20000000000000000",
        "totalDepositedFees1": "40000000000000000",
        "isAllLiquiditySwappedToStableCurrency": true
      }
    ]
  }
}

get