> ## 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 Pool by Address

Retrieves detailed on-chain DEX pool data by network and pool contract address. Returns prices, liquidity, volumes, price changes across timeframes, transaction counts, and optional composition/volume breakdown. Ideal for: pool monitoring, liquidity analysis, tracking trading activity on specific DEX pairs.

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

Retrieves detailed on-chain DEX pool data by network and pool contract address. Returns prices, liquidity, volumes, price changes across timeframes, transaction counts, and optional composition/volume breakdown. Ideal for: pool monitoring, liquidity analysis, tracking trading activity on specific DEX pairs.


## At a Glance

| Field | Value |
| --- | --- |
| Action ID | `coingecko-get-pool-by-address` |
| Category | Blockchain Data |
| Connector | Not required |
| Requires gas | No |
| Funds movement | None declared |
| Tags | `coingecko`, `onchain`, `pool`, `dex`, `liquidity`, `read` |

## Payload Schema

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `network` | `string` | Yes | Network ID \(e.g., 'eth', 'bsc', 'polygon_pos', 'arbitrum', 'base'\). Use token_lookup\(query_type='networks'\) to get valid network IDs. |
| `address` | `string` | Yes | Pool contract address \(e.g., '0x88e6a0c2ddd26feeb64f039a2c41296fcb3f5640' for USDC/ETH pool on Uniswap V3\). |
| `include` | `string` | No | Attributes to include \(comma-separated\). Options: 'base_token' \(base token details\), 'quote_token' \(quote token details\), 'dex' \(DEX info\). Example: 'base_token,quote_token,dex' |
| `includeVolumeBreakdown` | `boolean` | No | Include detailed volume breakdown with buy/sell volumes in USD across timeframes \(5m, 1h, 6h, 24h\). Default: false |
| `includeComposition` | `boolean` | No | Include pool composition showing base/quote token balances, their USD values, and locked liquidity percentage. Default: false |

## Result Schema

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

## Examples

**Workflow node**

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

```bash
curl -X POST "https://api.b3os.org/v1/actions/coingecko-get-pool-by-address/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.