Skip to main content
Polygon.io logo
  • Category: analytics
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 60
  • Triggers: 0
  • Slug: POLYGON_IO
  • Version: 20261101_00

Tools

Slug: POLYGON_IO_GET_ALL_TICKERSRetrieve a page of supported ticker symbols across asset classes, with details such as symbol, name, market, and status. Results can be filtered and paginated using a cursor.

Input Parameters

string
Filter by CIK identifier.
string
Filter tickers as of a specific date, format YYYY-MM-DD.
string
Field name to sort by (e.g., ‘ticker’, ‘name’, ‘market’, ‘primary_exchange’, ‘last_updated_utc’).
string
Filter by asset type (e.g., ‘CS’ for common stock, ‘ETF’, etc.).
string
Filter by CUSIP identifier.
integer
Maximum number of results to return (1-1000).
string ("asc" | "desc")
Sort order direction: ‘asc’ or ‘desc’.
boolean
If true, only return symbols that are currently active.
string
Pagination cursor to fetch next page of results. Pass the ‘cursor’ value from a previous response.
string ("stocks" | "crypto" | "fx" | "otc" | "indices")
Filter by market: ‘stocks’, ‘crypto’, ‘fx’, ‘otc’, or ‘indices’.
Partial text search on ticker symbol or company name.
string
Exact match filter on a single ticker symbol.
string
Filter by specific exchange code (e.g., ‘XNAS’, ‘XNYS’).
string
Return tickers after this symbol.
string
Return tickers before this symbol.
string
Return tickers at or after this symbol.
string
Return tickers at or before this symbol.

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: POLYGON_IO_GET_CONDITION_CODESTool to retrieve a unified list of trade and quote condition codes and their definitions. Use when needing to decode condition identifiers after fetching market data.

Input Parameters

integer
Filter by specific condition code ID (integer).
string
Return conditions that contain a mapping for this SIP.
string
Field used to sort results, e.g., ‘name’, ‘asset_class’, ‘id’.
integer
Maximum number of results to return (server default: 10).
string ("asc" | "desc")
Order of results: ‘asc’ (ascending) or ‘desc’ (descending).
string ("trade" | "quote")
Filter by data type: ‘trade’ or ‘quote’.
string ("stocks" | "options" | "crypto" | "fx")
Filter by asset class, e.g., ‘stocks’, ‘crypto’, ‘fx’.

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: POLYGON_IO_GET_CRYPTO_EMATool to calculate Exponential Moving Average (EMA) technical indicator for a crypto ticker. Use when you need trend analysis or moving average calculations for cryptocurrency pairs.

Input Parameters

integer
Limit the number of results returned. Defaults to 10. Maximum is 5000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. Defaults to ‘desc’.
integer
The window size used to calculate the exponential moving average (EMA). For example, a window size of 10 with daily aggregates would result in a 10 day moving average. Defaults to 50.
boolean
Whether or not the aggregates used to calculate the EMA are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
The size of the aggregate time window. Defaults to ‘day’.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the exponential moving average. Defaults to ‘close’.
string
Filter for timestamps greater than the specified value.
string
Filter for timestamps less than the specified value.
string
required
The cryptocurrency ticker symbol in the format X:BTCUSD, X:ETHBTC, etc. Must include the ‘X:’ prefix for cryptocurrency pairs.
string
Filter for timestamps greater than or equal to the specified value.
string
Filter for timestamps less than or equal to the specified value.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_CRYPTO_MACDTool to calculate Moving Average Convergence/Divergence (MACD) technical indicator for a crypto ticker. Use when you need momentum analysis, trend identification, or trading signal generation for cryptocurrency pairs.

Input Parameters

integer
Limit the number of results returned. Must be between 1 and 5000. Defaults to 10.
string ("asc" | "desc")
Order of results by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
boolean
Whether or not the aggregates used to calculate the MACD are adjusted for splits. Defaults to True.
string
The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. Defaults to ‘day’.
string
Query by timestamp. Either a date with format YYYY-MM-DD or a millisecond timestamp.
integer
required
The long window size (number of periods) used to calculate MACD data. Traditional value: 26.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate MACD. Options: open, high, low, close. Defaults to ‘close’.
integer
required
The short window size (number of periods) used to calculate MACD data. Traditional value: 12.
string
required
The crypto ticker symbol in format X:FROMTO (e.g., ‘X:BTCUSD’, ‘X:ETHUSD’). Must include the ‘X:’ prefix for cryptocurrency pairs.
integer
required
The window size (number of periods) used to calculate the MACD signal line. Traditional value: 9.
boolean
Whether to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_CRYPTO_OPEN_CLOSERetrieve daily open and close prices for a cryptocurrency pair on a specific date, with opening and closing trades when available.

Input Parameters

string
required
The “to” symbol of the cryptocurrency pair (e.g., USD, EUR).
string
required
The date of the requested open/close in the format YYYY-MM-DD.
string
required
The “from” symbol of the cryptocurrency pair (e.g., BTC, ETH).
boolean
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.

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: POLYGON_IO_GET_CRYPTO_RSITool to calculate the Relative Strength Index (RSI) for a cryptocurrency ticker. Use when you need to analyze momentum or identify overbought/oversold conditions for crypto assets.

Input Parameters

integer
Limit the number of results returned. Default: 5000. Max: 5000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. Defaults to ‘desc’.
integer
The window size used to calculate the relative strength index (RSI). Defaults to 14.
boolean
Whether or not the aggregates used to calculate the RSI are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
The size of the aggregate time window. Defaults to ‘day’.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the relative strength index. Defaults to ‘close’.
string
Filter for timestamps greater than the specified value.
string
Filter for timestamps less than the specified value.
string
required
The cryptocurrency ticker symbol in the format X:BTCUSD, X:ETHBTC, etc.
string
Filter for timestamps greater than or equal to the specified value.
string
Filter for timestamps less than or equal to the specified value.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_CRYPTO_SMATool to calculate Simple Moving Average (SMA) technical indicator for a cryptocurrency ticker. Use when you need trend analysis, support/resistance levels, or trading signal generation for crypto pairs.

Input Parameters

