Skip to main content
Alpha Vantage logo
  • Category: market data
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 56
  • Triggers: 0
  • Slug: ALPHA_VANTAGE
  • Version: 20261101_00
  • Instant: Supported on the latest version. Support varies by tool.

Tools

Slug: ALPHA_VANTAGE_ALL_COMMODITIESTool to retrieve the global price index of all commodities. Use when you need monthly, quarterly, or annual aggregated price index data for commodities.

Input Parameters

string ("json" | "csv")
Output format: ‘json’ for JSON response, ‘csv’ for CSV text.
string ("monthly" | "quarterly" | "annual")
required
Time interval for the global commodities price index. Supported values: ‘monthly’, ‘quarterly’, ‘annual’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_ALUMINUMTool to fetch global aluminum prices. Use when you need monthly, quarterly, or annual LME aluminum price data.

Input Parameters

string
Response format
string ("monthly" | "quarterly" | "annual")
Time horizon for aluminum prices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_BALANCE_SHEETTool to return annual and quarterly balance sheets for a company. Use when you need detailed fiscal statements for analysis. Numeric fields may be returned as strings or empty values; treat empty/missing fields as null, not zero, before performing calculations.

Input Parameters

string
required
The stock ticker symbol of the company, e.g., ‘IBM’ Data completeness varies by symbol; missing fields indicate absent data, not zero.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_BRENTTool to fetch Brent crude oil prices. Use when you need daily, weekly, or monthly Brent price data.

Input Parameters

string ("json" | "csv")
Output format. Defaults to ‘json’.
string ("daily" | "weekly" | "monthly")
Time series interval. Defaults to ‘monthly’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_CASH_FLOWTool to return annual and quarterly cash flow statements for a company. Use when you need to analyze cash movements.

Input Parameters

string
required
The stock ticker symbol of the company, e.g., ‘IBM’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_COFFEETool to retrieve the global coffee price series. Use when you need historical monthly, quarterly, or annual coffee prices.

Input Parameters

string ("json" | "csv")
Response format: json or csv.
string ("monthly" | "quarterly" | "annual")
Time resolution: monthly, quarterly, or annual.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_COMPANY_OVERVIEWTool to retrieve company overview and fundamental data for individual company stocks. Note: This endpoint only works for stocks, not ETFs, mutual funds, or indices. Use after specifying a valid stock ticker symbol. Numeric fields (e.g., MarketCapitalization, SharesOutstanding, Beta, DividendYield, PERatio) are returned as strings and may be empty — treat empty/missing values as null, not zero. Fundamentals such as Beta, PERatio, and PayoutRatio may reflect different reporting periods across symbols; avoid naive cross-symbol aggregation without aligning periods. Check the as-of date in the response; SharesOutstanding and similar fields can lag corporate actions. Alpha Vantage enforces per-minute and per-day rate caps; throttle requests when processing bulk symbol lists.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Ticker symbol for an individual company stock (e.g., ‘IBM’). Note: This endpoint only works for stocks, not ETFs, mutual funds, or indices. Small-cap and non-US listings may return partial or incomplete data; validate coverage before computing metrics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_COPPERTool to fetch global price of copper in monthly, quarterly, and annual intervals. Use when you need historical copper price series for analysis.

Input Parameters

string ("json" | "csv")
Response format: json or csv
string ("monthly" | "quarterly" | "annual")
Time horizon for copper prices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_CORNTool to retrieve global price of corn in monthly, quarterly, and annual intervals. Use after verifying API key when you need historical Corn price data.

Input Parameters

string ("json" | "csv")
Output format of the data.
string ("monthly" | "quarterly" | "annual")
Time interval between data points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_COTTONTool to retrieve global cotton prices in monthly, quarterly, and annual intervals. Use when you need historical cotton price data.

Input Parameters

