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

# Filter Tokens

Discover and filter tokens across blockchain networks using the Codex (Defined.fi) API. Returns ranked token lists with price, volume, liquidity, market cap, holder counts, and buy/sell activity. Supports filtering by network, minimum liquidity, volume thresholds, and scam exclusion. Ideal for: finding trending tokens, screening new launches, monitoring trading activity on specific chains.

![Filter Tokens logo](https://ai-icon.b3.fun/logo/codex)
Catalog action Blockchain Data

Discover and filter tokens across blockchain networks using the Codex (Defined.fi) API. Returns ranked token lists with price, volume, liquidity, market cap, holder counts, and buy/sell activity. Supports filtering by network, minimum liquidity, volume thresholds, and scam exclusion. Ideal for: finding trending tokens, screening new launches, monitoring trading activity on specific chains.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `codex-filter-tokens` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `onchain`, `blockchain`, `token`, `trending`, `filter`, `analytics`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `networkId` | `number` | No | Network ID to filter tokens on. Common values: 1 \(Ethereum\), 8453 \(Base\), 137 \(Polygon\), 42161 \(Arbitrum\), 10 \(Optimism\). Default: 8453 \(Base\) |
| `minLiquidity` | `number` | No | Minimum liquidity in USD. Filters out low-liquidity tokens. Default: 10000 |
| `minVolume24` | `number` | No | Minimum 24-hour trading volume in USD. Default: 5000 |
| `excludeScams` | `boolean` | No | Exclude tokens flagged as potential scams. Default: true |
| `excludeStablecoins` | `boolean` | No | Exclude stablecoins and wrapped tokens from results using Codex trendingIgnored flag. Default: true |
| `rankBy` | `string` | No | Attribute to rank tokens by. Options: trendingScore24 \(24h trending\), trendingScore1 \(1h trending\), volume24, change24, liquidity, marketCap, holders, createdAt. Default: trendingScore24 |
| `rankDirection` | `string` | No | Sort direction for ranking. Default: DESC |
| `limit` | `number` | No | Maximum number of tokens to return. Range: 1-200. Default: 50 |
| `offset` | `number` | No | Number of tokens to skip for pagination. Default: 0 |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `count` | `number` | Yes | Total number of tokens matching the filter criteria |
| `page` | `number` | Yes | Current page number |
| `tokens` | `array` | Yes | List of tokens matching the filter criteria |

## Examples

**Workflow node**

```json
{
  "type": "codex-filter-tokens",
  "payload": {
    "networkId": 8453,
    "minLiquidity": 10000,
    "minVolume24": 5000,
    "excludeScams": true,
    "excludeStablecoins": true
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/codex-filter-tokens/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "networkId": 8453,
    "minLiquidity": 10000,
    "minVolume24": 5000,
    "excludeScams": true,
    "excludeStablecoins": true
  }
}'
```

**Use expressions for dynamic values**

Payload fields can use workflow expressions such as `{{$trigger.body.amount}}`, `{{$nodes.fetch.result.price}}`, and `{{$props.asset}}` when the value should come from a trigger, prior node, or reusable workflow prop.