integer
Limit the number of base aggregates queried to create the aggregate results. Min: 1, Max: 50000. Defaults to 5000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
integer
required
The window size (number of periods) used to calculate the SMA. For example, 50 for a 50-period moving average.
boolean
Whether or not the aggregates used to calculate the SMA are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the SMA. Options: open, high, low, close. Defaults to ‘close’.
string
Filter for timestamps greater than the specified value.
string
Filter for timestamps less than the specified value.
string
required
The cryptocurrency ticker symbol in the format X:BTCUSD, X:ETHUSD, etc. Must include the ‘X:’ prefix for cryptocurrency pairs.
string
Filter for timestamps greater than or equal to the specified value.
string
Filter for timestamps less than or equal to the specified value.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_DAILY_OPEN_CLOSETool to get the daily open, close, after-hours, and pre-market prices for a stock on a specific date. Use when you need historical OHLC data for a specific trading day, including pre-market and after-hours information.

Input Parameters

string
required
The date of the requested open/close in the format YYYY-MM-DD (e.g., ‘2023-03-10’, ‘2026-02-13’).
boolean
Whether or not the results are adjusted for splits. Default is true.
string
required
The ticker symbol of the stock (e.g., ‘AAPL’, ‘TSLA’, ‘MSFT’). Must be a valid stock ticker.

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: POLYGON_IO_GET_DIVIDENDSTool to retrieve a historical record of cash dividend distributions for a given ticker. Use when analyzing dividend payments by date, amount, and frequency.

Input Parameters

string
Field to sort by; only ‘ex_dividend_date’ is supported.
integer
Limit number of results (1-1000).
string ("asc" | "desc")
Order of sorting: ‘asc’ or ‘desc’.
string
Case-sensitive ticker symbol, e.g., ‘AAPL’.
string
Filter by payment date (YYYY-MM-DD).
integer ("0" | "1" | "2" | "4" | "12" | "24" | "52")
Number of dividend payments per year. 0=one-time, 1=annually, 2=bi-annually, 4=quarterly, 12=monthly, 24=bi-monthly, 52=weekly.
number
Filter by cash amount of the dividend per share.
string
Filter by record date (YYYY-MM-DD).
string ("CD" | "SC" | "LT" | "ST")
Type of dividend: ‘CD’ for consistent cash, ‘SC’ for special cash, ‘LT’ for long-term capital gain, ‘ST’ for short-term capital gain.
string
Filter by declaration date (YYYY-MM-DD).
string
Filter by ex-dividend date (YYYY-MM-DD).

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: POLYGON_IO_GET_ECONOMY_INFLATION2Tool to retrieve key indicators of realized inflation including CPI and PCE price indexes with comprehensive date filtering. Use when analyzing inflation trends with specific date ranges, economic conditions, or historical price changes going back to 1947.

Input Parameters

string
Specific observation date in YYYY-MM-DD format. If not provided, returns recent observations.
string
Sort order for results. Use ‘date.asc’ for ascending or ‘date.desc’ for descending. Defaults to ‘date.asc’.
integer
Maximum results to return. Defaults to 100, maximum is 50,000.
string
Filter for dates greater than the specified date in YYYY-MM-DD format
string
Filter for dates less than the specified date in YYYY-MM-DD format
string
Filter for dates greater than or equal to the specified date in YYYY-MM-DD format
string
Filter for dates less than or equal to the specified date in YYYY-MM-DD format
string
Match multiple comma-separated dates, e.g., ‘2024-01-01,2024-02-01’

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: POLYGON_IO_GET_EMATool to retrieve the Exponential Moving Average for a stock ticker. Use when you need EMA values across a specific timespan with optional underlying data.

Input Parameters

integer
Maximum number of results to return (1-5000). Defaults to 100.
string ("asc" | "desc")
Sort order for results. Defaults to ‘desc’.
integer
required
Number of periods to calculate the EMA (must be ≥1).
boolean
Whether to adjust results for splits/dividends. Defaults to True.
string
required
The timespan for each period (e.g., ‘day’, ‘minute’, ‘hour’).
string ("open" | "high" | "low" | "close")
Price series to use. Defaults to ‘close’.
string
required
The stock ticker symbol.
boolean
Include underlying price data. Defaults to 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: POLYGON_IO_GET_FILINGTool to retrieve detailed information about a specific SEC filing by filing ID. Use when you need to access full filing details including accession number, filing type, dates, source URLs, and associated entities.

Input Parameters

string
required
The unique filing ID (accession number format: XXXXXXXXXX-XX-XXXXXX). Example: ‘0002057381-26-000010’

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: POLYGON_IO_GET_FILING_FILEDownload a specific file from an SEC filing as a downloadable file. Use to access individual documents such as 10-Q, 10-K, or other submission files.

Input Parameters

string
required
The unique identifier for the file within the filing, e.g., ‘readvantage10q_12312025.htm’ or ‘ex31.htm’. Use the filename from the LIST_FILING_FILES action.
string
required
The unique identifier for the SEC filing, e.g., ‘0002057381-26-000010’. This is the filing accession number.

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: POLYGON_IO_GET_FOREX_EMATool to calculate Exponential Moving Average (EMA) technical indicator for a forex pair. Use when you need trend analysis or moving average calculations for currency pairs.

Input Parameters

integer
Limit the number of results returned. Defaults to 10. Maximum is 5000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ for ascending/oldest first, ‘desc’ for descending/newest first. Defaults to ‘desc’.
integer
The window size used to calculate the exponential moving average (EMA). For example, a window size of 10 with daily aggregates would result in a 10 day moving average. Defaults to 50.
boolean
Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
The size of the aggregate time window. Defaults to ‘day’.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the exponential moving average. Defaults to ‘close’.
string
required
The forex ticker symbol in format C:FROMTO (e.g., ‘C:EURUSD’, ‘C:GBPJPY’). Must include the ‘C:’ prefix for forex currency pairs.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_FOREX_MACDTool to calculate Moving Average Convergence/Divergence (MACD) technical indicator for a forex pair. Use when you need momentum analysis, trend identification, or trading signal generation for currency pairs.

Input Parameters

