@gviper/alphavantage-api
Version:
TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support
47 lines • 2.61 kB
TypeScript
import { AlphaVantageClient } from '../client';
import { ForexIntradayParams, ForexDailyParams, ForexExchangeRateParams, ForexIntradayResponse, ForexDailyResponse, ForexWeeklyResponse, ForexMonthlyResponse, ExchangeRateResponse } from '../types/forex';
export declare class Forex {
private client;
constructor(client: AlphaVantageClient);
/**
* Returns intraday time series for any currency exchange rate pair, refreshed every 5 minutes.
*
* @param params - Parameters including from_symbol, to_symbol, and interval
* @returns Promise resolving to forex intraday time series data
* @example https://www.alphavantage.co/query?function=FX_INTRADAY&from_symbol=EUR&to_symbol=USD&interval=5min&apikey=demo
*/
intraday(params: ForexIntradayParams): Promise<ForexIntradayResponse>;
/**
* Returns the daily time series for a currency exchange rate pair of your choice.
*
* @param params - Parameters including from_symbol and to_symbol
* @returns Promise resolving to forex daily time series data
* @example https://www.alphavantage.co/query?function=FX_DAILY&from_symbol=EUR&to_symbol=USD&apikey=demo
*/
daily(params: ForexDailyParams): Promise<ForexDailyResponse>;
/**
* Returns the weekly time series for a currency exchange rate pair of your choice.
*
* @param params - Parameters including from_symbol and to_symbol
* @returns Promise resolving to forex weekly time series data
* @example https://www.alphavantage.co/query?function=FX_WEEKLY&from_symbol=EUR&to_symbol=USD&apikey=demo
*/
weekly(params: ForexDailyParams): Promise<ForexWeeklyResponse>;
/**
* Returns the monthly time series for a currency exchange rate pair of your choice.
*
* @param params - Parameters including from_symbol and to_symbol
* @returns Promise resolving to forex monthly time series data
* @example https://www.alphavantage.co/query?function=FX_MONTHLY&from_symbol=EUR&to_symbol=USD&apikey=demo
*/
monthly(params: ForexDailyParams): Promise<ForexMonthlyResponse>;
/**
* Returns the real-time exchange rate for a pair of digital currencies or physical currencies.
*
* @param params - Parameters including from_currency and to_currency
* @returns Promise resolving to currency exchange rate data
* @example https://www.alphavantage.co/query?function=CURRENCY_EXCHANGE_RATE&from_currency=USD&to_currency=JPY&apikey=demo
*/
exchangeRate(params: ForexExchangeRateParams): Promise<ExchangeRateResponse>;
}
//# sourceMappingURL=forex.d.ts.map