# Token screener API

> Rank and filter tokens across chains in one request. The list on Aurelia Screener's home page is this endpoint.

## Rank tokens

[`GET /tokens`](https://app.aurelia.build/docs/tokens) is a screener when you give it no `tokens` or `q`. `chains` defaults to every listed chain. Sort on `volume24hUsd`, `trades24h`, `feesPaid1hUsd` and the other fee windows, and more.

Solana's most traded, with $50,000 of liquidity:

```bash
curl -s -H 'Authorization: Bearer <key>' 'https://app.aurelia.build/api/tokens?chains=solana&sort=volume24hUsd&minLiquidityUsd=50000&excludeQuotes=true&limit=50'
```

## Filters

| Parameter | Keeps |
|---|---|
| `minLiquidityUsd`, `maxLiquidityUsd` | Liquidity in USD |
| `minVolume24hUsd` | 24-hour volume in USD |
| `minMarketCapUsd`, `maxMarketCapUsd` | Market cap in USD |
| `minChange24h`, `maxChange24h` | 24-hour price change, a fraction: `0.5` is +50% |
| `minFeesPaid5mUsd` to `minFeesPaid24hUsd` | What traders paid in fees over that window |
| `createdAfter`, `createdBefore` | Creation time, unix ms |
| `launchpad` | Launchpad ids, comma-separated: `pumpfun`, `fourmeme` |
| `creator` | One creator's tokens |
| `excludeQuotes=true` | Leaves out what pools quote in: stablecoins and the wrapped native token |

## Recipes

Tokens up 50% in 24 hours, with real volume:

```bash
curl -s -H 'Authorization: Bearer <key>' 'https://app.aurelia.build/api/tokens?sort=change24h&minChange24h=0.5&minLiquidityUsd=10000&minVolume24hUsd=10000'
```

Where traders paid the most in fees over the last hour:

```bash
curl -s -H 'Authorization: Bearer <key>' 'https://app.aurelia.build/api/tokens?sort=feesPaid1hUsd&minFeesPaid1hUsd=1&excludeQuotes=true'
```

pump.fun tokens by volume:

```bash
curl -s -H 'Authorization: Bearer <key>' 'https://app.aurelia.build/api/tokens?chains=solana&launchpad=pumpfun&sort=volume24hUsd'
```

## Page through it

`limit` is 1 to 100, 50 by default. Pass the answer's `next` as `cursor`, as it came.

## What a row holds

One row shape in every mode: token, `priceUsd`, `change`, `volume24hUsd`, `trades24h`, `buys24h`, `sells24h`, `traders24h`, `feesPaidUsd` per window, `marketCapUsd`, `fdvUsd`, `liquidityUsd`, `chartPool`, `createdAt`, `creator`, `launchpad` and security `flags`.

## Also in this endpoint

- Search: `q=` takes a token or pool address, a symbol or a name.
- Batch: `tokens=` takes up to 100 `<chain>:<address>` items, at 1 credit per 25.

## See it running

The list on [Aurelia Screener](https://screener.aurelia.build) comes from this endpoint, with the sorts and filters above.

## Related

- [Token lists reference](https://app.aurelia.build/docs/tokens).
- [New token launches API](https://app.aurelia.build/guides/new-token-launches-api): what launched minutes ago.
- [Token price API](https://app.aurelia.build/guides/token-price-api).