integer
Maximum number of results to return. Must be between 1 and 5000. Defaults to 10.
string ("asc" | "desc")
The order in which to return results, ordered by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
boolean
Whether the aggregates used to calculate MACD are adjusted for splits. Defaults to True.
string
required
The size of the aggregate time window (e.g., ‘day’, ‘hour’, ‘minute’).
string
Filter by timestamp. Can be a date in YYYY-MM-DD format or a millisecond timestamp.
integer
required
The long window size (number of periods) used to calculate MACD data. Typically 26.
string ("open" | "high" | "low" | "close")
The price field in the aggregate which will be used to calculate MACD. Defaults to ‘close’.
string
required
The forex ticker symbol in format C:FROMTO (e.g., ‘C:EURUSD’, ‘C:GBPJPY’). Must include the ‘C:’ prefix for forex currency pairs.
integer
required
The short window size (number of periods) used to calculate MACD data. Typically 12.
string
Range filter - only include results where timestamp is greater than this value. Format: YYYY-MM-DD or millisecond timestamp.
string
Range filter - only include results where timestamp is less than this value. Format: YYYY-MM-DD or millisecond timestamp.
integer
required
The window size (number of periods) used to calculate the MACD signal line. Typically 9.
string
Range filter - only include results where timestamp is greater than or equal to this value. Format: YYYY-MM-DD or millisecond timestamp.
string
Range filter - only include results where timestamp is less than or equal to this value. Format: YYYY-MM-DD or millisecond timestamp.
boolean
Whether to include the underlying aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_FOREX_REAL_TIME_CURRENCY_CONVERSIONTool to convert amounts between currency pairs using real-time forex rates. Use when you need to perform currency conversions with the latest market rates.

Input Parameters

