@gviper/alphavantage-api
Version:
TypeScript SDK for Alpha Vantage API with comprehensive type safety and all endpoint support
95 lines • 4.33 kB
TypeScript
import { AlphaVantageClient } from '../client';
import { CommodityParams, CommodityResponse } from '../types/commodities';
export declare class Commodities {
private client;
constructor(client: AlphaVantageClient);
/**
* Returns the daily, weekly, and monthly crude oil prices (WTI) in USD.
*
* @param params - Parameters for WTI crude oil data
* @returns Promise resolving to WTI crude oil price data
* @example https://www.alphavantage.co/query?function=WTI&interval=monthly&apikey=demo
*/
crudeOilWTI(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly crude oil prices (Brent) in USD.
*
* @param params - Parameters for Brent crude oil data
* @returns Promise resolving to Brent crude oil price data
* @example https://www.alphavantage.co/query?function=BRENT&interval=monthly&apikey=demo
*/
crudeOilBrent(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly natural gas prices in USD.
*
* @param params - Parameters for natural gas data
* @returns Promise resolving to natural gas price data
* @example https://www.alphavantage.co/query?function=NATURAL_GAS&interval=monthly&apikey=demo
*/
naturalGas(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly copper prices in USD.
*
* @param params - Parameters for copper data
* @returns Promise resolving to copper price data
* @example https://www.alphavantage.co/query?function=COPPER&interval=monthly&apikey=demo
*/
copper(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly aluminum prices in USD.
*
* @param params - Parameters for aluminum data
* @returns Promise resolving to aluminum price data
* @example https://www.alphavantage.co/query?function=ALUMINUM&interval=monthly&apikey=demo
*/
aluminum(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly wheat prices in USD.
*
* @param params - Parameters for wheat data
* @returns Promise resolving to wheat price data
* @example https://www.alphavantage.co/query?function=WHEAT&interval=monthly&apikey=demo
*/
wheat(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly corn prices in USD.
*
* @param params - Parameters for corn data
* @returns Promise resolving to corn price data
* @example https://www.alphavantage.co/query?function=CORN&interval=monthly&apikey=demo
*/
corn(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly cotton prices in USD.
*
* @param params - Parameters for cotton data
* @returns Promise resolving to cotton price data
* @example https://www.alphavantage.co/query?function=COTTON&interval=monthly&apikey=demo
*/
cotton(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly sugar prices in USD.
*
* @param params - Parameters for sugar data
* @returns Promise resolving to sugar price data
* @example https://www.alphavantage.co/query?function=SUGAR&interval=monthly&apikey=demo
*/
sugar(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly coffee prices in USD.
*
* @param params - Parameters for coffee data
* @returns Promise resolving to coffee price data
* @example https://www.alphavantage.co/query?function=COFFEE&interval=monthly&apikey=demo
*/
coffee(params?: CommodityParams): Promise<CommodityResponse>;
/**
* Returns the daily, weekly, and monthly global commodities index in USD.
*
* @param params - Parameters for global commodities index data
* @returns Promise resolving to global commodities index data
* @example https://www.alphavantage.co/query?function=ALL_COMMODITIES&interval=monthly&apikey=demo
*/
globalCommoditiesIndex(params?: CommodityParams): Promise<CommodityResponse>;
}
//# sourceMappingURL=commodities.d.ts.map