@gviper/alphavantage-api
Version:
TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support
23 lines • 1.16 kB
TypeScript
import { AlphaVantageClient } from '../client';
import { SymbolSearchParams, MarketStatusParams, SymbolSearchResponse, MarketStatusResponse } from '../types/util';
export declare class Util {
private client;
constructor(client: AlphaVantageClient);
/**
* Returns the best-matching symbols and market information based on keywords of your choice.
*
* @param params - Parameters including search keywords
* @returns Promise resolving to symbol search results
* @example https://www.alphavantage.co/query?function=SYMBOL_SEARCH&keywords=tesco&apikey=demo
*/
symbolSearch(params: SymbolSearchParams): Promise<SymbolSearchResponse>;
/**
* Returns the current market status (open vs. closed) of major trading venues for equities, forex, and cryptocurrencies around the world.
*
* @param params - Optional parameters for market status
* @returns Promise resolving to market status data
* @example https://www.alphavantage.co/query?function=MARKET_STATUS&apikey=demo
*/
marketStatus(params?: MarketStatusParams): Promise<MarketStatusResponse>;
}
//# sourceMappingURL=util.d.ts.map