@gviper/alphavantage-api
Version:
TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support
55 lines • 3.21 kB
TypeScript
import { AlphaVantageClient } from '../client';
import { NewsSentimentParams, EarningsCallTranscriptParams, NewsSentimentResponse, EarningsCallTranscriptResponse, TopGainersLosersResponse, InsiderTransactionsResponse, AnalyticsResponse } from '../types/intelligence';
export declare class Intelligence {
private client;
constructor(client: AlphaVantageClient);
/**
* Returns live and historical market news sentiment for any given ticker or crypto, sector, forex and commodity.
*
* @param params - Parameters for news sentiment including tickers, topics, time range, etc.
* @returns Promise resolving to news sentiment data
* @example https://www.alphavantage.co/query?function=NEWS_SENTIMENT&tickers=AAPL&apikey=demo
*/
newsSentiment(params: NewsSentimentParams): Promise<NewsSentimentResponse>;
/**
* Returns the transcript of earnings call for a given ticker and fiscal quarter.
*
* @param params - Parameters including symbol, year, and quarter
* @returns Promise resolving to earnings call transcript data
* @example https://www.alphavantage.co/query?function=EARNINGS_CALL_TRANSCRIPT&symbol=IBM&quarter=2024Q1&apikey=demo
*/
earningsCallTranscript(params: EarningsCallTranscriptParams): Promise<EarningsCallTranscriptResponse>;
/**
* Returns the top 20 gainers, losers, and most actively traded tickers in the US market.
*
* @param params - Parameters for top gainers/losers data (optional)
* @returns Promise resolving to top gainers/losers data
* @example https://www.alphavantage.co/query?function=TOP_GAINERS_LOSERS&apikey=demo
*/
topGainersLosers(params?: NewsSentimentParams): Promise<TopGainersLosersResponse>;
/**
* Returns the latest insider transactions for a given ticker.
*
* @param params - Parameters for insider transactions including symbol
* @returns Promise resolving to insider transactions data
* @example https://www.alphavantage.co/query?function=INSIDER_TRANSACTIONS&symbol=IBM&apikey=demo
*/
insiderTransactions(params: NewsSentimentParams): Promise<InsiderTransactionsResponse>;
/**
* Returns analytics data for equity, ETF, forex, crypto, or commodity using fixed time window.
*
* @param params - Parameters for analytics fixed window
* @returns Promise resolving to analytics data
* @example https://www.alphavantage.co/query?function=ANALYTICS_FIXED_WINDOW&SYMBOLS=AAPL&RANGE=2022-01-01&RANGE=2022-03-01&INTERVAL=DAILY&OHLC=close&apikey=demo
*/
analyticsFixedWindow(params: NewsSentimentParams): Promise<AnalyticsResponse>;
/**
* Returns analytics data for equity, ETF, forex, crypto, or commodity using sliding time window.
*
* @param params - Parameters for analytics sliding window
* @returns Promise resolving to analytics data
* @example https://www.alphavantage.co/query?function=ANALYTICS_SLIDING_WINDOW&SYMBOLS=AAPL&RANGE=2022-01-01&RANGE=2022-12-01&INTERVAL=MONTHLY&WINDOW_SIZE=3&OHLC=close&apikey=demo
*/
analyticsSlidingWindow(params: NewsSentimentParams): Promise<AnalyticsResponse>;
}
//# sourceMappingURL=intelligence.d.ts.map