optionsData_historicalOptions
Retrieve historical options chain data for specific stocks by providing a symbol and date, with output in JSON or CSV formats.
Instructions
Fetches historical options chain data. Premium endpoint.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| datatype | No | Data format for the response. | json |
| date | No | Specific date (YYYY-MM-DD) for historical data. | |
| symbol | Yes | The underlying stock symbol (e.g., "AAPL"). |
Implementation Reference
- src/index.ts:965-979 (registration)Registers the MCP tool 'optionsData_historicalOptions' with description, input schema, and an execute handler that invokes the generic executeAvantageTool with the specific AVantage library method av.optionsData.historicalOptions(params).server.addTool({ name: "optionsData_historicalOptions", description: "Fetches historical options chain data. Premium endpoint.", parameters: schemas.OptionsDataHistoricalOptionsParamsSchema, execute: ( args, context // Let type be inferred ) => executeAvantageTool( "optionsData_historicalOptions", args, context, (av, params) => av.optionsData.historicalOptions(params) ), });
- src/schemas.ts:196-200 (schema)Defines the Zod input schema for the tool, requiring a symbol and optional date/datatype.export const OptionsDataHistoricalOptionsParamsSchema = z.object({ symbol: z.string().describe('The underlying stock symbol (e.g., "AAPL").'), date: z.string().optional().describe('Specific date (YYYY-MM-DD) for historical data.'), datatype: DatatypeSchema.default('json').optional(), }).describe('Parameters for fetching historical options chain data (Premium).')
- src/index.ts:38-115 (handler)Generic handler function that all tools, including this one, use to execute: resolves API key, manages AVantage client instance, calls the provided library method, handles errors, and returns JSON string of data.async function executeAvantageTool<TArgs, TResult>( toolName: string, args: TArgs, context: Context<Record<string, unknown> | undefined>, // Use the imported Context type directly avantageMethod: ( av: AVantage, args: TArgs ) => Promise<{ error?: boolean; reason?: string; data?: TResult }> ): Promise<string> { logger.info(`Executing '${toolName}' tool for request ID: ${context}`); logger.debug(`Args for ${toolName}: ${JSON.stringify(args)}`); // --- Authentication & Resource Management --- // Access extraArgs safely - it might be null or undefined const extraArgsApiKey = context.extraArgs?.apiKey as string | undefined; const apiKey = extraArgsApiKey || config.apiKey; if (!apiKey) { logger.error(`'${toolName}' failed: Alpha Vantage API key missing.`); throw new UserError(apiKeyErrorMessage); } logger.debug( `Using AV API key (source: ${extraArgsApiKey ? "extraArgs" : "environment"}) for ${toolName}` ); try { // Get or create AVantage instance managed by ResourceManager const av = await resourceManager.getResource<AVantage>( apiKey, // Cache key is the resolved API key "avantage_client", // Type identifier for logging async (key) => { // Factory Function logger.info( `Creating new AVantage instance for key ending ...${key.slice(-4)}` ); // AVantage library reads AV_PREMIUM from process.env internally return new AVantage(key); }, async (avInstance) => { // Cleanup Function (no-op needed for AVantage) logger.debug(`Destroying AVantage instance (no-op)`); } ); // --- Library Call --- const result = await avantageMethod(av, args); // --- Response Handling --- if (result.error) { logger.warn( `'${toolName}' failed. Reason from avantage: ${result.reason}` ); throw new UserError(result.reason || `Tool '${toolName}' failed.`); } if (result.data === undefined || result.data === null) { logger.warn(`'${toolName}' completed successfully but returned no data.`); return "null"; // Return string "null" for empty data } logger.info(`'${toolName}' completed successfully.`); // Stringify the data part of the response return JSON.stringify(result.data); } catch (error: any) { logger.error( `Error during execution of '${toolName}': ${error.message}`, error ); // If it's already a UserError, rethrow it if (error instanceof UserError) { throw error; } // Otherwise, wrap it in a UserError throw new UserError( `An unexpected error occurred while executing tool '${toolName}': ${error.message}` ); } }
- src/index.ts:4-6 (helper)Imports the AVantage library which provides the optionsData.historicalOptions method called by the tool.import { AVantage } from "@missionsquad/avantage"; import { z } from "zod"; import { resourceManager } from "./resource-manager.js";