get_pools_onchain_categories
Query cryptocurrency liquidity pools by category ID to analyze trading data, volume, and price metrics for specific market segments.
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 all the pools based on the provided category ID
Response Schema
{
$ref: '#/$defs/category_get_pools_response',
$defs: {
category_get_pools_response: {
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'
},
h24_tx_count: {
type: 'integer'
},
h24_volume_usd: {
type: 'string'
},
market_cap_usd: {
type: 'string'
},
name: {
type: 'string'
},
pool_created_at: {
type: 'string',
format: 'date-time'
},
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'
}
}
},
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'
}
}
}
}
},
network: {
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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| category_id | Yes | ||
| include | No | attributes to include, comma-separated if more than one to include Available values: `base_token`, `quote_token`, `dex`, `network`. Example: `base_token` or `base_token,dex` | |
| page | No | page through results Default value: `1` | |
| sort | No | sort the pools by field Default value: `pool_created_at_desc` | |
| 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/). |