string ("json" | "csv")
Format of the returned data.
string ("monthly" | "quarterly" | "annual")
Time interval between data points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_CPITool to fetch monthly and semiannual Consumer Price Index (CPI) data of the United States. Use when you need inflation metrics or CPI historical data.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format. Only ‘json’ is supported. Defaults to ‘json’.
string ("monthly" | "semiannual")
Data interval: ‘monthly’ for monthly CPI or ‘semiannual’ for semiannual CPI. Defaults to ‘monthly’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_CRYPTO_INTRADAYTool to retrieve intraday time series data for cryptocurrencies with realtime updates. Use when you need high-frequency OHLCV data (open, high, low, close, volume) for a specific cryptocurrency/market pair within the trading day.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
The exchange market currency (e.g., ‘USD’, ‘EUR’). Must be from the Alpha Vantage market list.
string
required
The digital/crypto currency symbol (e.g., ‘BTC’, ‘ETH’). Must be from the Alpha Vantage digital currency list.
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’. Note: CSV format is not supported by this action.
string ("1min" | "5min" | "15min" | "30min" | "60min")
required
Time interval between two consecutive data points in the time series. Supported values: ‘1min’, ‘5min’, ‘15min’, ‘30min’, ‘60min’.
string ("compact" | "full")
Output size: ‘compact’ returns the latest 100 data points; ‘full’ returns the full-length intraday time series. Defaults to ‘compact’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_CURRENCY_EXCHANGE_RATERetrieve the real-time exchange rate for a currency pair, including the rate, bid and ask prices and last refresh time. The rate and bid and ask prices are returned as numbers.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Optional API key to override metadata (e.g., ‘demo’).
string
required
The quote currency code in three-letter format. Supports physical currencies (e.g., ‘USD’, ‘EUR’, ‘JPY’) and cryptocurrencies (e.g., ‘BTC’, ‘ETH’). Note: Precious metal codes like XAU (gold) and XAG (silver) are NOT supported by this endpoint.
string
required
The base currency code in three-letter format. Supports physical currencies (e.g., ‘USD’, ‘EUR’, ‘JPY’) and cryptocurrencies (e.g., ‘BTC’, ‘ETH’). Note: Precious metal codes like XAU (gold) and XAG (silver) are NOT supported by this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_DIGITAL_CURRENCY_DAILYTool to retrieve daily historical time series for a digital currency traded on a specific market. Use when needing daily OHLC and volume data for a crypto/fiat pair, refreshed daily at midnight UTC.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Market currency (to-currency) from Alpha Vantage list, e.g., ‘USD’.
string
required
Cryptocurrency symbol (from-currency) from Alpha Vantage list, e.g., ‘BTC’.
string
The format of the output. Only ‘json’ is supported. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_DIGITAL_CURRENCY_MONTHLYTool to retrieve monthly digital currency prices in a fiat currency. Use when needing long-term monthly OHLC and volume data for a given crypto/fiat pair. Always returns full history; no date range filtering — filter client-side. OHLCV response values are strings; convert to numeric types before calculations.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Market currency (to-currency) from Alpha Vantage list, e.g., ‘EUR’.
string
required
Cryptocurrency symbol (from-currency) from Alpha Vantage list, e.g., ‘BTC’.
string ("json" | "csv")
The format of the output: ‘json’ or ‘csv’. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_DIGITAL_CURRENCY_WEEKLYTool to retrieve weekly digital currency prices in a fiat currency. Use when needing weekly OHLC and volume data for a given crypto/fiat pair.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Market currency (to-currency) from Alpha Vantage list, e.g., ‘USD’.
string
required
Cryptocurrency symbol (from-currency) from Alpha Vantage list, e.g., ‘BTC’.
string ("json" | "csv")
The format of the output: ‘json’ or ‘csv’. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_DURABLESTool to fetch monthly manufacturers’ new orders of durable goods data for the United States. Use when you need historical data on big-ticket consumer purchases like cars, appliances, and refrigerators.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format. Only ‘json’ is supported. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_EARNINGSRetrieve annual and quarterly earnings per share history for a company symbol. Provider information and rate-limit notices are reported as errors.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Stock ticker symbol for a publicly traded company (e.g., ‘IBM’, ‘AAPL’, ‘MSFT’). Must be a valid ticker symbol, not a URL or other format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_EARNINGS_CALENDARRetrieve upcoming earnings calendar entries as CSV, optionally filtered by symbol, for a 3-, 6-, or 12-month horizon.

Input Parameters

string
(Optional) Ticker symbol to filter the earnings calendar, e.g., ‘IBM’. Omitting this filter returns all symbols and can produce a very large response.
string ("3month" | "6month" | "12month")
Time horizon to return upcoming earnings within. Valid values: ‘3month’, ‘6month’, ‘12month’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_EARNINGS_CALL_TRANSCRIPTRetrieve an earnings call transcript for a company and quarter, with speaker entries and optional sentiment signals. Missing or empty transcripts and provider information messages are reported as errors.

