get_tokens_networks_onchain_pools
Query top on-chain liquidity pools for a specific token contract address on a network to analyze token prices, volumes, and market activity. Use the jq_filter parameter to refine response data and enhance performance.
Instructions
When using this tool, always use the jq_filter parameter to reduce the response size and improve performance.
Only omit if you're sure you don't need the data.
This endpoint allows you to query top pools based on the provided token contract address on a network
Response Schema
{
type: 'object',
properties: {
data: {
type: 'array',
items: {
type: 'object',
properties: {
id: {
type: 'string'
},
attributes: {
type: 'object',
properties: {
address: {
type: 'string'
},
base_token_price_native_currency: {
type: 'string'
},
base_token_price_quote_token: {
type: 'string'
},
base_token_price_usd: {
type: 'string'
},
fdv_usd: {
type: 'string'
},
market_cap_usd: {
type: 'string'
},
name: {
type: 'string'
},
pool_created_at: {
type: 'string'
},
price_change_percentage: {
type: 'object',
properties: {
h1: {
type: 'string'
},
h24: {
type: 'string'
},
h6: {
type: 'string'
},
m15: {
type: 'string'
},
m30: {
type: 'string'
},
m5: {
type: 'string'
}
}
},
quote_token_price_base_token: {
type: 'string'
},
quote_token_price_native_currency: {
type: 'string'
},
quote_token_price_usd: {
type: 'string'
},
reserve_in_usd: {
type: 'string'
},
transactions: {
type: 'object',
properties: {
h1: {
type: 'object',
properties: {
buyers: {
type: 'integer'
},
buys: {
type: 'integer'
},
sellers: {
type: 'integer'
},
sells: {
type: 'integer'
}
}
},
h24: {
type: 'object',
properties: {
buyers: {
type: 'integer'
},
buys: {
type: 'integer'
},
sellers: {
type: 'integer'
},
sells: {
type: 'integer'
}
}
},
m15: {
type: 'object',
properties: {
buyers: {
type: 'integer'
},
buys: {
type: 'integer'
},
sellers: {
type: 'integer'
},
sells: {
type: 'integer'
}
}
},
m30: {
type: 'object',
properties: {
buyers: {
type: 'integer'
},
buys: {
type: 'integer'
},
sellers: {
type: 'integer'
},
sells: {
type: 'integer'
}
}
},
m5: {
type: 'object',
properties: {
buyers: {
type: 'integer'
},
buys: {
type: 'integer'
},
sellers: {
type: 'integer'
},
sells: {
type: 'integer'
}
}
}
}
},
volume_usd: {
type: 'object',
properties: {
h1: {
type: 'string'
},
h24: {
type: 'string'
},
h6: {
type: 'string'
},
m15: {
type: 'string'
},
m30: {
type: 'string'
},
m5: {
type: 'string'
}
}
}
}
},
relationships: {
type: 'object',
properties: {
base_token: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
id: {
type: 'string'
},
type: {
type: 'string'
}
}
}
}
},
dex: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
id: {
type: 'string'
},
type: {
type: 'string'
}
}
}
}
},
quote_token: {
type: 'object',
properties: {
data: {
type: 'object',
properties: {
id: {
type: 'string'
},
type: {
type: 'string'
}
}
}
}
}
}
},
type: {
type: 'string'
}
}
}
},
included: {
type: 'array',
items: {
type: 'object',
properties: {
id: {
type: 'string'
},
attributes: {
type: 'object',
properties: {
address: {
type: 'string'
},
coingecko_coin_id: {
type: 'string'
},
decimals: {
type: 'integer'
},
image_url: {
type: 'string'
},
name: {
type: 'string'
},
symbol: {
type: 'string'
}
}
},
type: {
type: 'string'
}
}
}
}
}
}
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| include | No | attributes to include, comma-separated if more than one to include <br> Available values: `base_token`, `quote_token`, `dex` | |
| jq_filter | No | A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available. For example: to include only the `name` field in every object of a results array, you can provide ".results[].name". For more information, see the [jq documentation](https://jqlang.org/manual/). | |
| network | Yes | ||
| page | No | page through results <br> Default value: 1 | |
| sort | No | sort the pools by field <br> Default value: h24_volume_usd_liquidity_desc | |
| token_address | Yes |
Input Schema (JSON Schema)
{
"properties": {
"include": {
"description": "attributes to include, comma-separated if more than one to include <br> Available values: `base_token`, `quote_token`, `dex`",
"type": "string"
},
"jq_filter": {
"description": "A jq filter to apply to the response to include certain fields. Consult the output schema in the tool description to see the fields that are available.\n\nFor example: to include only the `name` field in every object of a results array, you can provide \".results[].name\".\n\nFor more information, see the [jq documentation](https://jqlang.org/manual/).",
"title": "jq Filter",
"type": "string"
},
"network": {
"type": "string"
},
"page": {
"description": "page through results <br> Default value: 1",
"type": "integer"
},
"sort": {
"description": "sort the pools by field <br> Default value: h24_volume_usd_liquidity_desc",
"enum": [
"h24_volume_usd_liquidity_desc",
"h24_tx_count_desc",
"h24_volume_usd_desc"
],
"type": "string"
},
"token_address": {
"type": "string"
}
},
"required": [
"network",
"token_address"
],
"type": "object"
}