> ## 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.

# Clanker Get Tokens

Browse and search Clanker tokens with filtering and sorting on Base. Supports search by name/symbol, sorting by market cap or volume, and optional market data. Max 20 results per page with cursor pagination. Ideal for: token discovery, market analysis, trending token alerts, Clanker ecosystem monitoring.

![Clanker Get Tokens logo](https://cdn.b3.fun/b3os-icons/clanker.svg)
Catalog action Blockchain Data

Browse and search Clanker tokens with filtering and sorting on Base. Supports search by name/symbol, sorting by market cap or volume, and optional market data. Max 20 results per page with cursor pagination. Ideal for: token discovery, market analysis, trending token alerts, Clanker ecosystem monitoring.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `clanker-get-tokens` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `clanker`, `token`, `search`, `base`, `market`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `query` | `string` | No | Search query for token name or symbol |
| `sortBy` | `string` | No | Field to sort by |
| `sort` | `string` | No | Sort order \(default: desc\) |
| `limit` | `number` | No | Results per page \(1-20, default: 10\) |
| `cursor` | `string` | No | Cursor for pagination \(from previous response\) |
| `includeMarket` | `boolean` | No | Include real-time market data \(price, market cap\). Default: false |
| `chainId` | `number` | No | Filter by chain ID \(e.g., 8453 for Base\) |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `tokens` | `array` | Yes | Array of Clanker tokens |
| `total` | `number` | Yes | Total number of matching tokens |
| `cursor` | `string` | No | Cursor for next page |
| `tokensDeployed` | `number` | No | Total tokens deployed \(when filtering by fid\) |

## Examples

**Workflow node**

```json
{
  "type": "clanker-get-tokens",
  "payload": {
    "query": "status:open",
    "sortBy": "market-cap",
    "sort": "desc",
    "limit": 10,
    "cursor": "example-cursor"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/clanker-get-tokens/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "query": "status:open",
    "sortBy": "market-cap",
    "sort": "desc",
    "limit": 10,
    "cursor": "example-cursor"
  }
}'
```

**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.