> For the complete documentation index, see [llms.txt](https://pool-party-xyz.gitbook.io/pool-party-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://pool-party-xyz.gitbook.io/pool-party-docs/core-api/pools.md).

# Pools

Pool management endpoints

## GET /api/v1/pools

>

```json
{"openapi":"3.0.0","info":{"title":"Pool Party Core API","version":"1.0"},"tags":[{"name":"Pools","description":"Pool management endpoints"}],"security":[{}],"paths":{"/api/v1/pools":{"get":{"operationId":"getPools","parameters":[{"name":"network","required":true,"in":"query","description":"The address of the blockchain network","schema":{"type":"string"}},{"name":"page","required":false,"in":"query","description":"The page number to retrieve","schema":{"default":0,"type":"number"}},{"name":"limit","required":false,"in":"query","description":"The number of items to return per page","schema":{"default":100,"type":"number"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolsResponse"}}}},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden."},"408":{"description":"Request timeout."},"429":{"description":"Too many requests."},"500":{"description":"Internal server error"}},"tags":["Pools"]}}},"components":{"schemas":{"PoolsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PoolsData"}},"required":["data"]},"PoolsData":{"type":"object","properties":{"totalItems":{"type":"number"},"pools":{"description":"Array of pool data","type":"array","items":{"$ref":"#/components/schemas/PoolsResponseDto"}}},"required":["totalItems","pools"]},"PoolsResponseDto":{"type":"object","properties":{"positionId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"pool":{"type":"string"},"poolView":{"type":"string"},"poolManager":{"type":"string"},"poolManagerFee":{"type":"string"},"currency0":{"$ref":"#/components/schemas/CurrencyDto"},"currency1":{"$ref":"#/components/schemas/CurrencyDto"},"poolTvlUsd":{"type":"number"},"feesApr":{"type":"number"},"poolFeeTier":{"type":"string"},"tokenId":{"type":"string"},"version":{"type":"number"},"inRange":{"type":"boolean"},"tickLower":{"type":"number"},"tickUpper":{"type":"number"},"closed":{"type":"boolean"},"totalInvestors":{"type":"string"},"dexPoolAddress":{"type":"string"},"dexPoolTvlUsd":{"type":"number"},"creationTime":{"type":"string"},"totalSupply0":{"type":"string"},"totalSupply1":{"type":"string"},"refund0":{"type":"string"},"refund1":{"type":"string"},"tokensOwed0":{"type":"string"},"tokensOwed1":{"type":"string"},"totalDepositedFees0":{"type":"string"},"totalDepositedFees1":{"type":"string"},"isAllLiquiditySwappedToStableCurrency":{"type":"boolean"}},"required":["positionId","name","description","pool","poolView","poolManager","poolManagerFee","currency0","currency1","poolTvlUsd","feesApr","poolFeeTier","tokenId","version","inRange","tickLower","tickUpper","closed","totalInvestors","dexPoolAddress","dexPoolTvlUsd","creationTime","totalSupply0","totalSupply1","refund0","refund1","tokensOwed0","tokensOwed1","totalDepositedFees0","totalDepositedFees1","isAllLiquiditySwappedToStableCurrency"]},"CurrencyDto":{"type":"object","properties":{"address":{"type":"string"},"symbol":{"type":"string"},"name":{"type":"string"},"decimals":{"type":"number"},"imageUrl":{"type":"string"}},"required":["address","symbol","name","decimals","imageUrl"]}}}}
```

## GET /api/v1/pools/{poolAddress}

>

```json
{"openapi":"3.0.0","info":{"title":"Pool Party Core API","version":"1.0"},"tags":[{"name":"Pools","description":"Pool management endpoints"}],"security":[{}],"paths":{"/api/v1/pools/{poolAddress}":{"get":{"operationId":"getPool","parameters":[{"name":"poolAddress","required":true,"in":"path","schema":{"type":"string"}},{"name":"network","required":true,"in":"query","description":"The address of the blockchain network","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PoolResponse"}}}},"401":{"description":"Unauthorized."},"403":{"description":"Forbidden."},"408":{"description":"Request timeout."},"429":{"description":"Too many requests."},"500":{"description":"Internal server error"}},"tags":["Pools"]}}},"components":{"schemas":{"PoolResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PoolsResponseDto"}},"required":["data"]},"PoolsResponseDto":{"type":"object","properties":{"positionId":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"pool":{"type":"string"},"poolView":{"type":"string"},"poolManager":{"type":"string"},"poolManagerFee":{"type":"string"},"currency0":{"$ref":"#/components/schemas/CurrencyDto"},"currency1":{"$ref":"#/components/schemas/CurrencyDto"},"poolTvlUsd":{"type":"number"},"feesApr":{"type":"number"},"poolFeeTier":{"type":"string"},"tokenId":{"type":"string"},"version":{"type":"number"},"inRange":{"type":"boolean"},"tickLower":{"type":"number"},"tickUpper":{"type":"number"},"closed":{"type":"boolean"},"totalInvestors":{"type":"string"},"dexPoolAddress":{"type":"string"},"dexPoolTvlUsd":{"type":"number"},"creationTime":{"type":"string"},"totalSupply0":{"type":"string"},"totalSupply1":{"type":"string"},"refund0":{"type":"string"},"refund1":{"type":"string"},"tokensOwed0":{"type":"string"},"tokensOwed1":{"type":"string"},"totalDepositedFees0":{"type":"string"},"totalDepositedFees1":{"type":"string"},"isAllLiquiditySwappedToStableCurrency":{"type":"boolean"}},"required":["positionId","name","description","pool","poolView","poolManager","poolManagerFee","currency0","currency1","poolTvlUsd","feesApr","poolFeeTier","tokenId","version","inRange","tickLower","tickUpper","closed","totalInvestors","dexPoolAddress","dexPoolTvlUsd","creationTime","totalSupply0","totalSupply1","refund0","refund1","tokensOwed0","tokensOwed1","totalDepositedFees0","totalDepositedFees1","isAllLiquiditySwappedToStableCurrency"]},"CurrencyDto":{"type":"object","properties":{"address":{"type":"string"},"symbol":{"type":"string"},"name":{"type":"string"},"decimals":{"type":"number"},"imageUrl":{"type":"string"}},"required":["address","symbol","name","decimals","imageUrl"]}}}}
```