> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hadron.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# List Pools

> Returns a paginated list of all Hadron pools with token metadata, TVL, volume, and fees.

## Query Parameters

<Note>
  All filters combine with logical **AND** and stack with `query` search and
  `cluster`. `total` and `pages` reflect the filtered result set. An unrecognized
  `pool_state` value simply returns zero matches.
</Note>

<ParamField query="page" type="integer" default="1">
  1-based page number.
</ParamField>

<ParamField query="page_size" type="integer" default="20">
  Number of pools per page. Maximum `100`.
</ParamField>

<ParamField query="query" type="string">
  Search by pool name, token symbol, mint address, or pool address (configPda).
</ParamField>

<ParamField query="authority" type="string">
  Filter to pools whose `authority` exactly matches this pubkey.
</ParamField>

<ParamField query="quoting_authority" type="string">
  Filter to pools whose `quoting_authority` exactly matches this pubkey.
</ParamField>

<ParamField query="token" type="string">
  Filter to pools that include this mint address on **either** side (`token_x` or `token_y`).
</ParamField>

<ParamField query="token_x" type="string">
  Filter to pools whose base token (`token_x`) mint matches this address.
</ParamField>

<ParamField query="token_y" type="string">
  Filter to pools whose quote token (`token_y`) mint matches this address.
</ParamField>

<ParamField query="pool_state" type="string">
  Filter by pool state. Case-insensitive. One of `Uninitialized`, `Initialized`, `Paused`, `RejectSwaps`, `Closed`.
</ParamField>

<ParamField query="sort_by" type="string" default="volume_24h:desc">
  Sort field and direction. Format: `field:direction`.

  **Fields:** `tvl`, `volume_24h`, `fees_24h`

  **Directions:** `asc`, `desc`
</ParamField>

<ParamField query="cluster" type="string" default="mainnet-beta">
  Solana cluster — `mainnet-beta` or `devnet`.
</ParamField>

## Response

<ResponseField name="total" type="integer">
  Total number of pools matching the query.
</ResponseField>

<ResponseField name="pages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="current_page" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="page_size" type="integer">
  Number of pools per page.
</ResponseField>

<ResponseField name="data" type="array">
  Array of pool objects.

  <Expandable title="Pool object">
    <ResponseField name="address" type="string">
      Pool config PDA address.
    </ResponseField>

    <ResponseField name="name" type="string">
      Pool display name (e.g. `SOL/USDC`).
    </ResponseField>

    <ResponseField name="token_x" type="object">
      Base token metadata.

      <Expandable title="Token object">
        <ResponseField name="address" type="string">Mint address.</ResponseField>
        <ResponseField name="symbol" type="string">Token symbol.</ResponseField>
        <ResponseField name="name" type="string">Token name.</ResponseField>
        <ResponseField name="decimals" type="integer">Token decimals.</ResponseField>
        <ResponseField name="icon" type="string">Token icon URL.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="token_y" type="object">
      Quote token metadata (same shape as `token_x`).
    </ResponseField>

    <ResponseField name="token_x_amount" type="integer">
      Raw vault X balance (base token).
    </ResponseField>

    <ResponseField name="token_y_amount" type="integer">
      Raw vault Y balance (quote token).
    </ResponseField>

    <ResponseField name="pool_config" type="object">
      Pool configuration.

      <Expandable title="Pool config">
        <ResponseField name="authority" type="string">Pool authority pubkey.</ResponseField>
        <ResponseField name="quoting_authority" type="string">Quoting authority pubkey.</ResponseField>
        <ResponseField name="oracle_mode" type="integer">Oracle mode (0 = default).</ResponseField>
        <ResponseField name="pool_state" type="string">Pool state — one of `Uninitialized`, `Initialized`, `Paused`, `RejectSwaps`, or `Closed`.</ResponseField>
        <ResponseField name="base_spread_bps" type="number">Current base spread in basis points.</ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="tvl" type="number">
      Total value locked in USD.
    </ResponseField>

    <ResponseField name="current_price" type="number">
      Current midprice (human-readable, e.g. `87.85` for SOL/USDC).
    </ResponseField>

    <ResponseField name="volume" type="object">
      <ResponseField name="24h" type="number">24-hour trading volume in USD.</ResponseField>
    </ResponseField>

    <ResponseField name="fees" type="object">
      <ResponseField name="24h" type="number">24-hour fees collected in USD.</ResponseField>
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "total": 3,
    "pages": 1,
    "current_page": 1,
    "page_size": 20,
    "data": [
      {
        "address": "7ZRLTJBvJSy9VDyZmDoGW4b7noorCYnLUisyAXh7hxMz",
        "name": "SOL/USDC",
        "token_x": {
          "address": "So11111111111111111111111111111111111111112",
          "symbol": "SOL",
          "name": "SOL",
          "decimals": 9,
          "icon": "https://raw.githubusercontent.com/solana-labs/token-list/main/assets/mainnet/So11111111111111111111111111111111111111112/logo.png"
        },
        "token_y": {
          "address": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v",
          "symbol": "USDC",
          "name": "USDC",
          "decimals": 6,
          "icon": ""
        },
        "token_x_amount": 5413038034,
        "token_y_amount": 515256215,
        "pool_config": {
          "authority": "Bk2qYNMa4hUkbutBcb4JHhMqAbGEFZq4KjicpMCwC2wn",
          "quoting_authority": "Bk2qYNMa4hUkbutBcb4JHhMqAbGEFZq4KjicpMCwC2wn",
          "oracle_mode": 0,
          "pool_state": "Initialized",
          "base_spread_bps": 5.0
        },
        "tvl": 990.81,
        "current_price": 87.85,
        "volume": { "24h": 364.16 },
        "fees": { "24h": 0.59 }
      }
    ]
  }
  ```
</ResponseExample>