Skip to main content
Polygon logo
  • Category: market data
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 90
  • Triggers: 0
  • Slug: POLYGON
  • Version: 20261101_00

Tools

Slug: POLYGON_GET10_K_SECTIONSTool to retrieve 10-K filing sections from the SEC. Use when you need to access specific sections of 10-K filings such as business descriptions, risk factors, or financial statements.

Input Parameters

string
Central Index Key (CIK) number. Supports comparison operators: .any_of, .gt, .gte, .lt, .lte
string
Comma-separated columns with .asc or .desc direction
integer
Maximum number of results. Default: 100, Max: 9999
string
Stock ticker symbol. Supports comparison operators: .any_of, .gt, .gte, .lt, .lte
string
Standardized section identifier from the filing (e.g., ‘business’, ‘risk_factors’)
string
Period end date filter in YYYY-MM-DD format. Supports comparison operators: .gte, .gt, .lte, .lt
string
Filing date filter in YYYY-MM-DD format. Supports comparison operators: .gte, .gt, .lte, .lt

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_GET_AGGREGATESTool to fetch custom aggregate OHLCV bars for a stock. Use when you need historical price and volume data aggregated by custom intervals over a date range.

Input Parameters

string
required
End of window; YYYY-MM-DD or millisecond timestamp
string ("asc" | "desc")
Sort by timestamp; ‘asc’ oldest-first, ‘desc’ newest-first
string
required
Start of window; YYYY-MM-DD or millisecond timestamp
integer
Number of aggregates to return; default 5000, max 50000
string
required
Case-sensitive stock ticker (e.g., ‘AAPL’)
boolean
Adjust for splits; default true
string ("minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
Size of the time window
integer
required
Size of the timespan multiplier

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_GET_ALL_TICKERSRetrieve ticker symbols across asset classes, with market, exchange, ticker and search filters and pagination. Requests default to active tickers; result sets can be large, so narrow queries when appropriate.

Input Parameters

string
Field to sort by (e.g., ticker, name, market).
integer
Number of results per page (1-1000).
string ("asc" | "desc")
Sort order of results.
boolean
If true, only active tickers are returned.
string
Pagination cursor from prior response to fetch next page.
string
Filter by market type (e.g., stocks, crypto, fx, otc).
Search substring in company or ticker names.
string
Exact ticker symbol to search for (e.g., AAPL).
string
Filter by exchange symbol (e.g., XNAS, XNYS).

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_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 a specific integer condition code ID.
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_GET_CRYPTO_AGGREGATESTool to retrieve aggregate bars for a cryptocurrency over a time range. Use when you need to fetch historical bars aggregated by specific time intervals.

Input Parameters

string ("asc" | "desc")
Order by timestamp: ‘asc’ (oldest first) or ‘desc’ (newest first).
integer
Maximum number of base aggregates to fetch (default: 5000, max: 50000).
string
required
End of the aggregate window; ‘YYYY-MM-DD’ or millisecond timestamp.
boolean
Whether results are adjusted for splits (default: true).
string ("second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
Time window unit for aggregation.
string
required
Start of the aggregate window; ‘YYYY-MM-DD’ or millisecond timestamp.
integer
required
Size of the timespan multiplier (integer >= 1).
string
required
Ticker symbol of the cryptocurrency pair, e.g., ‘BTC-USD’.

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_GET_CRYPTO_ALL_TICKERSRetrieve cryptocurrency market snapshots for all tickers or a selected list of case-sensitive ticker symbols. Results may include only previous-day aggregate data.

Input Parameters

array
Case-sensitive list of crypto tickers (e.g., [‘X:BTCUSD’,‘X:ETHBTC’]). If omitted or empty, returns snapshots for all tickers. Omitting returns all tickers and may produce a very large response; filter with specific tickers when possible.

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_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_GET_CRYPTO_GROUPED_DAILYTool to retrieve daily grouped bars for all cryptocurrencies on a specified date. Use when you need a comprehensive end-of-day summary across all crypto tickers.

Input Parameters

string
required
Date for which to retrieve daily grouped crypto bars in YYYY-MM-DD format
boolean
Whether results are adjusted for splits; default is 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_GET_CRYPTO_LAST_TRADERetrieve the latest trade information for a cryptocurrency pair specified by its base and quote symbols. The result may instead reflect the previous aggregate close rather than an actual last trade.

Input Parameters

string
required
Quote (‘to’) asset symbol of the crypto pair, e.g., ‘USD’
string
required
Base (‘from’) asset symbol of the crypto pair, e.g., ‘BTC’

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_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_GET_CRYPTO_OPEN_CLOSETool to fetch daily open and close prices for a given crypto pair on a specified date. Use after specifying both currency symbols and the date.

Input Parameters

string
required
Ticker symbol of the base currency (e.g., ‘BTC’)
string
required
Date for which to retrieve open/close prices, in YYYY-MM-DD format
string
required
Ticker symbol of the quote currency (e.g., ‘USD’)

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_GET_CRYPTO_PREV_CLOSETool to retrieve previous day’s close for a crypto ticker. Use when you need the last closing price of a cryptocurrency before analysis or trading.

Input Parameters

boolean
Whether to return adjusted data
string
required
Cryptocurrency ticker symbol to query, e.g., ‘X:BTCUSD’

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_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_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_GET_CRYPTO_TICKER_BOOKRequest a cryptocurrency ticker’s order-book snapshot from the legacy book endpoint. This tool is deprecated.

Input Parameters

string
required
Cryptocurrency ticker symbol. REST format is ‘X:BASEQUOTE’ (e.g., ‘X:BTCUSD’). Common user format ‘BTC-USD’ is accepted and normalized.

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_GET_CRYPTO_TRADESTool to fetch historical trade data for a cryptocurrency ticker. Use when you need tick-level trades within a time range.

Input Parameters

string
Field to sort by; must be ‘timestamp’
integer
Maximum number of trades to return (default: 1000, max: 50000)
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’
string
Filter by trade timestamp (YYYY-MM-DD or nanosecond Unix timestamp)
string
Return trades with timestamp greater than this value
string
Return trades with timestamp less than this value
string
required
Case-sensitive cryptocurrency ticker (e.g., ‘BTC-USD’)
string
Return trades with timestamp greater than or equal to this value
string
Return trades with timestamp 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_GET_DIVIDENDSTool to retrieve dividend data for stocks. Use when you need corporate dividend information for specific tickers.

Input Parameters

string ("ticker" | "ex_dividend_date" | "pay_date" | "declaration_date" | "record_date" | "cash_amount")
Provider-supported field to sort by.
integer
Limit number of results (1-1000)
string ("asc" | "desc")
Sort order (ascending or descending)
string
Filter by ticker symbol
string
Filter by payment date (YYYY-MM-DD)
integer ("0" | "1" | "2" | "4" | "12" | "24" | "52")
Expected dividend payments per year, e.g. 1, 2, 4, or 12.
number
Filter by cash amount
string
Filter by record date (YYYY-MM-DD)
string ("CD" | "SC" | "LT" | "ST")
Filter by dividend type code
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_GET_ECONOMY_INFLATIONTool to retrieve key indicators of realized inflation including CPI and PCE price indexes. Use when analyzing inflation trends, economic conditions, or historical price changes in the U.S. economy.

Input Parameters

string
Calendar date of the observation 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
Limit the maximum number of results returned. Defaults to 100.

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_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_GET_FILINGTool to retrieve SEC filing details by filing ID. Use when you need detailed information about a specific SEC filing.

Input Parameters

string
required
The filing ID to retrieve

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_GET_FILING_FILETool to download a specific raw SEC filing file, such as HTML, XML, XBRL, or text.

Input Parameters

string
required
The specific file identifier within the filing (e.g., ‘lvs-20210331_htm.xml’). This identifies which file within the filing to retrieve.
string
required
The SEC filing identifier (e.g., ‘0001300514-21-000058’). This is the unique identifier for the filing document.

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_GET_FOREX_AGGREGATESTool to retrieve aggregate bars for a forex pair over a date range. Use when you need custom OHLC bars for forex currency pairs within specified time span.

Input Parameters

string
required
End of the aggregate window as YYYY-MM-DD or millisecond timestamp.
string ("asc" | "desc")
Sort order by timestamp: ‘asc’ or ‘desc’.
string
required
Start of the aggregate window as YYYY-MM-DD or millisecond timestamp.
integer
Max number of base aggregates to query; default is 5000.
boolean
Whether results are adjusted for splits; default is true.
string ("second" | "minute" | "hour" | "day" | "week" | "month" | "quarter" | "year")
required
Size of the time window for each aggregate bar.
integer
required
Size of the timespan multiplier, must be >= 1.
string
required
Ticker symbol of the currency pair, e.g., ‘EURUSD’.

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_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_GET_FOREX_GROUPED_DAILYTool to retrieve daily grouped OHLC bars for all forex currency pairs on a specified date. Use when you need aggregated forex data after confirming the date parameter.

Input Parameters

string
required
Date for which to retrieve daily aggregated forex bars in YYYY-MM-DD format
boolean
Whether to retrieve adjusted data (default: 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_GET_FOREX_HISTORICAL_QUOTESTool to retrieve historical forex quotes for a currency pair over a time range. Use when you need bid/ask quotes for an FX ticker between timestamps or dates. Use after confirming the forex ticker symbol.

Input Parameters

string
Field to sort by. Must be ‘timestamp’.
integer
Max number of results (default 1000, max 50000).
string ("asc" | "desc")
Order of results by the sort field (asc or desc).
string
required
The forex currency pair ticker to retrieve quotes for (e.g., ‘EURUSD’).
string
Filter by date (YYYY-MM-DD) or nanosecond timestamp.
string
Return quotes with timestamp greater than this value.
string
Return quotes with timestamp less than this value.
string
Return quotes with timestamp greater than or equal to this value.
string
Return quotes with timestamp 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_GET_FOREX_LOCALESList available Polygon locale codes and names.

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_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_GET_FOREX_PREV_CLOSETool to retrieve previous day’s close for a forex ticker. Use when you need the last closing price of a forex currency pair before analysis or trading.

Input Parameters

boolean
Whether to return adjusted data
string
required
Forex currency pair ticker symbol to query, e.g., ‘EURUSD’

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_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_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_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_GET_FOREX_SNAPSHOT_LOSERSTool to retrieve the current snapshot of the top losers in the forex market. Use when you need up-to-date information on the worst-performing forex pairs.

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_GET_FUTURES_AGGREGATESTool to retrieve historical OHLCV aggregates for a futures contract. Use when you need aggregated price and volume data for a futures contract over specified time windows.

Input Parameters

string
Field and direction for sorting, e.g., ‘window_start.asc’, ‘ticker.desc’
integer
Number of aggregates to return; default 1000, min 1, max 50000
string
required
Futures contract identifier, e.g., ‘GCJ5’
string
Aggregate window size, e.g., ‘15min’, ‘30sec’, ‘12hour’, ‘7day’
string
Exact candle start as a date or nanosecond timestamp.
string
Return candles after this start.
string
Return candles before this start.
string
Start edge of windows (inclusive), as a date or nanosecond timestamp.
string
End edge of windows (inclusive), as a date or nanosecond timestamp.

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_GET_FUTURES_PRODUCTSTool to retrieve a comprehensive list of futures products with advanced filtering. Use when you need to filter futures listings by date, sector, exchange, or type.

Input Parameters

string
Point-in-time date in YYYY-MM-DD format (default: today)
string
Exact product name match, case-sensitive search
string
Sort specifier in the form ‘field.direction’, e.g., ‘ticker.asc’
string ("single" | "combo")
Filter by product type; omit to return single and combo products.
integer
Number of results per page (1-50000); provider default 100.
string
Product sector classification
string
Product sub-sector classification
string
Top-level asset class
string
Exact futures product code.
string
Exchange MIC code to filter results
string
Asset sub-class classification

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_GET_FUTURES_PRODUCT_SCHEDULESTool to retrieve trading schedules for a futures product. Use when you need daily trading session schedules for a given product code.

Input Parameters

string
Sort by field and direction, e.g., ‘ticker.asc’ or ‘name.desc’.
integer
Results per page (1-1000). Defaults to 100.
string
required
Futures product code (e.g., ‘ES’).
string
Trading day that the schedule ended (YYYY-MM-DD, Central Time).

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_GET_FUTURES_QUOTESTool to retrieve real-time quote data for a specified futures contract ticker. Use after confirming the exact futures ticker identifier (e.g., ‘GCJ5’).

Input Parameters

string
Sort by field and direction using dotted notation (e.g., ‘ticker.asc’, ‘name.desc’)
integer
Results per page; default is 100; min 1; max 50000
string
required
Futures contract identifier including base symbol and expiration (e.g., ‘GCJ5’)
string
Filter by trade timestamp; either 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
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_GET_FUTURES_SCHEDULESTool to retrieve futures trading schedules. Use when you need trading schedules for all futures contracts on a specific date.

Input Parameters

string
Sort by field.direction, e.g., ‘product_code.asc’ or ‘product_name.desc’
integer
Number of results per page (1-1000). Default is 100.
string
Filter by futures product code.
string
Exchange MIC to filter schedules, e.g., ‘CME’
string
Trading date to query (YYYY-MM-DD, CT). Omit to return all available dates.

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_GET_FUTURES_TRADESTool to retrieve tick-level trade data for a specified futures contract. Use when you need detailed trade data over a time range.

Input Parameters

string
Sort field and direction in ‘field.direction’ format, e.g., ‘timestamp.asc’.
integer
Maximum number of trades to return; provider default 10, max 50000.
string
required
Futures contract identifier including base symbol and expiration (e.g., ‘GCJ5’)
string
Filter by timestamp; YYYY-MM-DD or Unix nanosecond timestamp.
string
Return trades with timestamp greater than this value.
string
Return trades with timestamp less than this value.
string
Return trades with timestamp greater than or equal to this value.
string
Return trades with timestamp less than or equal to this value.
string
Trading date filter in 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_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_GET_INFLATION_EXPECTATIONSTool to retrieve inflation expectations data from the Federal Reserve based on Treasury yields and Cleveland Fed models. Use when analyzing expected future inflation rates across multiple time horizons (1-year, 5-year, 10-year, 30-year).

Input Parameters

string
Calendar date in YYYY-MM-DD format for a specific observation
string
Sort order for results. Use ‘date.asc’ for ascending or ‘date.desc’ for descending
integer
Maximum number of results to return. Defaults to 100, max 50,000
string
Date comparison filter - observations after this date (YYYY-MM-DD format)
string
Date comparison filter - observations before this date (YYYY-MM-DD format)
string
Date comparison filter - observations on or after this date (YYYY-MM-DD format)
string
Date comparison filter - observations on or before this date (YYYY-MM-DD format)
string
Date comparison filter - any of the specified dates (comma-separated)

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_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_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_GET_MARKET_HOLIDAYSTool to retrieve upcoming market holidays and half-day closures. Use when you need to look up upcoming exchange holidays and early closures.

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_GET_MARKET_STATUSRetrieve the current market status, including whether U.S. exchanges are open or closed and whether trading is in early or after-hours sessions.

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_GET_META_CONDITIONS_BY_TICKTYPETool to retrieve condition code mappings for a specific tick type (trades or quotes). Use when you need to decode numeric condition codes into human-readable labels for market data interpretation.

Input Parameters

string ("trades" | "quotes")
required
The type of ticks to return mappings for. Must be either ‘trades’ or ‘quotes’.

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_GET_NEWSTool to retrieve recent news articles related to a ticker. Use when you need to fetch financial news after identifying a ticker symbol.

Input Parameters

string
Field to sort by (only ‘published_utc’ supported)
integer
Number of results to return (1–100)
string ("asc" | "desc")
Sort order of results
string
Pagination token for the next page of results
string
Ticker symbol to filter news (e.g., ‘AAPL’)
string
Return articles published on or after this ISO 8601 timestamp
string
Return articles published on or before this ISO 8601 timestamp

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_GET_OPEN_CLOSETool to fetch daily open and close prices for a stock on a specific date. Use when you need daily OHLC with pre/post-market prices.

Input Parameters

string
required
Date for which to retrieve open/close prices, in YYYY-MM-DD format
boolean
Whether results are adjusted for splits. Set to false for unadjusted.
string
required
Ticker symbol of the stock (e.g., ‘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: POLYGON_GET_OPTION_CHAIN_SNAPSHOTFetch an option chain snapshot for an underlying ticker, with optional contract filters and sorting. Results are paginated and may include a next-page URL.

Input Parameters

string
Field to sort by
integer
Maximum number of results (default=10, max=250)
string ("asc" | "desc")
Sort direction for results
number
Filter by strike price; supports filter modifiers (>, <, etc.)
string ("call" | "put")
Option contract type
string
Filter by expiration date in YYYY-MM-DD format; supports modifiers
string
required
Underlying ticker symbol for the option chain snapshot (e.g., ‘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: POLYGON_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_GET_OPTIONS_CUSTOM_BARSTool to retrieve historical OHLC and volume data for options contracts over custom date ranges with configurable time windows. Use when you need aggregate bars for options price analysis or strategy development.

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 ("second" | "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 options contract (e.g., ‘O:AAPL251219C00250000’, ‘O:SPY241220P00720000’). Must follow standard options ticker 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_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_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_GET_OPTION_SNAPSHOTTool to retrieve a real-time snapshot for a single option contract. Use when you need up-to-the-minute quotes, trades, greeks, and metrics for a specified option contract.

Input Parameters

string
required
Option contract identifier (e.g., ‘AAPL210917C00145000’)
string
required
Underlying ticker symbol of the option contract (e.g., ‘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: POLYGON_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_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_GET_PREVIOUS_CLOSETool to get previous trading day’s OHLC and volume for a stock. Use when you need the last day’s open, high, low, close, and volume for a given ticker.

Input Parameters

string
required
Case-sensitive stock ticker symbol to query, e.g., ‘AAPL’
boolean
Whether to return adjusted data for splits; default is 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_GET_REFERENCE_EXCHANGESTool to retrieve supported exchanges and their details. Use when you need a list of exchanges filtered by asset class or locale.

Input Parameters

string
Filter by locale (e.g., ‘us’).
string ("stocks" | "options" | "crypto" | "fx")
Filter by asset class. One of ‘stocks’, ‘options’, ‘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_GET_REFERENCE_MARKETSTool to retrieve all supported markets from Polygon.io. Use when you need a list of available market 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_GET_REFERENCE_TYPESTool to retrieve all ticker types supported by Polygon. Use when you need to understand the different ticker classifications available across asset classes and 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: POLYGON_GET_RISK_CATEGORIESTool to retrieve risk factor taxonomy categories from SEC 10-K filings. Use when you need to explore or filter risk classifications by taxonomy version or category level.

Input Parameters

string
Comma-separated columns with .asc or .desc direction (e.g., ‘taxonomy.asc,primary_category.desc’)
integer
Maximum number of results to return (default: 200, max: 999)
number
Version identifier for the taxonomy (e.g., 1.0, 1.1)
number
Filter taxonomy versions greater than this value
number
Filter taxonomy versions less than this value
number
Filter taxonomy versions greater than or equal to this value
number
Filter taxonomy versions less than or equal to this value
string
Filter by top-level risk category
string
Filter by most specific risk classification
string
Filter by mid-level risk category
string
Filter primary categories greater than this value
string
Filter primary categories less than this value
string
Filter primary categories greater than or equal to this value
string
Filter primary categories less than or equal to this value
string
Filter tertiary categories greater than this value
string
Filter tertiary categories less than this value
string
Filter secondary categories greater than this value
string
Filter secondary categories less than this value
string
Filter tertiary categories greater than or equal to this value
string
Filter tertiary categories less than or equal to this value
string
Filter secondary categories greater than or equal to this value
string
Filter secondary categories less than or equal to this value
string
Comma-separated list of primary categories to match any of
string
Comma-separated list of tertiary categories to match any of
string
Comma-separated list of secondary categories to match any of

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_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_GET_SHORT_INTERESTTool to retrieve bi-monthly aggregated short interest data for stocks reported to FINRA. Use when analyzing sentiment, identifying potential short squeezes, or researching short positions.

Input Parameters

string
Comma-separated list of sort columns. Append ‘.asc’ or ‘.desc’ to each column for sort direction. Defaults to ‘ticker’ if not specified.
integer
Maximum number of results to return. Defaults to 10, maximum is 50000.
string
Filter by primary ticker symbol. Supports filter modifiers: .gt (greater than), .gte (greater than or equal), .lt (less than), .lte (less than or equal), .any_of (match any in comma-separated list).
number
Filter by days to cover (short_interest / avg_daily_volume). Supports filter modifiers: .gt, .gte, .lt, .lte.
string
Filter by settlement date in YYYY-MM-DD format. Supports filter modifiers: .gt, .gte, .lt, .lte for date range queries.
integer
Filter by average daily trading volume. Supports filter modifiers: .gt, .gte, .lt, .lte.

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_GET_SHORT_VOLUMETool to retrieve short volume data for stocks. Use when analyzing short selling activity, market sentiment, or detecting abnormal short-selling patterns.

Input Parameters

string
Filter by date in YYYY-MM-DD format. Supports comparison operators (.gt, .gte, .lt, .lte) and .any_of for multiple values
string
Sort order for results. Comma-separated columns with .asc/.desc direction (e.g., ‘ticker.asc’, ‘date.desc’). Default: ticker.asc
integer
Limit the number of results (1-50000). Default: 10, Maximum: 50000
string
Filter by stock ticker symbol. Supports comparison operators (.gt, .gte, .lt, .lte) and .any_of for multiple values
integer
Filter by total volume. Supports comparison operators (.gt, .gte, .lt, .lte) and .any_of
number
Filter by short volume ratio (percentage of total trading volume sold short). Supports comparison operators (.gt, .gte, .lt, .lte) and .any_of

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_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_GET_SNAPSHOT_ALL_TICKERSRetrieve US stock market snapshots for all tickers or a specified list, optionally including OTC securities. If snapshot access returns HTTP 403, the tool may instead return previous-close data for requested tickers; this fallback can be partial.

Input Parameters

array
Case-sensitive list of stock ticker symbols (e.g., [‘AAPL’,‘TSLA’,‘GOOG’]). If omitted or empty, returns snapshots for all tickers.
boolean
Whether to include over-the-counter (OTC) securities in the snapshot.

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_GET_SNAPSHOT_LOSERSRetrieve a snapshot of the top losers in the U.S. stock market, optionally including OTC securities. Use it to review market data for the worst-performing stocks.

Input Parameters

boolean
Whether to include OTC securities; default 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_GET_SNAPSHOT_SINGLE_TICKERRetrieve a market snapshot for a specified case-sensitive stock ticker. The result may contain only the previous day’s aggregate data.

Input Parameters

string
required
Case-sensitive stock ticker symbol (e.g., ‘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: POLYGON_GET_SPLITSTool to retrieve stock split events. Use when you need corporate stock split data filtered by ticker or date range. Example: “Get splits for AAPL between 2021-01-01 and 2021-12-31”.

Input Parameters

string
Field to sort results by (default: ‘execution_date’)
integer
Maximum number of results to return (1-1000)
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’ (default: ‘desc’)
string
Stock ticker symbol to query splits for, e.g., ‘AAPL’
string
Filter splits executed on or after this date (YYYY-MM-DD)
string
Filter splits executed on or before 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_GET_STOCK_FINANCIALSTool to retrieve historical financial data for a stock ticker from SEC filings. Use when analyzing company financials, comparing quarters, or examining financial trends.

Input Parameters

string ("reportPeriod" | "-reportPeriod" | "calendarDate" | "-calendarDate")
Sort order for financial results.
string ("Y" | "YA" | "Q" | "QA" | "T" | "TA")
Report type for financial data.
integer
Limit the number of results returned (1-5000)
string
required
The stock ticker symbol to retrieve financials 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: POLYGON_GET_STOCK_FLOATTool to retrieve stock float data showing the number and percentage of publicly tradable shares. Use when you need information about the free float of stocks.

Input Parameters

string
Comma-separated sort columns with ‘.asc’/‘.desc’ directives (e.g., ‘ticker.asc’)
integer
Maximum results returned (default: 100, max: 5000)
string
Primary ticker symbol for the stock
string
Filter for ticker greater than specified value
string
Filter for ticker less than specified value
string
Filter for ticker greater than or equal to specified value
string
Filter for ticker less than or equal to specified value
string
Filter equal to any of the 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
number
Filter for free float percentage greater than specified value
number
Filter for free float percentage less than specified value
number
Filter for free float percentage greater than or equal to specified value
number
Filter for free float percentage less than or equal to 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_GET_STOCKS_BALANCE_SHEETSTool to retrieve point-in-time balance sheet data including assets, liabilities, and equity from company SEC filings. Use when analyzing financial position with quarterly and annual history.

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
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_GET_STOCKS_CASH_FLOW_STATEMENTSTool to retrieve historical cash flow statement data from company SEC filings across quarterly, annual, and TTM frequencies. Use when analyzing cash generation, operating activities, investing activities, or financing activities.

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
string
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_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_GET_STOCKS_DAILY_MARKET_SUMMARYRetrieve grouped daily OHLC, volume, and VWAP aggregate bars for US stocks on a specified trading date. OTC securities are excluded by default but can be included.

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_GET_STOCK_SPLITS_BY_TICKERTool to retrieve historical stock splits for a specific ticker symbol. Use when you need split history including ex-dates, payment dates, and split ratios for a particular stock.

Input Parameters

string
required
The ticker symbol of the stock (e.g., ‘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: POLYGON_GET_TECHNICAL_INDICATOR_EMADEPRECATED: Use POLYGON_GET_EMA instead. Tool to fetch Exponential Moving Average (EMA) for a given stock ticker. Use when you need historical EMA data after confirming ticker, timespan, and window size.

Input Parameters

integer
Maximum number of results to return
string ("asc" | "desc")
Order of results
string
required
Stock ticker symbol to query, e.g., ‘AAPL’
integer
required
Number of periods to calculate the EMA over (window size)
boolean
Whether to use adjusted data for EMA calculation
string
required
Aggregate timespan for each data point, e.g., ‘day’ or ‘minute’
string ("open" | "high" | "low" | "close")
Series type to use for the calculation
boolean
Whether to include underlying aggregates used to calculate EMA

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_GET_TECHNICAL_INDICATOR_SMATool to fetch Simple Moving Average (SMA) for a given stock ticker. Use when you need historical SMA data after confirming ticker, timespan, and window size.

Input Parameters

integer
Maximum number of results to return
string ("asc" | "desc")
Order of results
string
required
Stock ticker symbol to query, e.g., ‘AAPL’
integer
required
Number of periods to calculate the SMA over (window size)
boolean
Whether to use adjusted data
string
required
Aggregate timespan for each data point, e.g., ‘day’ or ‘minute’
string ("open" | "high" | "low" | "close")
Series type to use for the calculation
boolean
Whether to include underlying aggregates

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_GET_TICKER_COMPANY_DETAILSTool to retrieve detailed company information for a stock ticker. Use when you need company fundamentals like CEO, industry, sector, market cap, and headquarters information.

Input Parameters

string
required
The ticker symbol of the stock to retrieve company details for (e.g., ‘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: POLYGON_GET_TICKER_DETAILSTool to retrieve detailed information for a ticker. Use when you need an overview of a ticker including company info, market data, and identifiers.

Input Parameters

string
Point-in-time reference date in YYYY-MM-DD format. Defaults to most recent.
string
required
The ticker symbol to look up (e.g., ‘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: POLYGON_GET_TICKER_DETAILS_VXTool to retrieve comprehensive details for a specific ticker symbol using Polygon’s vX API. Use when you need detailed information about a company including identifiers, market data, and corporate details.

Input Parameters

string
Specify a point in time to get information about the ticker available on that date in YYYY-MM-DD format. When retrieving information from SEC filings, this date is compared with the period of report date on the SEC filing. Defaults to the most recent available date.
string
required
The ticker symbol to retrieve details for (e.g., ‘AAPL’, ‘TSLA’). 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_GET_TICKER_EVENTSTool to retrieve corporate events for a specific ticker. Use when you need the timeline of corporate actions for a given ticker.

Input Parameters

string
Comma-separated list of event types to include. Currently only ‘ticker_change’ is supported. Leave unset to return all types.
string
required
Ticker symbol (or CUSIP/FIGI) of the asset, e.g. ‘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: POLYGON_GET_TICKER_TYPESTool to retrieve all ticker types supported by Polygon.io. Use after authenticating to explore ticker categories.

Input Parameters

string ("us" | "global")
Filter by locale.
string ("stocks" | "options" | "crypto" | "fx" | "indices")
Filter by asset class. One of ‘stocks’, ‘options’, ‘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_GET_TREASURY_YIELDSTool to retrieve historical U.S. Treasury yield data for standard timeframes from 1-month to 30-year maturities. Use when analyzing interest rates, yield curves, or economic indicators. Data available daily back to 1962.

Input Parameters

string
Query by specific date in YYYY-MM-DD format. Returns yields for this exact date.
string
Field to sort by. Use ‘date’ for ascending or ‘-date’ for descending order.
integer
Maximum number of results to return. Default is 100, maximum is 50000.
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
Filter for any of the specified dates. Comma-separated list 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_GET_V1_META_CRYPTO_EXCHANGESTool to retrieve a list of cryptocurrency exchanges using the legacy v1 API. Use when you need the complete list of crypto exchanges 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: 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_LAST_TRADE_FOR_A_CURRENCY_PAIRRetrieve the latest forex quote for a currency pair, including bid and ask prices, exchange, and timestamp when available.

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
Slug: POLYGON_LIST_FILING_FILESList files associated with a specific SEC filing by filing ID. Results may be paginated.

Input Parameters

string ("sequence" | "filename")
Sort field for filing files
integer
Limit the number of results returned (1-1000). Default is 10.
string ("asc" | "desc")
Order direction for results
string
Query by file name.
integer
Query by file sequence number.
string
required
The filing ID to retrieve files for (e.g., ‘0001300514-21-000058’).
string
Filter files with filename greater than this value (lexicographically).
string
Filter files with filename less than this value (lexicographically).
integer
Filter files with sequence greater than this value.
integer
Filter files with sequence less than this value.
string
Filter files with filename greater than or equal to this value (lexicographically).
string
Filter files with filename less than or equal to this value (lexicographically).
integer
Filter files with sequence greater than or equal to this value.
integer
Filter files with sequence 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_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_LIST_SEC_FILINGSTool to retrieve SEC filings from Polygon. Use when you need to query 10-K or 10-Q filings by company, date range, or other criteria.

Input Parameters

string ("filing_date" | "period_of_report_date")
Sort field for ordering results.
string ("10-K" | "10-Q")
SEC filing types.
integer
Limit the number of results returned (default 10, max 1000)
string ("asc" | "desc")
Sort order for results.
boolean
If true, query only filings with XBRL. If false, query filings without XBRL. If omitted, query all.
string
Query by filing date (YYYYMMDD format)
string
Filing date greater than (YYYYMMDD format)
string
Filing date less than (YYYYMMDD format)
string
Filing date greater than or equal to (YYYYMMDD format)
string
Filing date less than or equal to (YYYYMMDD format)
string
Query by period of report (YYYYMMDD format)
string
Period of report date greater than (YYYYMMDD format)
string
Period of report date less than (YYYYMMDD format)
string
Query by entity company CIK
string
Query by entity company SIC code
string
Period of report date greater than or equal to (YYYYMMDD format)
string
Period of report date less than or equal to (YYYYMMDD format)
string
Query by entity company name
string
Query by entity company ticker symbol
Search by entities company name

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