number
The amount to convert with decimal precision. If not provided, defaults to 1.
integer
The decimal precision of the conversion result. Defaults to 2 decimal places.
string
required
The ‘to’ currency symbol to convert to (e.g., ‘EUR’, ‘USD’, ‘JPY’).
string
required
The ‘from’ currency symbol to convert from (e.g., ‘USD’, ‘EUR’, ‘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: POLYGON_IO_GET_FOREX_RSITool to calculate the Relative Strength Index (RSI) technical indicator for a forex pair. Use when you need momentum analysis or want to identify overbought/oversold conditions for currency pairs.

Input Parameters

integer
Limit the number of results returned. Default: 5000. Max: 5000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
integer
required
The window size used to calculate the Relative Strength Index (RSI). Typically 14 for standard RSI calculation.
boolean
Whether or not the aggregates used to calculate the RSI are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
The size of the aggregate time window. Required parameter to define the period for RSI calculation.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the RSI. Defaults to ‘close’.
string
required
The forex ticker symbol in format C:FROMTO (e.g., ‘C:EURUSD’, ‘C:GBPJPY’). Must include the ‘C:’ prefix for forex currency pairs.
string
Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_FOREX_SMATool to calculate Simple Moving Average (SMA) technical indicator for a forex pair. Use when you need trend analysis or moving average calculations for currency pairs.

Input Parameters

integer
Limit the number of results returned. Defaults to 10. Maximum is 5000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ for ascending/oldest first, ‘desc’ for descending/newest first. Defaults to ‘desc’.
integer
The window size used to calculate the SMA. For example, a window of 10 with daily aggregates equals a 10-day moving average. Defaults to 50.
boolean
Whether or not the aggregates used to calculate the SMA are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
The size of the aggregate time window. Defaults to ‘day’.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the SMA. Defaults to ‘close’.
string
required
The forex ticker symbol in format C:FROMTO (e.g., ‘C:EURUSD’, ‘C:GBPJPY’). Must include the ‘C:’ prefix for forex currency pairs.
string
Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_FUTURES_QUOTESTool to get real-time quote information for futures contracts with bid/ask prices, sizes, and timestamps. Use when you need to analyze current or historical quote data for futures trading decisions.

Input Parameters

string
Comma-separated sort columns with optional .asc or .desc suffixes.
integer
Limit the number of results returned per page. Default: 1000, Maximum: 50000.
string
Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.
string
Return quotes after this timestamp.
string
Return quotes before this timestamp.
string
Return quotes at or after this timestamp.
string
Return quotes at or before this timestamp.
string
required
The futures contract ticker symbol including base symbol and contract expiration (e.g., ‘GCJ25’ for Gold April 2025, ‘ESZ5’ for E-mini S&P 500 December 2025).
string
Trading session end date in YYYY-MM-DD 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: POLYGON_IO_GET_GROUPED_DAILYTool to retrieve daily OHLCV data for the entire market for a given date. Use when you need grouped daily aggregate bars for all tickers in a specific market (stocks, crypto, or fx) and locale.

Input Parameters

string
required
The date to get aggregate bars for in YYYY-MM-DD format (e.g., ‘2026-02-13’).
string ("us" | "global")
required
The locale of the aggregates. Specify ‘us’ for US market or ‘global’ for global markets.
string ("stocks" | "crypto" | "fx")
required
The market type. Options are ‘stocks’, ‘crypto’, or ‘fx’.
boolean
Whether results are adjusted for splits. Set to false for unadjusted results. Defaults to true.

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: POLYGON_IO_GET_HISTORIC_FOREX_TICKSTool to get historic ticks for a currency pair on a specific date. Use when you need historical forex tick-level data (ask/bid prices with timestamps) for a given day.

Input Parameters

string
required
The specific day for which to retrieve historical tick data in YYYY-MM-DD or YYYY-M-D format (e.g., ‘2017-6-22’, ‘2024-01-15’).
integer
Controls response size; defaults to 100, maximum of 10,000 entries.
integer
Pagination mechanism using timestamp offset to fetch the next set of results.
string
required
The ‘to’ currency symbol (quote currency) in the pair (e.g., ‘JPY’, ‘USD’, ‘EUR’).
string
required
The ‘from’ currency symbol (base currency) in the pair (e.g., ‘USD’, ‘EUR’, ‘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: POLYGON_IO_GET_INFLATION_EXPECTATIONSTool to retrieve inflation expectations data from the Federal Reserve, including market-based rates and Cleveland Fed model estimates. Use when analyzing inflation forecasts across different time horizons (1, 5, 10, and 30 years).

Input Parameters

string
Filter by specific observation date (YYYY-MM-DD format).
string
Comma-separated list of sort columns with .asc or .desc suffix (e.g., ‘date.asc’).
integer
Maximum number of results to return (1-50000). Default: 100.
string
Filter for dates after this value (YYYY-MM-DD format).
string
Filter for dates before this value (YYYY-MM-DD format).
string
Filter for dates on or after this value (YYYY-MM-DD format).
string
Filter for dates on or before this value (YYYY-MM-DD format).
string
Match any of the comma-separated date values (YYYY-MM-DD 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: POLYGON_IO_GET_IPO_DATATool to retrieve comprehensive information on Initial Public Offerings (IPOs), including upcoming and historical events. Use when analyzing IPO listing data by date range, ticker, or identifier.

Input Parameters

string
Filter by ISIN (International Securities Identification Number).
string
Field to sort by (e.g., ‘listing_date’, ‘ticker’). Default: ‘listing_date’.
integer
Limit the number of results returned (1-1000). Default: 10, Max: 1000.
string ("asc" | "desc")
Sort order direction: ‘asc’ for ascending or ‘desc’ for descending. Default: ‘desc’.
string
Filter by ticker symbol.
string
Filter by US code (ISIN identifier).
string ("direct_listing_process" | "history" | "new" | "pending" | "postponed" | "rumor" | "withdrawn")
Filter by the current IPO event status.
string
Filter by exact listing date (format: YYYY-MM-DD).
string
Filter for IPOs listed after this date.
string
Filter for IPOs listed before this date.
string
Filter for IPOs listed on or after this date (format: YYYY-MM-DD).
string
Filter for IPOs listed on or before this date (format: YYYY-MM-DD).

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: POLYGON_IO_GET_LABOR_MARKETTool to retrieve labor market data including unemployment rate, labor force participation rate, average hourly earnings, and job openings. Use when analyzing employment trends, economic conditions, or workforce statistics.

Input Parameters

string
Specific observation date in YYYY-MM-DD format. If not provided, returns recent observations.
string
Sort order for results. Comma-separated columns with .asc/.desc direction suffix, e.g., ‘date.asc’ or ‘date.desc’
integer
Maximum results to return. Defaults to 100, maximum is 50,000.
string
Filter for dates greater than the specified date in YYYY-MM-DD format
string
Filter for dates less than the specified date in YYYY-MM-DD format
string
Filter for dates greater than or equal to the specified date in YYYY-MM-DD format
string
Filter for dates less than or equal to the specified date in YYYY-MM-DD format
string
Match multiple comma-separated dates, e.g., ‘2024-01-01,2024-02-01’

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: POLYGON_IO_GET_MACDTool to retrieve the Moving Average Convergence/Divergence (MACD) for a stock ticker. Use when you need momentum analysis or signal generation over a specified timeframe.

Input Parameters

integer
Maximum number of results to return (1-5000). Defaults to 10.
string ("asc" | "desc")
The order of results by timestamp. Defaults to ‘desc’.
boolean
Whether to use split-adjusted aggregates. Defaults to True.
string
required
The size of the aggregate time window (e.g., ‘day’).
string
Filter by timestamp (YYYY-MM-DD or millisecond timestamp).
integer
required
The number of periods for the long EMA window (e.g., 26).
string ("open" | "high" | "low" | "close")
The price field to use for calculations. Defaults to ‘close’.
integer
required
The number of periods for the short EMA window (e.g., 12).
string
required
The case-sensitive ticker symbol for which to get MACD data (e.g., ‘AAPL’).
integer
required
The number of periods for the signal line EMA window (e.g., 9).
boolean
Whether to include the underlying aggregates data. Defaults to 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: POLYGON_IO_GET_MARKET_HOLIDAYSTool to retrieve upcoming market holidays and their corresponding open/close times. Use when planning around market schedules before trading.

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: POLYGON_IO_GET_MARKET_STATUSTool to retrieve the current trading status across major exchanges and currency markets. Use for real-time monitoring, scheduling, or UI updates.

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: POLYGON_IO_GET_NEWSRetrieve market news articles, optionally filtered by ticker and publication date, with summaries and publisher details.

Input Parameters

string
Field to sort by; only ‘published_utc’ is supported
integer
Limit the number of results (1-1000). Defaults to 10 if not provided.
string ("asc" | "desc")
Order of results by published_utc: ‘asc’ or ‘desc’
string
Cursor for pagination. Use the ‘next_url’ or cursor value from previous response.
string
Only return news articles for this ticker symbol, e.g., ‘AAPL’
string
Return articles published on or after this UTC date/time (ISO-8601), e.g., ‘2022-01-01T00:00:00Z’
string
Return articles published on or before this UTC date/time (ISO-8601), e.g., ‘2022-01-31T23:59:59Z’

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: POLYGON_IO_GET_OPTIONS_CONTRACT_OVERVIEWTool to retrieve comprehensive details about a specific options contract including contract type, exercise style, expiration date, strike price, and underlying ticker. Use when you need specifications for options contract analysis or strategy development.

Input Parameters

string
Specify a point in time for the contract as of this date. Format: YYYY-MM-DD. Defaults to today’s date.
string
required
The options contract identifier following standard options ticker format (e.g., O:SPY241220C00450000, O:AAPL251219C00010000).

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: POLYGON_IO_GET_OPTIONS_EMATool to calculate Exponential Moving Average (EMA) technical indicator for an options ticker. Use when you need trend analysis or moving average calculations for options contracts.

Input Parameters

integer
Limit the number of results returned. Must be between 1 and 5000. Defaults to 10.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
integer
required
The window size used to calculate the exponential moving average (EMA). For example, a window size of 10 with daily aggregates would result in a 10 day moving average. Required parameter.
boolean
Whether or not the aggregates used to calculate the EMA are adjusted for splits. Defaults to True.
string
required
The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. Required parameter.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the exponential moving average. Defaults to ‘close’.
string
Filter for timestamps greater than the specified value.
string
Filter for timestamps less than the specified value.
string
Filter for timestamps greater than or equal to the specified value.
string
Filter for timestamps less than or equal to the specified value.
string
required
The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., ‘O:AAPL250117C00250000’). Must include the ‘O:’ prefix for options contracts.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_OPTIONS_MACDTool to calculate Moving Average Convergence/Divergence (MACD) technical indicator for an options ticker. Use when you need momentum analysis, trend identification, or trading signal generation for options contracts.

Input Parameters

integer
Limit the number of results returned. Must be between 1 and 5000. Defaults to 10.
string ("asc" | "desc")
Order of results by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
boolean
Whether or not the aggregates used to calculate the MACD are adjusted for splits. Defaults to True.
string
required
The size of the aggregate time window. Options: minute, hour, day, week, month, quarter, year. Required parameter.
string
required
Query by timestamp. Either a date with format YYYY-MM-DD or a millisecond timestamp. Required parameter.
integer
required
The long window size (number of periods) used to calculate MACD data. Traditional value: 26. Required parameter.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate MACD. Options: open, high, low, close. Defaults to ‘close’.
integer
required
The short window size (number of periods) used to calculate MACD data. Traditional value: 12. Required parameter.
integer
required
The window size (number of periods) used to calculate the MACD signal line. Traditional value: 9. Required parameter.
string
required
The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., ‘O:AAPL251219C00150000’). Must include the ‘O:’ prefix for options contracts.
boolean
Whether to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_OPTIONS_RSITool to calculate Relative Strength Index (RSI) technical indicator for an options ticker. Use when you need momentum analysis or want to identify overbought/oversold conditions for options contracts.

Input Parameters

integer
Limit the number of base aggregates queried to create the aggregate results. Default: 5000. Max: 50000.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘desc’.
integer
The window size used to calculate the Relative Strength Index (RSI). Typically 14 for standard RSI calculation. Defaults to 14.
boolean
Whether or not the aggregates used to calculate the RSI are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
The size of the aggregate time window. Required parameter to define the period for RSI calculation.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the RSI. Defaults to ‘close’.
string
Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
required
The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., ‘O:AAPL250117C00250000’). Must include the ‘O:’ prefix for options contracts.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_OPTIONS_SMATool to calculate Simple Moving Average (SMA) technical indicator for an options ticker. Use when you need trend analysis or smoothed price data for options contracts.