Input Parameters

string
required
The stock ticker symbol, e.g., ‘IBM’.
string
required
Fiscal quarter in YYYYQn format, e.g., ‘2024Q1’. Any quarter since 2010Q1 is supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_FEDERAL_FUNDS_RATETool to fetch daily, weekly, and monthly federal funds rate data of the United States. Use when you need historical interest rate data from the US Federal Reserve for economic analysis.

Input Parameters

string ("daily" | "weekly" | "monthly")
Time interval for the data. Allowed values: ‘daily’, ‘weekly’, ‘monthly’. Determines the frequency of the federal funds rate data points. Defaults to ‘monthly’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_FX_DAILYTool to fetch daily time series (open, high, low, close) for a currency pair. Use after confirming base and quote currency codes to retrieve historical daily FX rates. Response keys are timestamp strings and are not guaranteed to be sorted; always sort explicitly to find the most recent entry. Weekends and market holidays are excluded from the series.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Return format. Only JSON is supported. Defaults to ‘json’.
string
required
The quote currency code in three-letter ISO format (e.g., ‘USD’, ‘EUR’, ‘JPY’). Note: Precious metal codes like XAU (gold) and XAG (silver) are NOT supported by this endpoint.
string ("compact" | "full")
Return the latest 100 data points (‘compact’) or full-length time series (‘full’). Defaults to ‘compact’. Historical data availability is limited; ‘full’ output may be incomplete for very old date ranges.
string
required
The base currency code in three-letter ISO format (e.g., ‘EUR’, ‘USD’, ‘GBP’). Note: Precious metal codes like XAU (gold) and XAG (silver) are NOT supported by this endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_FX_INTRADAYTool to retrieve intraday OHLC time series for a forex pair at 1-60 minute intervals (premium endpoint). Use when you need minute-bar FX data for backtesting or monitoring. Note: This is a premium Alpha Vantage function; check entitlement if errors occur.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Return format. Only JSON is supported. Defaults to ‘json’.
string ("1min" | "5min" | "15min" | "30min" | "60min")
required
Time interval between data points. Must be one of: 1min, 5min, 15min, 30min, or 60min.
string
required
The quote currency code in three-letter ISO format (e.g., ‘USD’, ‘EUR’, ‘JPY’).
string ("compact" | "full")
Return the latest 100 data points (‘compact’) or full-length time series (‘full’). Defaults to ‘compact’.
string
required
The base currency code in three-letter ISO format (e.g., ‘EUR’, ‘USD’, ‘GBP’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_FX_MONTHLYTool to get monthly time series (open, high, low, close) for a currency pair. Use when you need historical monthly forex data for a given currency pair. Data is returned in reverse-chronological order; OHLC values are strings and must be cast to numeric types before computations. The most recent entry may represent an incomplete period — treat its OHLC values as preliminary until the month closes.

Input Parameters

string ("json" | "csv")
The format of the output. ‘json’ or ‘csv’. Defaults to ‘json’.
string
required
The quote currency code in three-letter ISO format (e.g., ‘USD’, ‘EUR’, ‘CHF’). Must be a physical fiat currency from Alpha Vantage’s supported list.
string
required
The base currency code in three-letter ISO format (e.g., ‘EUR’, ‘GBP’, ‘JPY’). Must be a physical fiat currency from Alpha Vantage’s supported list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_FX_WEEKLYTool to get weekly time series (open, high, low, close) for a currency pair. Use when you need weekly FX rates. Results are reverse-chronological; sort ascending and cast OHLC string values to numeric before computing indicators. The most recent entry may represent an incomplete week — treat its high, low, and close as provisional until the week closes.

Input Parameters

string
The output format. Defaults to ‘json’.
string
required
The quote currency code in three-letter ISO format, e.g., ‘USD’.
string
required
The base currency code in three-letter ISO format, e.g., ‘EUR’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_GET_DIVIDENDSRetrieve historical dividend dates and amounts for a stock symbol. Provider notices or informational messages are returned as an empty dividend list.

Input Parameters

string
required
Stock ticker symbol to retrieve dividend history for, e.g., ‘IBM’ or ‘AAPL’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_GET_HISTORICAL_OPTIONSTool to retrieve full historical options chain for a symbol on a specific date with 15+ years of history, including Greeks and IV. Use when you need historical options data with pricing, volume, and Greeks for analysis. Note: This is a premium Alpha Vantage endpoint.

Input Parameters

string
Historical date in YYYY-MM-DD format for which to retrieve options chain data. Defaults to the previous trading session if not provided. Accepts any date later than 2008-01-01.
string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
The equity symbol for which to retrieve historical options chain data (e.g., ‘IBM’, ‘AAPL’, ‘TSLA’).
string
Response format: ‘json’ (default). Note: CSV format is not supported by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_GET_SLIDING_WINDOW_ANALYTICSTool to retrieve advanced analytics metrics with sliding window calculations for trend analysis. Use when you need to perform statistical analysis on stock price movements over time, such as calculating moving averages, standard deviations, variances, or correlations between multiple stocks. Ideal for technical analysis and identifying trends.

Input Parameters

string ("open" | "high" | "low" | "close")
Valid OHLC price types.
string
required
Date range for analysis in YYYY-MM-DD format. Can be a single date (e.g., ‘2023-07-01’) or two comma-separated dates for a range (e.g., ‘2023-01-01,2023-12-31’). The sliding window calculations will be performed over this time period.
string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Comma-separated list of stock symbols to analyze (e.g., ‘IBM’, ‘AAPL,MSFT’, ‘TSLA,GOOGL,AMZN’). Multiple symbols allow for correlation and comparative analysis across stocks.
string ("1min" | "5min" | "15min" | "30min" | "60min" | "DAILY" | "WEEKLY" | "MONTHLY")
required
Time interval between data points. Use intraday intervals (1min, 5min, 15min, 30min, 60min) for short-term analysis or period intervals (DAILY, WEEKLY, MONTHLY) for longer-term trend analysis.
integer
required
The size of the sliding window for calculations. This determines how many data points are included in each calculation window. For example, window_size=30 with DAILY interval means 30-day moving calculations.
string
required
Comma-separated list of statistical calculations to perform on the sliding window (e.g., ‘MEAN’, ‘STDDEV’, ‘VARIANCE’, ‘CORRELATION’). Note: Free API keys may be limited to one calculation at a time. Common calculations include MEAN (average), STDDEV (standard deviation), VARIANCE, and CORRELATION (for multiple symbols).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_GLOBAL_QUOTERetrieve the latest available price, volume, and daily trading metrics for a specified security ticker. Quote timeliness depends on the data available through the provider and account.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
The stock ticker symbol to retrieve quote data for, e.g., ‘IBM’, ‘AAPL’, ‘TSLA’. Accepts only one symbol per call; retrieve multiple quotes with separate requests.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_INCOME_STATEMENTTool to fetch annual and quarterly income statements. Use after confirming the company symbol. Numeric fields may be returned as strings or empty values — convert safely and treat empty/missing as null, not zero, before computing derived metrics. Some symbols may be missing fields entirely; treat absent fields as missing data rather than defaults. One API call per symbol; when processing multiple symbols, retain only key derived fields rather than full raw responses.

Input Parameters

string
required
Stock ticker symbol to retrieve income statements for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_INFLATIONTool to fetch annual U.S. inflation rates (consumer prices). Use when you need historical inflation data for economic analysis.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string ("json" | "csv")
Output format: ‘json’ for JSON response or ‘csv’ for CSV. Defaults to ‘json’.
string ("annual" | "monthly" | "weekly" | "daily")
Data interval for the series. Valid values: ‘annual’, ‘monthly’, ‘weekly’, ‘daily’. Note: INFLATION primarily returns annual data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_IPO_CALENDARTool to retrieve the IPO calendar for the next three months. Use when you need a list of upcoming IPO events across markets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_LISTING_STATUSTool to fetch listing status of US stocks and ETFs. Use when you need active or delisted securities as of a date.

Input Parameters

string
Date to retrieve listing status (YYYY-MM-DD). Defaults to latest trading day.
string ("active" | "delisted")
Listing state: ‘active’ for current listings or ‘delisted’ for removed securities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_MARKET_STATUSTool to retrieve current market status (open/closed) for global stock exchanges. Use when you need to check if major trading venues worldwide are currently open or closed.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Optional API key to override metadata (e.g., ‘demo’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_NEWS_SENTIMENTTool to fetch live and historical market news & sentiment. Use when you need curated news articles with sentiment scores for specified tickers and topics.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string ("LATEST" | "EARLIEST" | "RELEVANCE")
Sort order for articles: ‘LATEST’, ‘EARLIEST’, or ‘RELEVANCE’.
integer
Maximum number of articles to return (1-1000). Default is 50. For large result sets, articles may be returned in a remote/attached payload rather than inline — do not assume an inline preview contains all requested articles.
array
List of topics to filter articles, e.g. [‘technology’,‘ipo’]. Supported values are the topic literals.
string
Comma-separated tickers or asset identifiers to filter articles. Each ticker can only contain alphanumeric characters, colons, and underscores. Examples: ‘AAPL’, ‘CRYPTO:BTC’, ‘FOREX:USD’, ‘AAPL,CRYPTO:BTC,FOREX:USD’.
string
End of time range (inclusive) in YYYYMMDDTHHMM format. If omitted, defaults to current time.
string
Start of time range (inclusive) in YYYYMMDDTHHMM format, e.g. ‘20220410T0130’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_NONFARM_PAYROLLTool to fetch monthly U.S. nonfarm payroll employment data from the Bureau of Labor Statistics. Use when you need historical employment statistics for economic analysis.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format. Only ‘json’ is supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_REAL_GDPTool to fetch U.S. real GDP time series. Use when you need quarterly or annual GDP data.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format. Only ‘json’ is supported.
string ("annual" | "quarterly")
Data interval: ‘annual’ for yearly GDP or ‘quarterly’ for quarterly GDP. Defaults to ‘annual’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_REAL_GDP_PER_CAPITAFetch U.S. real GDP per capita data at an annual or quarterly interval, for inflation-adjusted economic analysis.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format. Only ‘json’ is supported. Defaults to ‘json’.
string ("annual" | "quarterly")
Data interval: ‘annual’ for yearly data or ‘quarterly’ for quarterly data. Defaults to ‘annual’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_REALTIME_BULK_QUOTESTool to retrieve realtime quotes for US-traded symbols in bulk (up to 100 symbols per request). Use when you need current price and volume data for multiple symbols simultaneously, covering both regular and extended trading hours. This is a premium API function requiring subscription. If subscription access is denied, use ALPHA_VANTAGE_GLOBAL_QUOTE for single-symbol quotes.

Input Parameters

string
Optional API key to override metadata (e.g., ‘demo’). If not provided, uses the API key from metadata.
string
required
Up to 100 stock ticker symbols separated by comma (e.g., ‘IBM,AAPL,MSFT’). This parameter accepts multiple symbols in a single request for bulk quote retrieval. No spaces around commas; ‘IBM, AAPL’ is invalid.
string
Response format. Only ‘json’ is supported. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_RETAIL_SALESTool to fetch monthly retail trade sales data of the United States. Use when you need historical U.S. retail sales statistics sourced from Census Bureau.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format: ‘json’ for JSON response. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_SECTORTool to retrieve real-time and historical sector performance data. Use when you need sector performance metrics across timeframes.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_SPLITSRetrieve historical stock split events for a symbol, including split dates and factors. API notices or informational responses are returned as an empty event list, which does not necessarily mean there were no splits.

Input Parameters

string
required
Stock ticker symbol to retrieve split history for, e.g., ‘IBM’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_SUGARTool to retrieve the global sugar price series. Use when you need historical monthly, quarterly, or annual sugar prices.

Input Parameters

string
Response format. Only ‘json’ is supported.
string ("monthly" | "quarterly" | "annual")
Time resolution: monthly, quarterly, or annual.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_SYMBOL_SEARCHSearch for ticker symbols by name or keyword and return best matches with details such as region, currency, and match score.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Optional API key to override metadata (e.g., ‘demo’). Overrides the integration-level key; Alpha Vantage enforces per-minute and per-day rate limits across all endpoints, so throttle sequential calls accordingly.
string ("json" | "csv")
The format of the response: ‘json’ or ‘csv’. Defaults to ‘json’.
string
required
The keywords to search for symbols (e.g., ‘microsoft’). Must be non-empty; blank or whitespace-only strings return no meaningful results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TECHNICAL_INDICATORFetch technical indicators such as moving averages or oscillators for an equity or currency pair. Results are returned in an indicator mapping with string values; an intraday month can be specified.

Input Parameters

string
Month (YYYY-MM) for intraday data; only for 1min–60min intervals.
string
required
Equity ticker or currency/crypto pair to analyze. Must be a valid stock ticker (e.g., ‘IBM’, ‘AAPL’) or currency/crypto pair (e.g., ‘USDEUR’, ‘BTCUSD’). Alphanumeric characters only, no URLs or special characters.
string ("json" | "csv")
Output format: ‘json’ or ‘csv’.
string
required
Technical indicator function name. E.g., ‘SMA’, ‘MACD’, ‘RSI’.
string ("1min" | "5min" | "15min" | "30min" | "60min" | "daily" | "weekly" | "monthly")
required
Time interval between data points.
string ("close" | "open" | "high" | "low")
required
Series to use for calculation (price type).
integer
required
Number of periods for indicator calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_DAILYRetrieve daily open, high, low, close, and volume data for a global equity symbol. The action supports compact output of the latest 100 data points.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
The stock ticker symbol. For US stocks, use the ticker only (e.g., ‘IBM’, ‘MSFT’, ‘AAPL’). For international stocks, append the exchange suffix: ’.LON’ for London Stock Exchange (e.g., ‘TSCO.LON’), ’.TRT’ for Toronto Stock Exchange (e.g., ‘SHOP.TRT’), ’.DEX’ for XETRA Germany (e.g., ‘MBG.DEX’), ’.BSE’ for Bombay Stock Exchange (e.g., ‘RELIANCE.BSE’), ’.SHH’ for Shanghai Stock Exchange (e.g., ‘600104.SHH’), ’.SHZ’ for Shenzhen Stock Exchange (e.g., ‘000002.SHZ’). Note: Common Chinese exchange suffixes ’.SH’ and ’.SZ’ are automatically converted to ’.SHH’ and ’.SHZ’ respectively. Use the SYMBOL_SEARCH action to find valid symbols for any global stock. Do not pass URLs - just the ticker symbol itself.
string ("json" | "csv")
The format of the output: ‘json’ or ‘csv’. Defaults to ‘json’. Note: CSV format is not supported by this action.
string
Output size: ‘compact’ returns the latest 100 data points. Note: ‘full’ output (20+ years of historical data) is only available with a premium Alpha Vantage subscription and is not supported by this action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_INTRADAYRetrieve intraday OHLCV data for an equity at a selected interval, with options for adjusted prices, extended hours, and historical months.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Specific month in ‘YYYY-MM’ format for historical intraday data; only for intraday intervals Very old dates may return no data; intraday history coverage is limited.
string
required
The stock ticker symbol. For US stocks, use the ticker only (e.g., ‘IBM’, ‘MSFT’, ‘AAPL’). For international stocks, append the exchange suffix: ’.LON’ for London Stock Exchange (e.g., ‘TSCO.LON’), ’.TRT’ for Toronto Stock Exchange (e.g., ‘SHOP.TRT’), ’.DEX’ for XETRA Germany (e.g., ‘MBG.DEX’), ’.BSE’ for Bombay Stock Exchange (e.g., ‘RELIANCE.BSE’), ’.SHH’ for Shanghai Stock Exchange (e.g., ‘600104.SHH’), ’.SHZ’ for Shenzhen Stock Exchange (e.g., ‘000002.SHZ’). Do not pass URLs - just the ticker symbol itself.
string ("true" | "false")
Return split/dividend-adjusted values (‘true’) or raw as-traded values (‘false’)
string ("json" | "csv")
Response format: ‘json’ (default) or ‘csv’ Response structure differs significantly between ‘json’ and ‘csv’ — ensure parsing logic matches the selected format.
string ("1min" | "5min" | "15min" | "30min" | "60min")
required
Time interval between data points Accepted values: ‘1min’, ‘5min’, ‘15min’, ‘30min’, ‘60min’ only.
string ("compact" | "full")
Return latest 100 points (‘compact’) or full-length data (‘full’) Free-tier keys may return an ‘Information’ block instead of data when ‘full’ is requested.
string ("true" | "false")
Include pre/post-market data (‘true’) or only regular hours (‘false’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_INTRADAY_EXTENDEDRetrieve historical intraday OHLCV data for an equity for a selected monthly slice within the trailing two years. Supports adjusted or raw prices at several intraday intervals.

Input Parameters

string
required
Specifies which 30-day window of data to retrieve from the trailing 2 years. Valid values: ‘year1month1’ (most recent), ‘year1month2’, …, ‘year1month12’, ‘year2month1’, ‘year2month2’, …, ‘year2month12’ (oldest)
string
required
Equity ticker symbol, e.g., ‘IBM’, ‘AAPL’, ‘TSLA’
string ("true" | "false")
When ‘true’ (default), output is adjusted by historical split and dividend events. Set to ‘false’ to query raw as-traded intraday values
string ("1min" | "5min" | "15min" | "30min" | "60min")
required
Time interval between consecutive data points

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_MONTHLYTool to retrieve monthly open, high, low, close, and volume for a global equity. Use when you need month-end OHLCV data for a specific stock symbol.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Equity ticker symbol to retrieve monthly data for, e.g., ‘IBM’.
string ("json" | "csv")
The format of the output: ‘json’ or ‘csv’. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_MONTHLY_ADJUSTEDTool to retrieve monthly adjusted OHLC and volume for a global equity. Use after confirming the ticker symbol when you need end-of-month adjusted price and dividend data. Dividends are returned as a single aggregated value per month; annual or multi-year payout totals require manual summation across monthly data points.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Equity ticker symbol (e.g., ‘IBM’).
string ("json" | "csv")
Return format. Only ‘json’ is supported. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_WEEKLYTool to fetch weekly open, high, low, close, and volume for a global equity symbol. Use after confirming the target symbol to obtain its historical weekly OHLCV series. Alpha Vantage enforces per-minute and per-day rate limits; throttle sequential calls combining this tool with other time series or fundamentals endpoints.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Global equity symbol to retrieve weekly time series for, e.g., ‘IBM’. Equity/FX-style symbols only (e.g., ‘IBM’, ‘MSFT’); cryptocurrency symbols use a separate symbol/market pair format and are invalid here.
string ("json" | "csv")
Response format. JSON is supported; CSV is not supported. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TIME_SERIES_WEEKLY_ADJUSTEDTool to fetch weekly adjusted time series data with split/dividend adjustments, covering 20+ years of historical data. Use after confirming the target symbol to obtain its historical weekly adjusted OHLCV series with dividend information.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
required
Global equity symbol to retrieve weekly adjusted time series for, e.g., ‘IBM’. Accepts exactly one symbol per call; multiple symbols require separate calls.
string ("json" | "csv")
Response format. JSON is supported; CSV is not supported. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TOP_GAINERS_LOSERSTool to fetch the top 20 gainers, losers, and most actively traded US tickers. Use when you need current market movers data without maintaining a ticker universe. Data is updated end-of-day by default, with realtime/15-min delayed access available via premium.Instant: Supported on the latest version.Instant pricing: Estimated $0.006 per 100 requestsDiscount: 65

Input Parameters

string
Optional API key to override metadata (e.g., ‘demo’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_TREASURY_YIELDTool to fetch US Treasury yield data for specified maturity and interval. Use when you need daily, weekly, or monthly treasury yield rates for various constant maturities (3-month, 2-year, 5-year, 7-year, 10-year, 30-year).

Input Parameters

string ("daily" | "weekly" | "monthly")
Time interval for the data. Allowed values: ‘daily’, ‘weekly’, ‘monthly’. Determines the frequency of the treasury yield data points.
string ("3month" | "2year" | "5year" | "7year" | "10year" | "30year")
Tenor or constant maturity of the treasury yield. Allowed values: ‘3month’, ‘2year’, ‘5year’, ‘7year’, ‘10year’, ‘30year’. Default is ‘10year’ if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_UNEMPLOYMENTTool to fetch monthly unemployment rate data of the United States. Use when you need historical U.S. unemployment statistics sourced from Bureau of Labor Statistics.

Input Parameters

string
Override API key. If provided, this key is used instead of metadata’s apikey.
string
Output format: ‘json’ for JSON response. Defaults to ‘json’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ALPHA_VANTAGE_WHEATTool to fetch global price of wheat. Use when you need historical wheat prices in monthly, quarterly, or annual intervals.

Input Parameters

string ("json" | "csv")
Output format: json or csv
string ("monthly" | "quarterly" | "annual")
Time horizon for wheat prices

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not