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

# List Tokens

> Retrieve a paginated list of tokens with advanced filtering and sorting options

## Query Parameters

<ParamField query="page" type="number" default="1">
  Page number for pagination
</ParamField>

<ParamField query="search" type="string">
  Search by token name, ticker, description, owner address, or token address
</ParamField>

<ParamField query="status" type="string">
  Filter by status. Comma-separated values: `live`, `funding`
</ParamField>

<ParamField query="sortBy" type="string" default="newest">
  Sort order. Options: `newest`, `oldest`, `trending`, `mcap-high`, `mcap-low`
</ParamField>

<ParamField query="timeframe" type="string" default="24h">
  Timeframe for trending calculation. Options: `5m`, `1h`, `6h`, `24h`
</ParamField>

<ParamField query="socials" type="string">
  Filter by social links. Comma-separated values: `telegram`, `twitter`, `website`
</ParamField>

<ParamField query="fundingMin" type="number">
  Minimum funding progress (0-1)
</ParamField>

<ParamField query="fundingMax" type="number">
  Maximum funding progress (0-1)
</ParamField>

<ParamField query="marketCapMin" type="number">
  Minimum market cap in ETH
</ParamField>

<ParamField query="marketCapMax" type="number">
  Maximum market cap in ETH
</ParamField>

<ParamField query="txCountMin" type="number">
  Minimum transaction count
</ParamField>

<ParamField query="txCountMax" type="number">
  Maximum transaction count
</ParamField>

<ParamField query="createdFrom" type="string">
  Filter tokens created after this date (ISO format)
</ParamField>

<ParamField query="createdTo" type="string">
  Filter tokens created before this date (ISO format)
</ParamField>

## Response

<ResponseField name="tokens" type="array">
  Array of token objects

  <Expandable title="Token Object">
    <ResponseField name="address" type="string">
      Token contract address
    </ResponseField>

    <ResponseField name="name" type="string">
      Token name
    </ResponseField>

    <ResponseField name="ticker" type="string">
      Token symbol
    </ResponseField>

    <ResponseField name="description" type="string">
      Token description
    </ResponseField>

    <ResponseField name="image_url" type="string">
      Token logo URL
    </ResponseField>

    <ResponseField name="market_cap" type="number">
      Market capitalization in ETH
    </ResponseField>

    <ResponseField name="funding_progress" type="number">
      Funding progress (0-1)
    </ResponseField>

    <ResponseField name="price_eth" type="number">
      Current price in ETH
    </ResponseField>

    <ResponseField name="volume_24h" type="number">
      24-hour trading volume
    </ResponseField>

    <ResponseField name="price_change_24h" type="number">
      24-hour price change percentage
    </ResponseField>

    <ResponseField name="total_holders" type="number">
      Total number of token holders
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="totalCount" type="number">
  Total number of tokens matching the filters
</ResponseField>

<ResponseField name="totalPages" type="number">
  Total number of pages available
</ResponseField>

<ResponseExample>
  ```json theme={null}
  {
    "tokens": [
      {
        "address": "0x1234567890abcdef1234567890abcdef12345678",
        "created_at": "2024-01-15T10:30:00Z",
        "owner": "0xabcdef1234567890abcdef1234567890abcdef12",
        "name": "Example Token",
        "ticker": "EXMP",
        "description": "An example token",
        "image_url": "https://example.com/logo.png",
        "telegram": "https://t.me/example",
        "twitter": "https://twitter.com/example",
        "website": "https://example.com",
        "market_cap": 125.5,
        "funding_progress": 1.0,
        "price_eth": 0.000125,
        "volume_24h": 45.2,
        "price_change_24h": 12.5,
        "txns_24h_buys": 150,
        "txns_24h_sells": 120,
        "total_holders": 523
      }
    ],
    "totalCount": 1523,
    "totalPages": 153
  }
  ```
</ResponseExample>

<RequestExample>
  ```bash cURL theme={null}
  curl -X GET "https://inkypump.com/api/tokens?page=1&sortBy=trending&status=live"
  ```

  ```typescript TypeScript theme={null}
  const response = await fetch('https://inkypump.com/api/tokens?page=1&sortBy=trending&status=live');
  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      "https://inkypump.com/api/tokens",
      params={
          "page": 1,
          "sortBy": "trending",
          "status": "live"
      }
  )
  data = response.json()
  ```
</RequestExample>