> ## Documentation Index > Fetch the complete documentation index at: https://tech.ramses.xyz/llms.txt > Use this file to discover all available pages before exploring further. # Get pools with filtering > Returns liquidity pools with pagination, filtering, and sorting options. ## OpenAPI ````yaml https://gateway.ramses.xyz/v3/hyperevm/swagger/json get /pools openapi: 3.1.0 info: title: Ramses API - HyperEVM description: |- REST API for the Ramses DEX on HyperEVM. ## Rate Limiting - **30 requests per 30 seconds** per client IP address ## Caching Some endpoints are cached to improve performance: - `/stats`: 60 seconds - `/protocol-info`: 30 seconds - `/hyperram-data`: 30 seconds - `/circ_supply`, `/fdv`, `/hyperram_fdv`: 5 minutes version: 4.0.0 contact: name: Ramses url: https://gateway.ramses.xyz/v3/hyperevm license: name: MIT url: https://opensource.org/licenses/MIT servers: - url: https://gateway.ramses.xyz/v3/hyperevm description: Production security: [] tags: - name: Health description: API and indexer health status - name: Pools description: Liquidity pool data, TVL, APRs, and rewards - name: Tokens description: Token information and prices - name: Stats description: Historical protocol and pool statistics - name: Protocol description: Protocol-wide token supply, emissions, and voting metrics - name: Positions description: User position data - name: HyperRAM description: X33 token compound/rebase data and APR calculations - name: CoinGecko description: Endpoints for CoinGecko integration (supply data) - name: Fee Launcher description: Dynamic fee schedules for new pool launches paths: /pools: get: tags: - Pools summary: Get pools with filtering description: Returns liquidity pools with pagination, filtering, and sorting options. operationId: getPools parameters: - name: limit in: query required: false schema: description: 'Maximum number of pools to return (default: 100)' type: number - name: offset in: query required: false schema: description: 'Number of pools to skip (default: 0)' type: number - name: isCl in: query required: false schema: description: Filter by concentrated liquidity pools type: boolean - name: hasActiveGauge in: query required: false schema: description: Filter by pools with active gauges type: boolean - name: orderBy in: query required: true schema: default: tvlUsd description: Field to sort by type: string enum: - tvlUsd - lpApr - voteApr - lpRewardsUsd - voterRewardsUsd - name: orderDirection in: query required: true schema: default: desc description: Sort direction type: string enum: - desc - asc responses: '200': description: Paginated pools response content: application/json: schema: description: Paginated pools response examples: - totalPools: 150 pools: - id: '0x1234567890abcdef1234567890abcdef12345678' symbol: USDC/WETH type: UNKNOWN token0: id: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' address: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' symbol: USDC name: USD Coin decimals: 6 priceUsd: 1 token1: id: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2' address: '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2' symbol: WETH name: Wrapped Ether decimals: 18 priceUsd: 3500 feeTier: 3000 feeProtocol: 0 reserve0: 1000000 reserve1: 285.71 reserve0Usd: 1000000 reserve1Usd: 1000000 tvlUsd: 2000000 lpRewardsUsd: 5000 voterRewardsUsd: 2000 isCl: true isStable: false hasDynamicFees: false hasCorrelatedTokens: false hasGauge: true hasActiveGauge: true totalVeShareByPeriod: '1000000000000000000000' lpPrice: 1.5 lpApr: 25.5 feeApr: 10.2 rewardApr: 15.3 voteApr: 8.5 last24hVolume: 500000 last24hFees: 1500 last7dVolume: 3500000 last7dFees: 10500 type: object properties: totalPools: description: Total number of pools matching query type: number pools: type: array items: description: Liquidity pool information type: object properties: id: description: Pool contract address type: string symbol: description: Pool symbol (e.g., USDC/WETH) examples: - USDC/WETH type: string type: description: Pool type classification examples: - STABLE/STABLE - LST/LST - UNKNOWN type: string token0: description: Token information with current USD price type: object properties: id: description: Token contract address type: string address: description: Token contract address type: string symbol: description: Token symbol (e.g., USDC) type: string name: description: Token name (e.g., USD Coin) type: string decimals: description: Token decimals (e.g., 18) type: number priceUsd: description: Current price in USD type: number required: - id - address - symbol - decimals - priceUsd token1: description: Token information with current USD price type: object properties: id: description: Token contract address type: string address: description: Token contract address type: string symbol: description: Token symbol (e.g., USDC) type: string name: description: Token name (e.g., USD Coin) type: string decimals: description: Token decimals (e.g., 18) type: number priceUsd: description: Current price in USD type: number required: - id - address - symbol - decimals - priceUsd feeTier: description: Fee tier in basis points (e.g., 3000 = 0.3%) type: number feeProtocol: description: Protocol fee setting type: number tokensStaked: anyOf: - description: Amount of LP tokens staked in gauge (wei) type: string - type: 'null' gaugeAddress: anyOf: - description: Gauge contract address type: string - type: 'null' gaugeRewardTokens: anyOf: - description: Addresses of gauge reward tokens type: array items: type: string - type: 'null' feeDistributorAddress: anyOf: - description: Fee distributor contract address type: string - type: 'null' feeDistributorRewardTokens: anyOf: - description: Addresses of fee distributor reward tokens type: array items: type: string - type: 'null' reserve0: description: Reserve of token0 (normalized) type: number reserve1: description: Reserve of token1 (normalized) type: number reserve0Usd: description: Reserve of token0 in USD type: number reserve1Usd: description: Reserve of token1 in USD type: number tvlUsd: description: Total value locked in USD type: number lpRewardsUsd: description: Total LP rewards value per epoch in USD type: number voterRewardsUsd: description: Total voter rewards value per epoch in USD type: number lpRewards: anyOf: - description: LP reward details type: array items: description: Liquidity provider reward information type: object properties: token: description: Token information with current USD price type: object properties: id: description: Token contract address type: string address: description: Token contract address type: string symbol: description: Token symbol (e.g., USDC) type: string name: description: Token name (e.g., USD Coin) type: string decimals: description: Token decimals (e.g., 18) type: number priceUsd: description: Current price in USD type: number required: - id - address - symbol - decimals - priceUsd rate: description: Reward rate per second (wei) type: string usdValue: description: USD value of rewards per epoch type: number periodFinish: description: Unix timestamp when reward period ends type: number required: - token - rate - usdValue - type: 'null' voterRewards: anyOf: - description: Voter reward details type: array items: description: Voter reward information (bribes/fees) type: object properties: token: description: Token information with current USD price type: object properties: id: description: Token contract address type: string address: description: Token contract address type: string symbol: description: Token symbol (e.g., USDC) type: string name: description: Token name (e.g., USD Coin) type: string decimals: description: Token decimals (e.g., 18) type: number priceUsd: description: Current price in USD type: number required: - id - address - symbol - decimals - priceUsd amount: description: Total reward amount (wei) type: string usdValue: description: USD value of rewards type: number required: - token - amount - usdValue - type: 'null' isCl: description: Is concentrated liquidity pool type: boolean isStable: description: Is stable pool (legacy AMM only) type: boolean hasDynamicFees: description: Has dynamic fee adjustment type: boolean hasCorrelatedTokens: description: Pool contains correlated token pair type: boolean hasGauge: description: Has associated gauge type: boolean hasActiveGauge: description: Gauge is active and receiving emissions type: boolean totalVeShareByPeriod: description: Total veToken voting power for this pool type: string totalSupply: anyOf: - description: Total LP token supply (wei) type: string - type: 'null' lpPrice: description: LP token price in USD type: number lpApr: description: Total LP APR (fees + rewards) type: number feeApr: description: Fee APR from trading activity type: number rewardApr: description: Reward APR from emissions type: number voteApr: description: Voting APR from bribes/fees type: number liquidity: anyOf: - description: Active liquidity (CL pools only) type: string - type: 'null' sqrtPrice: anyOf: - description: Square root price X96 (CL pools only) type: string - type: 'null' tick: anyOf: - description: Current tick (CL pools only) type: number - type: 'null' tickSpacing: anyOf: - description: Tick spacing (CL pools only) type: number - type: 'null' oneTickFeeApr: anyOf: - description: Fee APR for single tick position type: number - type: 'null' oneTickEmissionApr: anyOf: - description: Emission APR for single tick position type: number - type: 'null' pctActiveTvl: anyOf: - description: Percentage of TVL in active tick range type: number - type: 'null' recommendedRanges: anyOf: - description: Recommended position ranges type: array items: description: Recommended position range for CL pools type: object properties: name: description: Range name examples: - Narrow - Wide - Passive type: string value: description: Range value type: number unit: description: Range unit type examples: - pct - tick - tickdelta type: string delta: description: Price delta for this range type: number liquidityUsd: description: Estimated liquidity in USD for this range type: number rewardApr: description: Estimated reward APR for this range type: number feeApr: description: Estimated fee APR for this range type: number lpApr: description: Total LP APR (fees + rewards) type: number default: description: Whether this is the default range type: boolean required: - name - value - unit - delta - liquidityUsd - rewardApr - feeApr - lpApr - type: 'null' last24hVolume: description: Trading volume in last 24 hours type: number last24hFees: description: Fees generated in last 24 hours (USD) type: number last7dVolume: description: Trading volume in last 7 days type: number last7dFees: description: Fees generated in last 7 days (USD) type: number required: - id - symbol - type - token0 - token1 - feeTier - feeProtocol - tokensStaked - gaugeAddress - gaugeRewardTokens - feeDistributorAddress - feeDistributorRewardTokens - reserve0 - reserve1 - reserve0Usd - reserve1Usd - tvlUsd - lpRewardsUsd - voterRewardsUsd - lpRewards - voterRewards - isCl - isStable - hasDynamicFees - hasCorrelatedTokens - hasGauge - hasActiveGauge - totalVeShareByPeriod - totalSupply - lpPrice - lpApr - feeApr - rewardApr - voteApr - liquidity - sqrtPrice - tick - tickSpacing - oneTickFeeApr - oneTickEmissionApr - pctActiveTvl - recommendedRanges - last24hVolume - last24hFees - last7dVolume - last7dFees required: - totalPools - pools ````