Input Parameters

integer
Limit the number of results returned. Must be between 1 and 5000. Defaults to 10.
string ("asc" | "desc")
The order in which to return the results, ordered by timestamp. ‘asc’ returns oldest first, ‘desc’ returns newest first. Defaults to ‘asc’.
string
Cursor value for pagination to fetch the next page of data.
integer
required
The window size used to calculate the simple moving average (SMA). For example, a window of 10 with daily aggregates results in a 10-day moving average. Required parameter.
boolean
Whether or not the aggregates used to calculate the SMA are adjusted for splits. Defaults to True.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
The size of the aggregate time window. Required parameter to define the period for SMA calculation.
string
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
string ("open" | "high" | "low" | "close")
The price in the aggregate which will be used to calculate the SMA. Defaults to ‘close’.
string
Filter for timestamps greater than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps greater than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
Filter for timestamps less than or equal to the specified value. Format: YYYY-MM-DD or millisecond timestamp.
string
required
The options ticker symbol in format O:UNDERLYINGYYMMDDCOOOOOOOOO (e.g., ‘O:SPY241220C00580000’). Must include the ‘O:’ prefix for options contracts.
boolean
Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to 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: POLYGON_IO_GET_RSITool to retrieve the Relative Strength Index (RSI) for a stock ticker. Use after confirming ticker symbol and timespan to analyze momentum over a period.

Input Parameters

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: POLYGON_IO_GET_SMATool to retrieve the Simple Moving Average (SMA) for any ticker (stocks, forex, crypto). Use when you need SMA values over a specified timespan with optional underlying data.

Input Parameters

integer
Maximum number of results to return (1-1000). Defaults to 250.
string ("asc" | "desc")
Sort order for results. Defaults to ‘desc’.
integer
required
Number of periods to calculate the SMA (must be ≥1).
boolean
Whether to adjust results for splits/dividends. Defaults to True.
string
required
The timespan for each period (e.g., ‘minute’, ‘hour’, ‘day’).
string
required
The ticker symbol. Use ‘C:EURUSD’ for forex, ‘AAPL’ for stocks, ‘X:BTCUSD’ for crypto.
integer
Millisecond UNIX timestamp to anchor the indicator. Defaults to most recent.
string ("open" | "high" | "low" | "close")
Price series to use. Defaults to ‘close’.
boolean
Include underlying aggregate data. Defaults to 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: POLYGON_IO_GET_SPLITSRetrieve historical stock split events, optionally filtered by ticker, including split ratios and execution dates.

Input Parameters

string
Field to sort by; only ‘execution_date’ is supported.
integer
Limit number of results (1-1000).
string ("asc" | "desc")
Sort order direction: ‘asc’ or ‘desc’.
string
Pagination cursor to fetch next page of results. Pass a previous ‘cursor’ value.
string
Case-sensitive ticker symbol, e.g., ‘AAPL’.
boolean
Query for reverse stock splits. A split ratio where split_from is greater than split_to represents a reverse split.
string
Filter by execution date (YYYY-MM-DD).

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: POLYGON_IO_GET_STOCKS_CUSTOM_BARSTool to retrieve aggregated historical OHLC and volume data for a stock over custom date ranges with configurable time windows. Use when you need aggregate bars for stock price analysis, backtesting, or charting.

Input Parameters

string ("asc" | "desc")
Sort results by timestamp. ‘asc’ for ascending (oldest first), ‘desc’ for descending (newest first).
integer
Limits the number of base aggregates queried. Maximum: 50000, Default: 5000.
string
required
The end of the aggregate time window. Can be in YYYY-MM-DD format or Unix millisecond timestamp.
boolean
Whether results are adjusted for splits. Set to false to get results that are NOT adjusted for splits. Defaults to true.
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
The size of the time window for each aggregate bar.
string
required
The start of the aggregate time window. Can be in YYYY-MM-DD format or Unix millisecond timestamp.
integer
required
The size of the timespan multiplier. Must be a positive integer. Used to customize the time window size.
string
required
The ticker symbol of the stock/equity (e.g., ‘AAPL’, ‘TSLA’, ‘MSFT’). Must be a valid stock ticker.

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: POLYGON_IO_GET_STOCKS_DAILY_MARKET_SUMMARYRetrieve grouped daily OHLC, volume, and available VWAP data for US stocks on a specified trading date. OTC securities can be included optionally.

Input Parameters

string
required
The date to get aggregate bars for in YYYY-MM-DD format (e.g., ‘2024-12-13’)
boolean
Whether results are adjusted for splits. Set to false for unadjusted results. Defaults to true.
boolean
Include OTC (Over-The-Counter) securities in response. Defaults to 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: POLYGON_IO_GET_STOCKS_FILINGS_RISK_FACTORSTool to retrieve risk factors identified in companies’ 10K filings. Use when analyzing company risks, regulatory disclosures, or compliance requirements.

