@gviper/alphavantage-api
Version:
TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support
39 lines • 2.5 kB
TypeScript
import { AlphaVantageClient } from '../client';
import { CryptoIntradayParams, CryptoTimeSeriesParams, CryptoIntradayResponse, CryptoDigitalCurrencyResponse, CryptoDigitalCurrencyWeeklyResponse, CryptoDigitalCurrencyMonthlyResponse } from '../types/crypto';
export declare class Crypto {
private client;
constructor(client: AlphaVantageClient);
/**
* Returns intraday time series for any digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed every 5 minutes.
*
* @param params - Parameters including symbol, market, and interval
* @returns Promise resolving to crypto intraday time series data
* @example https://www.alphavantage.co/query?function=CRYPTO_INTRADAY&symbol=ETH&market=USD&interval=5min&apikey=demo
*/
intraday(params: CryptoIntradayParams): Promise<CryptoIntradayResponse>;
/**
* Returns the daily historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC).
*
* @param params - Parameters including symbol and market
* @returns Promise resolving to crypto daily time series data
* @example https://www.alphavantage.co/query?function=DIGITAL_CURRENCY_DAILY&symbol=BTC&market=EUR&apikey=demo
*/
daily(params: CryptoTimeSeriesParams): Promise<CryptoDigitalCurrencyResponse>;
/**
* Returns the weekly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC).
*
* @param params - Parameters including symbol and market
* @returns Promise resolving to crypto weekly time series data
* @example https://www.alphavantage.co/query?function=DIGITAL_CURRENCY_WEEKLY&symbol=BTC&market=EUR&apikey=demo
*/
weekly(params: CryptoTimeSeriesParams): Promise<CryptoDigitalCurrencyWeeklyResponse>;
/**
* Returns the monthly historical time series for a digital currency (e.g., BTC) traded on a specific market (e.g., CNY/Chinese Yuan), refreshed daily at midnight (UTC).
*
* @param params - Parameters including symbol and market
* @returns Promise resolving to crypto monthly time series data
* @example https://www.alphavantage.co/query?function=DIGITAL_CURRENCY_MONTHLY&symbol=BTC&market=EUR&apikey=demo
*/
monthly(params: CryptoTimeSeriesParams): Promise<CryptoDigitalCurrencyMonthlyResponse>;
}
//# sourceMappingURL=crypto.d.ts.map