UNPKG

@gviper/alphavantage-api

Version:

TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support

23 lines 1.09 kB
import { AlphaVantageClient } from '../client'; import { RealtimeOptionsParams, HistoricalOptionsParams, RealtimeOptionsResponse, HistoricalOptionsResponse } from '../types/options'; export declare class Options { private client; constructor(client: AlphaVantageClient); /** * Returns the real-time options chain for a given equity. * * @param params - Parameters including symbol * @returns Promise resolving to real-time options chain data * @example https://www.alphavantage.co/query?function=REALTIME_OPTIONS&symbol=IBM&apikey=demo */ realtime(params: RealtimeOptionsParams): Promise<RealtimeOptionsResponse>; /** * Returns historical options data for a given equity. * * @param params - Parameters including symbol and date * @returns Promise resolving to historical options data * @example https://www.alphavantage.co/query?function=HISTORICAL_OPTIONS&symbol=IBM&apikey=demo */ historical(params: HistoricalOptionsParams): Promise<HistoricalOptionsResponse>; } //# sourceMappingURL=options.d.ts.map