Input Parameters

string
SEC Central Index Key (10 digits, zero-padded).
string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. The sort column defaults to ‘filing_date’ if not specified. The sort order defaults to ‘desc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to ‘100’ if not specified. The maximum allowed limit is ‘49999’.
string
Filter greater than the value.
string
Filter less than the value.
string
Stock ticker symbol for the company.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD).
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated 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: POLYGON_IO_GET_STOCKS_FILINGS_SECTIONSRetrieve raw text from sections of 10-K SEC filings, such as business descriptions and risk factors.

Input Parameters

string
SEC Central Index Key (10 digits, zero-padded). Filter by exact CIK value.
string
Comma-separated list of sort columns. Append ‘.asc’ or ‘.desc’ to specify direction. Defaults to ‘period_end.desc’.
integer
Limit the maximum number of results returned. Defaults to 100. Maximum allowed is 9999.
string
Filter CIK greater than the specified value.
string
Filter CIK less than the specified value.
string
Stock ticker symbol for the company. Filter by exact ticker value.
string
Filter CIK greater than or equal to the specified value.
string
Filter CIK less than or equal to the specified value.
string ("business" | "risk_factors")
Standardized section identifiers from SEC filings.
string
Filter ticker greater than the specified value (alphabetically).
string
Filter ticker less than the specified value (alphabetically).
string
Filter CIK equal to any of the values. Comma-separated list of CIK values.
string
Period end date that the filing relates to (YYYY-MM-DD format). Filter by exact period end date.
string
Filter ticker greater than or equal to the specified value (alphabetically).
string
Filter ticker less than or equal to the specified value (alphabetically).
string
Date when the filing was submitted to the SEC (YYYY-MM-DD format). Filter by exact filing date.
string
Filter period end date greater than the specified value (YYYY-MM-DD format).
string
Filter period end date less than the specified value (YYYY-MM-DD format).
string
Filter ticker equal to any of the values. Comma-separated list of ticker symbols.
string
Filter filing date greater than the specified value (YYYY-MM-DD format).
string
Filter filing date less than the specified value (YYYY-MM-DD format).
string
Filter period end date greater than or equal to the specified value (YYYY-MM-DD format).
string
Filter period end date less than or equal to the specified value (YYYY-MM-DD format).
string
Filter section equal to any of the values. Comma-separated list of section identifiers.
string
Filter filing date greater than or equal to the specified value (YYYY-MM-DD format).
string
Filter filing date less than or equal to the specified value (YYYY-MM-DD 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: POLYGON_IO_GET_STOCKS_FREE_FLOATTool to retrieve free float data for US-listed securities showing the most recent available number of shares available for public trading and the percentage of total shares outstanding. Use when analyzing stock liquidity, ownership structure, or available trading shares.

Input Parameters

string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. The sort column defaults to ‘ticker’ if not specified. The sort order defaults to ‘asc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to 100 if not specified. The maximum allowed limit is 5000.
string
The primary ticker symbol for the stock. Filter for an exact match.
string
Filter for tickers greater than the specified value.
string
Filter for tickers less than the specified value.
string
Filter for tickers greater than or equal to the specified value.
string
Filter for tickers less than or equal to the specified value.
string
Filter equal to any of the ticker values. Multiple values can be specified by using a comma separated list.
number
Percentage of total shares outstanding that are available for public trading, rounded to two decimal places. Filter for an exact match.
number
Filter for free float percentage greater than the specified value.
number
Filter for free float percentage less than the specified value.
number
Filter for free float percentage greater than or equal to the specified value.
number
Filter for free float percentage less than or equal to the specified value.

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: POLYGON_IO_GET_STOCKS_FULL_MARKET_SNAPSHOTTool to retrieve a comprehensive snapshot of the entire U.S. stock market covering 10,000+ actively traded tickers. Use when you need current market-wide data including pricing, volume, and trade activity. Data is cleared daily at 3:30 AM EST and repopulates as exchanges report new data starting around 4:00 AM EST.

Input Parameters

string
A case-sensitive comma separated list of tickers to get snapshots for (e.g., AAPL,TSLA,GOOG). If not specified, returns all tickers.
boolean
Include OTC securities in the response. Defaults to 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: POLYGON_IO_GET_STOCKS_INCOME_STATEMENTSTool to retrieve comprehensive income statement data including revenue, expenses, and net income from company SEC filings. Use when analyzing profitability, revenue trends, or operational performance.

Input Parameters

string
The company’s Central Index Key (CIK), a unique identifier assigned by the SEC
string
Query by Standard Industrial Classification (SIC) code
string
The sort field used for ordering. Default: ‘filing_date’
integer
Limit the number of results returned (1-100). Default: 10
string ("asc" | "desc")
Order results based on the sort field. Default: ‘asc’
string
Query by company ticker symbol, e.g., ‘AAPL’
string ("quarterly" | "annual" | "ttm")
The timeframe of the report. Annual financials originate from 10-K filings, quarterly from 10-Q filings, TTM is trailing twelve months
string
Query by the date when the filing was filed (YYYY-MM-DD format)
string
Query by exact company name
string
Filing date greater than (YYYY-MM-DD)
string
Filing date less than (YYYY-MM-DD)
string
Filing date greater than or equal (YYYY-MM-DD)
string
Filing date less than or equal (YYYY-MM-DD)
boolean
Whether to include the xpath and formula attributes for each financial data point for traceability
Search by partial company name
string
The period of report for the filing (YYYY-MM-DD format)
string
Period of report date greater than (YYYY-MM-DD)
string
Period of report date less than (YYYY-MM-DD)
string
Period of report date greater than or equal (YYYY-MM-DD)
string
Period of report date less than or equal (YYYY-MM-DD)

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: POLYGON_IO_GET_STOCKS_PREVIOUS_DAY_BARTool to retrieve the previous trading day’s open, high, low, close (OHLC), and volume data for a stock ticker. Use when you need the most recent completed trading day’s aggregate data.

Input Parameters

boolean
Whether or not the results are adjusted for splits. By default, results are adjusted (true). Set this to false to get results that are NOT adjusted for splits.
string
required
The ticker symbol of the stock (e.g., ‘AAPL’, ‘TSLA’, ‘MSFT’). Must be case-sensitive and valid.

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: POLYGON_IO_GET_STOCKS_RISK_FACTOR_TAXONOMIESRetrieve risk factor classifications used in the risk factors endpoint, with optional taxonomy and category filters. Results are returned one page at a time.

Input Parameters

string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. The sort column defaults to ‘taxonomy’ if not specified. The sort order defaults to ‘desc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to 200 if not specified. The maximum allowed limit is 999.
number
Version identifier (e.g., 1.0, 1.1) for the taxonomy. Value must be a floating point number.
number
Filter greater than the value. Value must be a floating point number.
number
Filter less than the value. Value must be a floating point number.
number
Filter greater than or equal to the value. Value must be a floating point number.
number
Filter less than or equal to the value. Value must be a floating point number.
string
Top-level risk category.
string
Most specific risk classification.
string
Mid-level risk category.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated 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: POLYGON_IO_GET_STOCKS_V1_DIVIDENDSTool to retrieve historical dividend payment records for US stocks with split-adjusted amounts and historical adjustment factors. Use when analyzing dividend history with price normalization data.

Input Parameters

string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. The sort column defaults to ‘ticker’ if not specified. The sort order defaults to ‘asc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to ‘100’ if not specified. The maximum allowed limit is ‘5000’.
string
Stock symbol for the company issuing the dividend, e.g., ‘AAPL’.
integer
How many times per year this dividend is expected to occur. A value of 0 means the distribution is non-recurring or irregular (e.g., special, supplemental, or a one-off dividend). Other possible values include 1 (annual), 2 (semi-annual), 3 (trimester), 4 (quarterly), 12 (monthly), 24 (bi-monthly), 52 (weekly), 104 (bi-weekly), and 365 (daily) depending on the issuer’s declared or inferred payout cadence.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
integer
Filter greater than the value.
integer
Filter less than the value.
integer
Filter greater than or equal to the value.
integer
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Date when the stock begins trading without the dividend value. Value must be formatted ‘yyyy-mm-dd’.
string ("recurring" | "special" | "supplemental" | "irregular" | "unknown")
Classification describing the nature of dividend’s recurrence pattern.
string
Filter greater than the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter less than the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter greater than or equal to the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter less than or equal to the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list (e.g., ‘recurring,special’).

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: POLYGON_IO_GET_STOCKS_V1_SHORT_INTERESTTool to retrieve comprehensive FINRA short interest data that tracks the short selling metrics for securities on a specific settlement date. Use when analyzing short positions, days to cover, and average daily volume for stocks.

Input Parameters

string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. The sort column defaults to ‘ticker’ if not specified. The sort order defaults to ‘asc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to 10 if not specified. The maximum allowed limit is 50000.
string
The primary ticker symbol for the stock.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
number
Calculated as short_interest divided by avg_daily_volume, representing the estimated number of days it would take to cover all short positions based on average trading volume.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules.
integer
The average daily trading volume for the stock over a specified period, typically used to contextualize short interest.
number
Filter greater than the value.
number
Filter less than the value.
number
Filter greater than or equal to the value.
number
Filter less than or equal to the value.
string
Filter greater than the value.
string
Filter less than the value.
integer
Filter greater than the value.
integer
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
integer
Filter greater than or equal to the value.
integer
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated 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: POLYGON_IO_GET_STOCKS_V1_SHORT_VOLUMETool to retrieve short selling volume data for stock tickers. Use when analyzing short sale activity including total trading volume, short sale details, and breakdown by different trading platforms.

Input Parameters

string
The date of trade activity reported in the format YYYY-MM-DD
string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. Defaults to ‘ticker.asc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to 10 if not specified. The maximum allowed limit is 50000.
string
The primary ticker symbol for the stock.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
integer
Total reported volume across all venues for the ticker on the given date.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
integer
Filter greater than the value.
integer
Filter less than the value.
integer
Filter greater than or equal to the value.
integer
Filter less than or equal to the value.
number
The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
number
Filter greater than the value.
number
Filter less than the value.
number
Filter greater than or equal to the value.
number
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated 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: POLYGON_IO_GET_STOCKS_V1_SPLITSTool to retrieve historical stock split and reverse split events for US equities with historical adjustment factors for price normalization. Use when analyzing stock split history including forward splits, reverse splits, and stock dividends.

Input Parameters

string
A comma separated list of sort columns. For each column, append ‘.asc’ or ‘.desc’ to specify the sort direction. The sort column defaults to ‘execution_date’ if not specified. The sort order defaults to ‘desc’ if not specified.
integer
Limit the maximum number of results returned. Defaults to 100 if not specified. The maximum allowed limit is 5000.
string
Stock symbol for the company that executed the split. Case-sensitive ticker symbol (e.g., ‘AAPL’).
string
Filter greater than the value.
string
Filter less than the value.
string
Filter greater than or equal to the value.
string
Filter less than or equal to the value.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list.
string
Date when the stock split was applied and shares adjusted. Value must be formatted ‘yyyy-mm-dd’.
string ("forward_split" | "reverse_split" | "stock_dividend")
Classification of the share-change event.
string
Filter greater than the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter less than the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter greater than or equal to the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter less than or equal to the value. Value must be formatted ‘yyyy-mm-dd’.
string
Filter equal to any of the values. Multiple values can be specified by using a comma separated list. Valid values: forward_split, reverse_split, stock_dividend.

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: POLYGON_IO_GET_TICKER_EVENTSTool to retrieve timeline of ticker change events such as symbol renaming or rebranding. Use when tracking ticker history to maintain continuity in records and analyses. This is an experimental endpoint.

Input Parameters

string
required
Identifier of an asset, which can be a Ticker, CUSIP, or Composite FIGI. Specify a case-sensitive ticker symbol (e.g., ‘AAPL’ for Apple Inc, ‘META’ for Meta). When provided a ticker, events for the entity currently represented by that ticker are returned.
string
A comma-separated list of the types of event to include. Currently ‘ticker_change’ is the only supported event type. Leave blank to return all supported event types.

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: POLYGON_IO_GET_TICKER_OVERVIEWTool to retrieve comprehensive details for a single ticker, including identifiers, industry, and branding assets. Use after confirming the exact ticker symbol.

Input Parameters

string
required
Ticker symbol to look up, e.g., ‘AAPL’. Must be uppercase alphanumeric.

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: POLYGON_IO_GET_TICKER_TYPESTool to retrieve a list of all ticker types supported by Polygon.io. Use when you need to enumerate valid ticker types for filtering or validation.

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: POLYGON_IO_GET_TREASURY_YIELDSTool to retrieve daily market yields for US Treasury securities across standard maturities (1-month to 30-year). Use when analyzing interest rate trends, yield curve analysis, or economic indicators.

Input Parameters

string
Specific observation date in YYYY-MM-DD format. If not provided, returns recent observations.
string
Sort by columns with .asc/.desc direction. Example: ‘date.asc’ or ‘date.desc’.
integer
Maximum number of results to return. Defaults to 100, maximum is 50,000.
string
Filter dates greater than value (YYYY-MM-DD).
string
Filter dates less than value (YYYY-MM-DD).
string
Filter dates greater than or equal to value (YYYY-MM-DD).
string
Filter dates less than or equal to value (YYYY-MM-DD).
string
Match any values in comma-separated list of dates (YYYY-MM-DD).

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: POLYGON_IO_LIST_EXCHANGESTool to retrieve all exchanges supported by Polygon.io with details about asset class and locale. Use when you need to list available exchanges for filtering market data or understanding trading venues.

Input Parameters

string ("us" | "global")
Enum for locale filter options.
string ("stocks" | "options" | "crypto" | "fx" | "futures")
Enum for asset class filter options.

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: POLYGON_IO_LIST_FILING_FILESRetrieve a page of files associated with an SEC filing by filing ID, including documents, exhibits, and data files. The response may include a next-page URL.

Input Parameters

string ("sequence" | "filename")
Sort field used for ordering: ‘sequence’ or ‘filename’. Defaults to ‘sequence’.
integer
Limit the number of results returned (1-1000). Defaults to 10.
string ("asc" | "desc")
Order results based on the sort field: ‘asc’ (ascending) or ‘desc’ (descending).
string
Query by exact file name.
integer
Query by exact file sequence number.
string
required
The filing ID to retrieve files for (e.g., ‘0001300514-21-000058’). This is required.
string
Filter for filenames strictly greater than this value (lexicographical).
string
Filter for filenames strictly less than this value (lexicographical).
integer
Filter for sequence numbers strictly greater than this value.
integer
Filter for sequence numbers strictly less than this value.
string
Filter for filenames greater than or equal to this value (lexicographical).
string
Filter for filenames less than or equal to this value (lexicographical).
integer
Filter for sequence numbers greater than or equal to this value.
integer
Filter for sequence numbers less than or equal to this value.

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: POLYGON_IO_LIST_FILINGSRetrieve SEC filings from Polygon.io reference data, with filters for date, company, and 10-K or 10-Q filing type.

Input Parameters

string ("filing_date" | "period_of_report_date")
Enum for sort field.
string ("10-K" | "10-Q")
Enum for SEC filing types.
integer
Limit the number of results returned, default is 10 and max is 1000
string ("asc" | "desc")
Enum for sort order.
boolean
Filter by XBRL availability: true for filings with XBRL instance file, false for filings without XBRL, omit to include both
string
Query by exact filing date in YYYYMMDD format
string
Filter for filing dates greater than this date in YYYYMMDD format
string
Filter for filing dates less than this date in YYYYMMDD format
string
Filter for filing dates greater than or equal to this date in YYYYMMDD format
string
Filter for filing dates less than or equal to this date in YYYYMMDD format
string
Query by period of report date in YYYYMMDD format
string
Filter for period of report dates greater than this date in YYYYMMDD format
string
Filter for period of report dates less than this date in YYYYMMDD format
string
Filter by entity company CIK (Central Index Key)
string
Filter by entity company SIC (Standard Industrial Classification) code
string
Filter for period of report dates greater than or equal to this date in YYYYMMDD format
string
Filter for period of report dates less than or equal to this date in YYYYMMDD format
string
Filter by entity company name
string
Filter by entity company ticker symbol
Search for company names containing this text (case-insensitive partial match)

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: POLYGON_IO_LIST_OPTIONS_CONTRACTSTool to list and filter options contracts by underlying ticker, type, expiration, strike, and more. Use when you need to enumerate an options chain or find specific contracts matching criteria.

Input Parameters

string
Field name to sort by (e.g., ‘expiration_date’, ‘strike_price’, ‘ticker’).
string
Specify a point in time for contracts as of this date (YYYY-MM-DD). Defaults to today.
integer
Maximum number of results to return per page (1-1000). Defaults to 10.
string ("asc" | "desc")
Sort order direction: ‘asc’ (ascending) or ‘desc’ (descending).
boolean
Query expired contracts. Set to true to include expired contracts.
number
Filter by exact strike price value.
string ("call" | "put")
Filter by contract type: ‘call’ or ‘put’.
string
Filter by exact expiration date in YYYY-MM-DD format.
number
Filter for strike prices strictly greater than this value.
number
Filter for strike prices strictly less than this value.
number
Filter for strike prices greater than or equal to this value.
number
Filter for strike prices less than or equal to this value.
string
Query for contracts relating to an underlying stock ticker (e.g., ‘AAPL’, ‘SPY’).
string
Filter for expiration dates strictly greater than this date (YYYY-MM-DD).
string
Filter for expiration dates strictly less than this date (YYYY-MM-DD).
string
Filter for expiration dates greater than or equal to this date (YYYY-MM-DD).
string
Filter for expiration dates less than or equal to this date (YYYY-MM-DD).

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: POLYGON_IO_POLYGON_LAST_QUOTE_FOR_A_SYMBOLTool to retrieve the last quote tick for a given stock symbol. Use when you need the most recent bid/ask prices, sizes, and exchange information for a stock.

Input Parameters

string
required
Symbol of the stock to get the last quote for (e.g., AAPL, MSFT). Must be uppercase.

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: POLYGON_IO_POLYGON_LAST_TRADE_FOR_A_CURRENCY_PAIRRetrieve the last forex quote for a currency pair, including available bid and ask prices, exchange, and timestamp.

Input Parameters

string
required
The ‘to’ currency symbol (quote currency) in the pair (e.g., ‘USD’, ‘JPY’, ‘EUR’).
string
required
The ‘from’ currency symbol (base currency) in the pair (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