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

# Get Token Data

Retrieves on-chain token data by network and contract address including price, FDV, market cap, and supply. Returns coingecko_coin_id for cross-referencing; optionally includes top liquidity pools. Ideal for: token price lookup by contract, portfolio tracking, finding liquidity pools for a token.

![Get Token Data logo](https://ai-icon.b3.fun/logo/coingecko)
Catalog action Blockchain Data

Retrieves on-chain token data by network and contract address including price, FDV, market cap, and supply. Returns coingecko_coin_id for cross-referencing; optionally includes top liquidity pools. Ideal for: token price lookup by contract, portfolio tracking, finding liquidity pools for a token.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `coingecko-get-token-data` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `coingecko`, `onchain`, `token`, `price`, `market-cap`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `network` | `string` | Yes | Network ID \(e.g., 'eth', 'bsc', 'polygon_pos', 'arbitrum', 'optimism', 'base'\). Use token_lookup\(query_type='networks'\) to get valid network IDs. |
| `address` | `string` | Yes | Token contract address \(e.g., '0xdac17f958d2ee523a2206206994597c13d831ec7' for USDT on Ethereum\). |
| `include` | `string` | No | Set to 'top_pools' to include the token's top liquidity pools with full pool data. |
| `includeComposition` | `boolean` | No | Include pool composition data \(base/quote token balances and liquidity\). Only works when include='top_pools'. Default: false |
| `includeInactiveSource` | `boolean` | No | Include token data from inactive pools using the most recent swap price. Useful for tokens with low liquidity. Default: false |

## Result Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `token` | `object` | Yes | On-chain token data \(flat structure, properties directly on token object\). |

## Examples

**Workflow node**

```json
{
  "type": "coingecko-get-token-data",
  "payload": {
    "network": "example-network",
    "address": "0x0000000000000000000000000000000000000000"
  },
  "children": []
}
```
  **Test with API**

```bash
curl -X POST "https://api.b3os.org/v1/actions/coingecko-get-token-data/test" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "inputs": {
    "network": "example-network",
    "address": "0x0000000000000000000000000000000000000000"
  }
}'
```

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