get_options_overview
Retrieve summaries of options DEX volumes and historical data to analyze market activity and trends across platforms.
Instructions
GET /api/overview/options
List all options dexs along with summaries of their volumes and dataType history data.
Parameters:
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
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| exclude_total_data_chart | No | ||
| exclude_total_data_chart_breakdown | No | ||
| data_type | No | dailyNotionalVolume |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- defillama_server.py:811-831 (handler)The handler function for the 'get_options_overview' tool. It is registered via @mcp.tool() decorator and implements the logic to fetch options DEX overview data from the DefiLlama API by constructing parameters and calling make_request. The function signature and docstring define the input schema.
async def get_options_overview( exclude_total_data_chart: bool = True, exclude_total_data_chart_breakdown: bool = True, data_type: Literal['dailyPremiumVolume', 'dailyNotionalVolume'] = 'dailyNotionalVolume' ) -> str: """GET /api/overview/options List all options dexs along with summaries of their volumes and dataType history data. Parameters: 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') """ params = { 'excludeTotalDataChart': str(exclude_total_data_chart).lower(), 'excludeTotalDataChartBreakdown': str(exclude_total_data_chart_breakdown).lower(), 'dataType': data_type } result = await make_request('GET', '/api/overview/options', params) return str(result) - defillama_server.py:811-811 (registration)The @mcp.tool() decorator registers the get_options_overview function as an MCP tool.
async def get_options_overview( - defillama_server.py:816-823 (schema)The docstring provides the description and parameter details serving as the tool schema documentation.
"""GET /api/overview/options List all options dexs along with summaries of their volumes and dataType history data. Parameters: 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')