get_options_overview_by_chain
Retrieve a detailed overview of options DEXs, including volume summaries and historical data, filtered by a specific blockchain chain.
Instructions
GET /api/overview/options/{chain}
List all options dexs along with summaries of their volumes and dataType history data filtering by chain.
Parameters:
chain: chain name (e.g., 'ethereum')
exclude_total_data_chart: true to exclude aggregated chart from response
exclude_total_data_chart_breakdown: true to exclude broken down chart from response
data_type: desired data type (default: 'dailyNotionalVolume')
Input Schema
Name | Required | Description | Default |
---|---|---|---|
chain | Yes | ||
data_type | No | dailyNotionalVolume | |
exclude_total_data_chart | No | ||
exclude_total_data_chart_breakdown | No |
Input Schema (JSON Schema)
{
"properties": {
"chain": {
"title": "Chain",
"type": "string"
},
"data_type": {
"default": "dailyNotionalVolume",
"enum": [
"dailyPremiumVolume",
"dailyNotionalVolume"
],
"title": "Data Type",
"type": "string"
},
"exclude_total_data_chart": {
"default": true,
"title": "Exclude Total Data Chart",
"type": "boolean"
},
"exclude_total_data_chart_breakdown": {
"default": true,
"title": "Exclude Total Data Chart Breakdown",
"type": "boolean"
}
},
"required": [
"chain"
],
"title": "get_options_overview_by_chainArguments",
"type": "object"
}