The Massive (Polygon.io) connector lets your AI agent act in each user's Massive (Polygon.io) account. Each user connects their own Massive (Polygon.io) access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 60 · 0 · 060 read0 write0 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Massive (Polygon.io) connection
In AgentKit > Connections, create a Massive (Polygon.io) connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'polygon'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Massive (Polygon.io):', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'polygon_balance_sheets_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "polygon"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Massive (Polygon.io):", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="polygon_balance_sheets_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Massive (Polygon.io) credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolpolygon_aggregates_getGet OHLC aggregate bars for any ticker (stocks, options, indices, forex or crypto) over a date range, in windows of multiplier x timespan (for example 5 minute or 1 day).Read-onlyGet Aggregate Bars
Get OHLC aggregate bars for any ticker (stocks, options, indices, forex or crypto) over a date range, in windows of multiplier x timespan (for example 5 minute or 1 day). Returns per bar the open, high, low, close, volume, VWAP, trade count and start timestamp, plus next_url when more bars remain. Use this for price history and charts. Use polygon_previous_close_get for only the last day.
Inputs
fromstringrequired- The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. Example: 2025-11-03.
multiplierintegerrequired- The size of the timespan multiplier. Example: 1.
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
timespanstringrequired- The size of the time window. One of: second, minute, hour, day, week, month, quarter, year. Example: day.one of
secondminutehourdayweekmonthquarteryear tostringrequired- The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp. Example: 2025-11-28.
adjustedboolean- 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. Example: true.
limitinteger- Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on <a href="https://massive.com/blog/aggs-api-updates/" target="_blank" alt="Aggregate Data API Improvements">Aggregate Data API Improvements</a>. Example: 25.
sortstring- Sort the results by timestamp. asc will return results in ascending order (oldest at the top), desc will return results in descending order (newest at the top). One of: asc, desc. Example: asc.one of
ascdesc
polygon_balance_sheets_listList balance sheet data from SEC filings, filtered by CIK, ticker, period end, filing date, fiscal year, fiscal quarter or timeframe.Read-onlyList Balance Sheets
List balance sheet data from SEC filings, filtered by CIK, ticker, period end, filing date, fiscal year, fiscal quarter or timeframe. Returns assets, liabilities, equity and their line items per reporting period, plus next_url. Use this for a company's financial position. Use polygon_income_statements_list for revenue and earnings.
Inputs
cikstring- The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company's CIK using the SEC CIK Lookup tool (https://www.sec.gov/search-filings/cik-lookup). Example: 0000320193.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
filing_datestring- The date of the most recent SEC filing that included this period's data. This is not necessarily the date this period was originally filed. Because SEC filings restate comparative data for prior periods, multiple records can share the same filing_date. For example, an annual 10-K reports three years of results, and a 10-Q includes prior period comparatives. To find the original filing date for a specific 10-K or 10-Q, use the SEC EDGAR filings index endpoint (/stocks/filings/vX/index). Value must be formatted 'yyyy-mm-dd'. Example: 2025-10-31.
filing_date_gtestring- Return records with filing date on or after (greater than or equal to) this value. Example: 2025-10-31.
filing_date_ltestring- Return records with filing date on or before (less than or equal to) this value. Example: 2025-10-31.
fiscal_quarterinteger- The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be an integer. Example: 4.
fiscal_yearinteger- The fiscal year for the reporting period. Value must be an integer. Example: 2025.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
period_endstring- The last date of the reporting period, representing the specific point in time when the balance sheet snapshot was taken. Value must be formatted 'yyyy-mm-dd'. Example: 2025-09-27.
period_end_gtestring- Return records with period end on or after (greater than or equal to) this value. Example: 2025-09-27.
period_end_ltestring- Return records with period end on or before (less than or equal to) this value. Example: 2025-09-27.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified. Example: period_end.desc.
tickersstring- Filter for arrays that contain the value. Example: AAPL.
timeframestring- The reporting period type. Possible values include: quarterly, annual. Example: quarterly.
polygon_cash_flow_statements_listList cash flow statement data from SEC filings, filtered by CIK, ticker, period end, filing date, fiscal year, fiscal quarter or timeframe.Read-onlyList Cash Flow Statements
List cash flow statement data from SEC filings, filtered by CIK, ticker, period end, filing date, fiscal year, fiscal quarter or timeframe. Returns operating, investing and financing cash flows and their line items per period, plus next_url. Use this for a company's cash generation.
Inputs
cikstring- The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the SEC CIK Lookup tool (https://www.sec.gov/search-filings/cik-lookup). Example: 0000320193.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
filing_datestring- The date of the most recent SEC filing that included this period's data. This is not necessarily the date this period was originally filed. Because SEC filings restate comparative data for prior periods, multiple records can share the same filing_date. For example, an annual 10-K reports three years of results, and a 10-Q includes prior period comparatives. To find the original filing date for a specific 10-K or 10-Q, use the SEC EDGAR filings index endpoint (/stocks/filings/vX/index). Value must be formatted 'yyyy-mm-dd'. Example: 2025-10-31.
filing_date_gtestring- Return records with filing date on or after (greater than or equal to) this value. Example: 2025-10-31.
filing_date_ltestring- Return records with filing date on or before (less than or equal to) this value. Example: 2025-10-31.
fiscal_quarterinteger- The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be an integer. Example: 4.
fiscal_yearinteger- The fiscal year for the reporting period. Value must be an integer. Example: 2025.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
period_endstring- The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'. Example: 2025-09-27.
period_end_gtestring- Return records with period end on or after (greater than or equal to) this value. Example: 2025-09-27.
period_end_ltestring- Return records with period end on or before (less than or equal to) this value. Example: 2025-09-27.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified. Example: period_end.desc.
tickersstring- Filter for arrays that contain the value. Example: AAPL.
timeframestring- The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. Example: quarterly.
polygon_conditions_listList the trade and quote condition codes, optionally for one asset class, data type or SIP.Read-onlyList Trade and Quote Conditions
List the trade and quote condition codes, optionally for one asset class, data type or SIP. Returns ID, name, type, description, SIP mappings and how the condition updates OHLC and volume. Use this to decode condition IDs in trades and quotes.
Inputs
asset_classstring- Filter for conditions within a given asset class. One of: stocks, options, crypto, fx. Example: stocks.one of
stocksoptionscryptofx cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
data_typestring- Filter by data type. One of: trade, bbo, nbbo. Example: trade.one of
tradebbonbbo idinteger- Filter for conditions with a given ID. Example: 2.
limitinteger- Limit the number of results returned, default is 10 and max is 1000. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Example: asc.one of
ascdesc sipstring- Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned. One of: CTA, UTP, OPRA. Example: CTA.one of
CTAUTPOPRA sortstring- Sort field used for ordering. One of: asset_class, id, type, name, data_types, legacy. Defaults to asset_class. Example: name.one of
asset_classidtypenamedata_typeslegacy
polygon_crypto_daily_open_close_getGet the open and close prices of a crypto pair on one date.Read-onlyGet Crypto Daily Open and Close
Get the open and close prices of a crypto pair on one date. Returns the symbol, open, close and the opening and closing trades. Use this for one crypto pair on one day.
Inputs
datestringrequired- The date of the requested open/close in the format YYYY-MM-DD. Example: 2025-11-03.
fromstringrequired- Base crypto symbol of the pair. Example: BTC.
tostringrequired- Quote currency symbol of the pair. Example: USD.
adjustedboolean- 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. Example: true.
polygon_crypto_last_trade_getGet the most recent trade for a crypto pair.Read-onlyGet Last Crypto Trade
Get the most recent trade for a crypto pair. Returns price, size, exchange, conditions and timestamp. Use this for the latest crypto price.
Inputs
fromstringrequired- Base crypto symbol. Example: BTC.
tostringrequired- Quote currency symbol. Example: USD.
polygon_crypto_movers_getGet the top 20 crypto gainers or losers of the day by percent change.Read-onlyGet Top Crypto Movers
Get the top 20 crypto gainers or losers of the day by percent change. Returns snapshots for those pairs. Use this for today's biggest crypto moves.
Inputs
directionstringrequired- The direction of the snapshot results to return. One of: gainers, losers. Example: gainers.one of
gainerslosers
polygon_crypto_order_book_getGet the current level 2 order book of a crypto pair across exchanges.Read-onlyGet Crypto Order Book
Get the current level 2 order book of a crypto pair across exchanges. Returns bids and asks with prices and sizes per exchange, the bid and ask counts and the spread. Use this for market depth.
Inputs
tickerstringrequired- Crypto ticker with the X: prefix. Example: X:BTCUSD.
polygon_crypto_snapshot_getGet the current snapshot of one crypto pair.Read-onlyGet Crypto Snapshot
Get the current snapshot of one crypto pair. Returns the day and previous-day bars, latest minute bar, last trade and today's change. Use this for one pair's live picture.
Inputs
tickerstringrequired- Crypto ticker with the X: prefix. Example: X:BTCUSD.
polygon_crypto_snapshot_listGet current snapshots for all crypto pairs, or for a list of tickers.Read-onlyList Crypto Snapshots
Get current snapshots for all crypto pairs, or for a list of tickers. Returns per pair the day and previous-day bars, minute bar, last trade and today's change. Use this to scan crypto markets. Use polygon_crypto_snapshot_get for one pair.
Inputs
tickersstring- Comma-separated crypto tickers; leave empty for all. Example: ["X:BTCUSD","X:ETHUSD"].
polygon_currency_convertConvert an amount from one currency to another (forex or crypto) at the latest rate.Read-onlyConvert Currency
Convert an amount from one currency to another (forex or crypto) at the latest rate. Returns the converted amount, the initial amount and the last quote used. Use this for real-time conversions.
Inputs
fromstringrequired- Currency to convert from. Example: EUR.
tostringrequired- Currency to convert to. Example: USD.
amountnumber- The amount to convert, with a decimal. Defaults to 1. Example: 100.
precisioninteger- The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy. One of: 0, 1, 2, 3, 4. Example: 2.
polygon_daily_open_close_getGet the open, close, high, low, volume and pre-market and after-hours prices of a stock, option or index on one date.Read-onlyGet Daily Open and Close
Get the open, close, high, low, volume and pre-market and after-hours prices of a stock, option or index on one date. Returns those prices for the day. Use this for one ticker on one day. Use polygon_crypto_daily_open_close_get for a crypto pair.
Inputs
datestringrequired- The date of the requested open/close in the format YYYY-MM-DD. Example: 2025-11-03.
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
adjustedboolean- 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. Example: true.
polygon_dividends_listList historical cash dividends for US stocks, filtered by ticker, ex-dividend date or frequency.Read-onlyList Dividends
List historical cash dividends for US stocks, filtered by ticker, ex-dividend date or frequency. Returns ex-dividend, record, pay and declaration dates, cash amount, split-adjusted amount, frequency and distribution type, plus next_url. Use this for a stock's dividend history.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
distribution_typestring- Classification describing the nature of this dividend's recurrence pattern: recurring (paid on a regular schedule), special (one-time or commemorative), supplemental (extra beyond the regular schedule), irregular (unpredictable or non-recurring), unknown (cannot be classified from available data). One of: recurring, special, supplemental, irregular, unknown. Example: recurring.one of
recurringspecialsupplementalirregularunknown ex_dividend_datestring- Date when the stock begins trading without the dividend value Value must be formatted 'yyyy-mm-dd'. Example: 2025-11-10.
ex_dividend_date_gtestring- Return records with ex dividend date on or after (greater than or equal to) this value. Example: 2025-11-10.
ex_dividend_date_ltestring- Return records with ex dividend date on or before (less than or equal to) this value. Example: 2025-11-10.
frequencyinteger- 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. Value must be an integer. Example: 4.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'. Example: 25.
sortstring- 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. Example: ex_dividend_date.desc.
tickerstring- Stock symbol for the company issuing the dividend. Example: AAPL.
polygon_exchanges_listList the exchanges Massive knows, optionally for one asset class or locale.Read-onlyList Exchanges
List the exchanges Massive knows, optionally for one asset class or locale. Returns ID, name, MIC, operating MIC, participant ID, type and URL. Use this to decode exchange IDs in trades and quotes.
Inputs
asset_classstring- Filter by asset class. One of: stocks, options, crypto, fx, futures. Example: stocks.one of
stocksoptionscryptofxfutures localestring- Filter by locale. One of: us, global. Example: us.one of
usglobal
polygon_filings_index_listList SEC EDGAR filings for public companies, filtered by CIK, ticker, form type or filing date.Read-onlyList SEC Filings
List SEC EDGAR filings for public companies, filtered by CIK, ticker, form type or filing date. Returns accession number, CIK, ticker, form type, filing date and links to the filing, plus next_url. Use this to find a company's 10-K, 10-Q or 8-K filings. Use polygon_risk_factors_list for extracted risk factors.
Inputs
cikstring- SEC Central Index Key (CIK) identifying the filing entity. Example: 0000320193.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
filing_datestring- Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'. Example: 2025-10-31.
filing_date_gtestring- Return records with filing date on or after (greater than or equal to) this value. Example: 2025-10-31.
filing_date_ltestring- Return records with filing date on or before (less than or equal to) this value. Example: 2025-10-31.
form_typestring- SEC form type (e.g., '10-K', '10-Q', '8-K', 'S-1', '4', etc.). Example: 10-K.
limitinteger- Limit the maximum number of results returned. Defaults to '1000' if not specified. The maximum allowed limit is '10000'. Example: 25.
sortstring- 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. Example: filing_date.desc.
tickerstring- Stock ticker symbol for the filing entity, if available. Example: AAPL.
polygon_float_listList the free float of US stocks, filtered by ticker or free float percent.Read-onlyList Stock Float
List the free float of US stocks, filtered by ticker or free float percent. Returns ticker, free float shares, free float percent and effective date, plus next_url. Use this to see how many shares trade publicly.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
free_float_percentnumber- Percentage of total shares outstanding that are available for public trading, rounded to two decimal places. Value must be a floating point number. Example: 85.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'. Example: 25.
sortstring- 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. Example: ticker.
tickerstring- The primary ticker symbol for the stock. Example: AAPL.
polygon_forex_last_quote_getGet the most recent bid and ask quote for a currency pair.Read-onlyGet Last Forex Quote
Get the most recent bid and ask quote for a currency pair. Returns ask, bid, exchange and timestamp. Use this for the current exchange rate spread. Use polygon_currency_convert to convert an amount.
Inputs
fromstringrequired- Base currency code. Example: EUR.
tostringrequired- Quote currency code. Example: USD.
polygon_forex_movers_getGet the top 20 forex gainers or losers of the day by percent change.Read-onlyGet Top Forex Movers
Get the top 20 forex gainers or losers of the day by percent change. Returns snapshots for those pairs. Use this for today's biggest currency moves.
Inputs
directionstringrequired- The direction of the snapshot results to return. One of: gainers, losers. Example: gainers.one of
gainerslosers
polygon_forex_snapshot_getGet the current snapshot of one forex pair.Read-onlyGet Forex Snapshot
Get the current snapshot of one forex pair. Returns the day and previous-day bars, latest minute bar, last quote and today's change. Use this for one pair's live picture.
Inputs
tickerstringrequired- Forex ticker with the C: prefix. Example: C:EURUSD.
polygon_forex_snapshot_listGet current snapshots for all forex pairs, or for a list of tickers.Read-onlyList Forex Snapshots
Get current snapshots for all forex pairs, or for a list of tickers. Returns per pair the day and previous-day bars, minute bar, last quote and today's change. Use this to scan currency markets. Use polygon_forex_snapshot_get for one pair.
Inputs
tickersstring- Comma-separated forex tickers; leave empty for all. Example: ["C:EURUSD","C:GBPUSD"].
polygon_grouped_daily_crypto_getGet the daily OHLC bar of every crypto pair for one date.Read-onlyGet Grouped Daily Crypto Bars
Get the daily OHLC bar of every crypto pair for one date. Returns, per pair, open, high, low, close, volume, VWAP and trade count. Use this for a whole crypto market view of one day.
Inputs
datestringrequired- The beginning date for the aggregate window. Example: 2025-11-03.
adjustedboolean- 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. Example: true.
polygon_grouped_daily_forex_getGet the daily OHLC bar of every forex pair for one date.Read-onlyGet Grouped Daily Forex Bars
Get the daily OHLC bar of every forex pair for one date. Returns, per pair, open, high, low, close, volume, VWAP and trade count. Use this for a whole forex market view of one day.
Inputs
datestringrequired- The beginning date for the aggregate window. Example: 2025-11-03.
adjustedboolean- 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. Example: true.
polygon_grouped_daily_stocks_getGet the daily OHLC bar of every US stock for one trading date.Read-onlyGet Grouped Daily Stock Bars
Get the daily OHLC bar of every US stock for one trading date. Returns, per ticker, open, high, low, close, volume, VWAP and trade count. Use this for a whole-market view of one day. Use polygon_aggregates_get for one ticker over time.
Inputs
datestringrequired- The beginning date for the aggregate window. Example: 2025-11-03.
adjustedboolean- 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. Example: true.
include_otcboolean- Include OTC securities in the response. Default is false (don't include OTC securities). Example: true.
polygon_income_statements_listList income statement data from SEC filings, filtered by CIK, ticker, period end, filing date, fiscal year, fiscal quarter or timeframe.Read-onlyList Income Statements
List income statement data from SEC filings, filtered by CIK, ticker, period end, filing date, fiscal year, fiscal quarter or timeframe. Returns revenue, cost of revenue, operating income, net income, EPS and other line items per period, plus next_url. Use this for a company's earnings history.
Inputs
cikstring- The company's Central Index Key (CIK), a unique identifier assigned by the U.S. Securities and Exchange Commission (SEC). You can look up a company’s CIK using the SEC CIK Lookup tool (https://www.sec.gov/search-filings/cik-lookup). Example: 0000320193.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
filing_datestring- The date of the most recent SEC filing that included this period's data. This is not necessarily the date this period was originally filed. Because SEC filings restate comparative data for prior periods, multiple records can share the same filing_date. For example, an annual 10-K reports three years of results, and a 10-Q includes prior period comparatives. To find the original filing date for a specific 10-K or 10-Q, use the SEC EDGAR filings index endpoint (/stocks/filings/vX/index). Value must be formatted 'yyyy-mm-dd'. Example: 2025-10-31.
filing_date_gtestring- Return records with filing date on or after (greater than or equal to) this value. Example: 2025-10-31.
filing_date_ltestring- Return records with filing date on or before (less than or equal to) this value. Example: 2025-10-31.
fiscal_quarterinteger- The fiscal quarter number (1, 2, 3, or 4) for the reporting period. Value must be an integer. Example: 4.
fiscal_yearinteger- The fiscal year for the reporting period. Value must be an integer. Example: 2025.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
period_endstring- The last date of the reporting period (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'. Example: 2025-09-27.
period_end_gtestring- Return records with period end on or after (greater than or equal to) this value. Example: 2025-09-27.
period_end_ltestring- Return records with period end on or before (less than or equal to) this value. Example: 2025-09-27.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'period_end' if not specified. The sort order defaults to 'asc' if not specified. Example: period_end.desc.
tickersstring- Filter for arrays that contain the value. Example: AAPL.
timeframestring- The reporting period type. Possible values include: quarterly, annual, trailing_twelve_months. Example: quarterly.
polygon_indicator_ema_getCalculate the Exponential Moving Average (EMA) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window.Read-onlyGet Exponential Moving Average (EMA)
Calculate the Exponential Moving Average (EMA) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window. Returns the EMA value per timestamp and, with expand_underlying, the underlying aggregate bars, plus next_url. Use this for technical analysis; the other indicator tools compute SMA, EMA, MACD and RSI.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
adjustedboolean- 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. Example: true.
expand_underlyingboolean- Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to false. Example: true.
limitinteger- Limit the number of results returned, default is 10 and max is 5000. Example: 25.
orderstring- The order in which to return the results, ordered by timestamp. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc series_typestring- The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to calculate the exponential moving average (EMA). One of: open, high, low, close. Defaults to close. Example: open.one of
openhighlowclose timespanstring- The size of the aggregate time window. One of: minute, hour, day, week, month, quarter, year. Defaults to day. Example: day.one of
minutehourdayweekmonthquarteryear timestampstring- Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. Example: 2025-11-03.
timestamp_gtestring- Return records with timestamp on or after (greater than or equal to) this value. Example: 2025-11-03.
timestamp_ltestring- Return records with timestamp on or before (less than or equal to) this value. Example: 2025-11-03.
windowinteger- The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. Defaults to 50. Example: 50.
polygon_indicator_macd_getCalculate the Moving Average Convergence/Divergence (MACD) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window.Read-onlyGet Moving Average Convergence/Divergence (MACD)
Calculate the Moving Average Convergence/Divergence (MACD) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window. Returns the MACD, signal and histogram values per timestamp and, with expand_underlying, the underlying aggregate bars, plus next_url. Use this for technical analysis; the other indicator tools compute SMA, EMA, MACD and RSI.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
adjustedboolean- Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. Example: true.
expand_underlyingboolean- Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to false. Example: true.
limitinteger- Limit the number of results returned, default is 10 and max is 5000. Example: 25.
long_windowinteger- The long window size used to calculate MACD data. Defaults to 26. Example: 26.
orderstring- The order in which to return the results, ordered by timestamp. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc series_typestring- The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to calculate the MACD. One of: open, high, low, close. Defaults to close. Example: open.one of
openhighlowclose short_windowinteger- The short window size used to calculate MACD data. Defaults to 12. Example: 12.
signal_windowinteger- The window size used to calculate the MACD signal line. Defaults to 9. Example: 9.
timespanstring- The size of the aggregate time window. One of: minute, hour, day, week, month, quarter, year. Defaults to day. Example: day.one of
minutehourdayweekmonthquarteryear timestampstring- Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. Example: 2025-11-03.
timestamp_gtestring- Return records with timestamp on or after (greater than or equal to) this value. Example: 2025-11-03.
timestamp_ltestring- Return records with timestamp on or before (less than or equal to) this value. Example: 2025-11-03.
polygon_indicator_rsi_getCalculate the Relative Strength Index (RSI) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window.Read-onlyGet Relative Strength Index (RSI)
Calculate the Relative Strength Index (RSI) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window. Returns the RSI value per timestamp and, with expand_underlying, the underlying aggregate bars, plus next_url. Use this for technical analysis; the other indicator tools compute SMA, EMA, MACD and RSI.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
adjustedboolean- Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. Example: true.
expand_underlyingboolean- Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to false. Example: true.
limitinteger- Limit the number of results returned, default is 10 and max is 5000. Example: 25.
orderstring- The order in which to return the results, ordered by timestamp. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc series_typestring- The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to calculate the relative strength index (RSI). One of: open, high, low, close. Defaults to close. Example: open.one of
openhighlowclose timespanstring- The size of the aggregate time window. One of: minute, hour, day, week, month, quarter, year. Defaults to day. Example: day.one of
minutehourdayweekmonthquarteryear timestampstring- Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. Example: 2025-11-03.
timestamp_gtestring- Return records with timestamp on or after (greater than or equal to) this value. Example: 2025-11-03.
timestamp_ltestring- Return records with timestamp on or before (less than or equal to) this value. Example: 2025-11-03.
windowinteger- The window size used to calculate the relative strength index (RSI). Defaults to 14. Example: 50.
polygon_indicator_sma_getCalculate the Simple Moving Average (SMA) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window.Read-onlyGet Simple Moving Average (SMA)
Calculate the Simple Moving Average (SMA) of any ticker (stocks, options, indices, forex or crypto) over a timespan and window. Returns the SMA value per timestamp and, with expand_underlying, the underlying aggregate bars, plus next_url. Use this for technical analysis; the other indicator tools compute SMA, EMA, MACD and RSI.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
adjustedboolean- Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits. Example: true.
expand_underlyingboolean- Whether or not to include the aggregates used to calculate this indicator in the response. Defaults to false. Example: true.
limitinteger- Limit the number of results returned, default is 10 and max is 5000. Example: 25.
orderstring- The order in which to return the results, ordered by timestamp. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc series_typestring- The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to calculate the simple moving average (SMA). One of: open, high, low, close. Defaults to close. Example: open.one of
openhighlowclose timespanstring- The size of the aggregate time window. One of: minute, hour, day, week, month, quarter, year. Defaults to day. Example: day.one of
minutehourdayweekmonthquarteryear timestampstring- Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp. Example: 2025-11-03.
timestamp_gtestring- Return records with timestamp on or after (greater than or equal to) this value. Example: 2025-11-03.
timestamp_ltestring- Return records with timestamp on or before (less than or equal to) this value. Example: 2025-11-03.
windowinteger- The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average. Defaults to 50. Example: 50.
polygon_indices_snapshot_getGet snapshots for one or more indices.Read-onlyGet Indices Snapshot
Get snapshots for one or more indices. Returns the index value, session open, high, low, close, change and change percent and market status. Use this for current index levels such as I:SPX or I:NDX.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
limitinteger- Limit the number of results returned, default is 10 and max is 250. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Example: asc.one of
ascdesc sortstring- Sort field used for ordering. One of: ticker. Defaults to ticker. Example: ticker.one of
ticker tickerstring- Index ticker. Example: I:SPX.
ticker_any_ofstring- Comma-separated list of up to 250 index tickers. Example: I:SPX,I:NDX.
polygon_inflation_listList US inflation indicators (CPI and PCE, headline and core) by date.Read-onlyList Inflation Data
List US inflation indicators (CPI and PCE, headline and core) by date. Returns the date and each index value, plus next_url. Use this for inflation history.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
datestring- Calendar date of the observation (YYYY‑MM‑DD). Example: 2025-11-03.
date_gtestring- Return records with date on or after (greater than or equal to) this value. Example: 2025-11-03.
date_ltestring- Return records with date on or before (less than or equal to) this value. Example: 2025-11-03.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified. Example: date.desc.
polygon_insider_activity_listList insider transactions (SEC Forms 3, 4 and 5) for US stocks, filtered by ticker, issuer CIK or transaction date.Read-onlyList Insider Activity
List insider transactions (SEC Forms 3, 4 and 5) for US stocks, filtered by ticker, issuer CIK or transaction date. Returns insider name and role, transaction date and code, shares, price and holdings after the trade, plus next_url. Use this to track insider buying and selling.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
issuer_cikstring- SEC Central Index Key of the issuer company (10 digits, zero-padded). Example: 0000320193.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '10000'. Example: 25.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'transaction_date' if not specified. The sort order defaults to 'desc' if not specified. Example: transaction_date.desc.
tickersstring- Filter for arrays that contain the value. Example: AAPL.
transaction_datestring- Date of the transactions (formatted as YYYY-MM-DD). Value must be formatted 'yyyy-mm-dd'. Example: 2025-10-01.
transaction_date_gtestring- Return records with transaction date on or after (greater than or equal to) this value. Example: 2025-10-01.
transaction_date_ltestring- Return records with transaction date on or before (less than or equal to) this value. Example: 2025-10-01.
polygon_ipos_listList initial public offerings, filtered by ticker, ISIN, US code, listing date or IPO status (pending, new, history and so on).Read-onlyList IPOs
List initial public offerings, filtered by ticker, ISIN, US code, listing date or IPO status (pending, new, history and so on). Returns issuer name, ticker, listing date, price range, final issue price, shares offered, exchange and status, plus next_url. Use this to track upcoming and recent IPOs.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
ipo_statusstring- Specify an IPO status. One of: direct_listing_process, history, new, pending, postponed, rumor, withdrawn. Example: history.one of
direct_listing_processhistorynewpendingpostponedrumorwithdrawn isinstring- Specify an International Securities Identification Number (ISIN). This is a unique twelve-digit code that is assigned to every security issuance in the world. Example: US0378331005.
limitinteger- Limit the number of results returned, default is 10 and max is 1000. Example: 25.
listing_datestring- Specify a listing date. This is the first trading date for the newly listed entity. Example: 2025-11-03.
listing_date_gtestring- Return records with listing date on or after (greater than or equal to) this value. Example: 2025-11-03.
listing_date_ltestring- Return records with listing date on or before (less than or equal to) this value. Example: 2025-11-03.
orderstring- Order results based on the sort field. One of: asc, desc. Defaults to desc. Example: asc.one of
ascdesc sortstring- Sort field used for ordering. One of: listing_date, ticker, last_updated, security_type, issuer_name, currency_code, isin, us_code, final_issue_price, min_shares_offered, max_shares_offered, lowest_offer_price, highest_offer_price, total_offer_size, shares_outstanding, primary_exchange, lot_size, security_description, ipo_status, announced_date. Defaults to listing_date. Example: listing_date.one of
listing_datetickerlast_updatedsecurity_typeissuer_namecurrency_codeisinus_codefinal_issue_pricemin_shares_offeredmax_shares_offeredlowest_offer_pricehighest_offer_pricetotal_offer_sizeshares_outstandingprimary_exchangelot_sizesecurity_descriptionipo_statusannounced_date tickerstring- Specify a case-sensitive ticker symbol. For example, TSLA represents Tesla Inc. Example: AAPL.
us_codestring- Specify a us_code. This is a unique nine-character alphanumeric code that identifies a North American financial security for the purposes of facilitating clearing and settlement of trades. Example: US0378331005.
polygon_labor_market_listList US labor market indicators by date, such as the unemployment rate, labor force participation, average hourly earnings and job openings.Read-onlyList Labor Market Data
List US labor market indicators by date, such as the unemployment rate, labor force participation, average hourly earnings and job openings. Returns the date and each indicator, plus next_url. Use this for employment trends.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
datestring- Calendar date of the observation (YYYY-MM-DD). Example: 2025-11-03.
date_gtestring- Return records with date on or after (greater than or equal to) this value. Example: 2025-11-03.
date_ltestring- Return records with date on or before (less than or equal to) this value. Example: 2025-11-03.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified. Example: date.desc.
polygon_last_quote_getGet the most recent NBBO quote for a stock.Read-onlyGet Last Quote
Get the most recent NBBO quote for a stock. Returns bid and ask price, size and exchange, conditions and timestamps. Use this for the current spread. Use polygon_forex_last_quote_get for a currency pair.
Inputs
tickerstringrequired- Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. Example: AAPL.
polygon_last_trade_getGet the most recent trade for a stock or options ticker.Read-onlyGet Last Trade
Get the most recent trade for a stock or options ticker. Returns price, size, exchange, conditions and timestamps. Use this for the latest trade price. Use polygon_crypto_last_trade_get for a crypto pair.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
polygon_market_holidays_listList upcoming market holidays and early closes for US exchanges.Read-onlyList Upcoming Market Holidays
List upcoming market holidays and early closes for US exchanges. Returns date, exchange, holiday name, status (closed or early-close) and open and close times. Use this to plan around closures. Use polygon_market_status_get for the status right now.
Inputs
This tool takes no inputs.
polygon_market_status_getGet the current trading status of US exchanges and the forex and crypto markets.Read-onlyGet Market Status
Get the current trading status of US exchanges and the forex and crypto markets. Returns overall market state, early-hours and after-hours flags, server time and per-exchange and per-index-group status. Use this to check whether markets are open now. Use polygon_market_holidays_list for upcoming closures.
Inputs
This tool takes no inputs.
polygon_news_listList recent news articles, optionally for one ticker and a published date range.Read-onlyList Ticker News
List recent news articles, optionally for one ticker and a published date range. Returns title, publisher, author, published time, article URL, tickers mentioned, keywords and per-ticker sentiment insights, plus next_url. Use this for news about a company.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
limitinteger- Limit the number of results returned, default is 10 and max is 1000. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Defaults to desc. Example: asc.one of
ascdesc published_utcstring- Return results published on, before, or after this date. Example: 2025-11-03T00:00:00Z.
published_utc_gtestring- Return records with published utc on or after (greater than or equal to) this value. Example: 2025-11-03T00:00:00Z.
published_utc_ltestring- Return records with published utc on or before (less than or equal to) this value. Example: 2025-11-03T00:00:00Z.
sortstring- Sort field used for ordering. One of: published_utc. Defaults to published_utc. Example: published_utc.one of
published_utc tickerstring- Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. Example: AAPL.
polygon_option_contract_snapshot_getGet the snapshot of one options contract.Read-onlyGet Option Contract Snapshot
Get the snapshot of one options contract. Returns the day bar, last quote and trade, greeks, implied volatility, open interest, break-even price and underlying price. Use this for one known contract.
Inputs
option_contractstringrequired- Options contract ticker. Example: O:AAPL251219C00200000.
underlying_assetstringrequired- Underlying stock ticker. Example: AAPL.
polygon_options_chain_snapshot_getGet snapshots of all options contracts on an underlying, filtered by strike, expiration and contract type.Read-onlyGet Options Chain Snapshot
Get snapshots of all options contracts on an underlying, filtered by strike, expiration and contract type. Returns per contract the details, day bar, last quote and trade, greeks, implied volatility, open interest and break-even price, plus next_url. Use this to scan an options chain.
Inputs
underlying_assetstringrequired- Underlying stock ticker. Example: AAPL.
contract_typestring- Query by the type of contract. One of: call, put. Example: call.one of
callput cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
expiration_datestring- Query by contract expiration with date format YYYY-MM-DD. Example: 2025-12-19.
expiration_date_gtestring- Return records with expiration date on or after (greater than or equal to) this value. Example: 2025-12-19.
expiration_date_ltestring- Return records with expiration date on or before (less than or equal to) this value. Example: 2025-12-19.
limitinteger- Limit the number of results returned, default is 10 and max is 250. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Example: asc.one of
ascdesc sortstring- Sort field used for ordering. One of: ticker, expiration_date, strike_price. Defaults to ticker. Example: strike_price.one of
tickerexpiration_datestrike_price strike_pricenumber- Query by strike price of a contract. Example: 200.
strike_price_gtenumber- Return records with strike price on or after (greater than or equal to) this value. Example: 200.
strike_price_ltenumber- Return records with strike price on or before (less than or equal to) this value. Example: 200.
polygon_options_contract_getGet the reference details of one options contract.Read-onlyGet Options Contract
Get the reference details of one options contract. Returns underlying ticker, contract type, strike price, expiration date, exercise style, shares per contract and primary exchange. Use this for one known contract ticker.
Inputs
options_tickerstringrequired- Query for a contract by options ticker. You can learn more about the structure of options tickers here (https://massive.com/blog/how-to-read-a-stock-options-ticker/). Example: O:AAPL251219C00200000.
as_ofstring- Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today's date. Example: 2025-11-03.
polygon_options_contracts_listList options contracts, filtered by underlying ticker, contract type, expiration date, strike price, as-of date or expired status.Read-onlyList Options Contracts
List options contracts, filtered by underlying ticker, contract type, expiration date, strike price, as-of date or expired status. Returns contract ticker, underlying ticker, type, strike, expiration, exercise style and shares per contract, plus next_url. Use this to find contracts on an underlying. Use polygon_options_chain_snapshot_get for live prices of a chain.
Inputs
as_ofstring- Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today's date. Example: 2025-11-03.
contract_typestring- Query by the type of contract. One of: call, put. Example: call.one of
callput cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
expiration_datestring- Query by contract expiration with date format YYYY-MM-DD. Example: 2025-12-19.
expiration_date_gtestring- Return records with expiration date on or after (greater than or equal to) this value. Example: 2025-12-19.
expiration_date_ltestring- Return records with expiration date on or before (less than or equal to) this value. Example: 2025-12-19.
expiredboolean- Query for expired contracts. Default is false. Example: true.
limitinteger- Limit the number of results returned, default is 10 and max is 1000. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Example: asc.one of
ascdesc sortstring- Sort field used for ordering. One of: ticker, underlying_ticker, expiration_date, strike_price. Defaults to ticker. Example: expiration_date.one of
tickerunderlying_tickerexpiration_datestrike_price strike_pricenumber- Query by strike price of a contract. Example: 200.
strike_price_gtenumber- Return records with strike price on or after (greater than or equal to) this value. Example: 200.
strike_price_ltenumber- Return records with strike price on or before (less than or equal to) this value. Example: 200.
tickerstring- This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint here (https://massive.com/docs/rest/options/contracts/contract-overview). Example: AAPL.
underlying_tickerstring- Query for contracts relating to an underlying stock ticker. Example: AAPL.
polygon_previous_close_getGet the previous trading day's OHLC bar for any ticker (stocks, options, indices, forex or crypto).Read-onlyGet Previous Close
Get the previous trading day's OHLC bar for any ticker (stocks, options, indices, forex or crypto). Returns open, high, low, close, volume and VWAP. Use this for yesterday's close. Use polygon_aggregates_get for a longer range.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
adjustedboolean- 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. Example: true.
polygon_quotes_listList tick-level quotes (NBBO for stocks, BBO for forex, quotes for options), optionally limited to a timestamp or range.Read-onlyList Quotes
List tick-level quotes (NBBO for stocks, BBO for forex, quotes for options), optionally limited to a timestamp or range. Returns per quote the bid and ask price, size and exchange, conditions and timestamps, plus next_url. Use this for quote history. Use polygon_last_quote_get for the latest stock quote.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
limitinteger- Limit the number of results returned, default is 1000 and max is 50000. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc sortstring- Sort field used for ordering. One of: timestamp. Defaults to timestamp. Example: timestamp.one of
timestamp timestampstring- Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. Example: 2025-11-03.
timestamp_gtestring- Return records with timestamp on or after (greater than or equal to) this value. Example: 2025-11-03.
timestamp_ltestring- Return records with timestamp on or before (less than or equal to) this value. Example: 2025-11-03.
polygon_ratios_listList current valuation and financial ratios for stocks, filtered by ticker, CIK or metric values.Read-onlyList Financial Ratios
List current valuation and financial ratios for stocks, filtered by ticker, CIK or metric values. Returns price, market cap, P/E, P/B, P/S, EV/EBITDA, dividend yield, return on equity and assets, debt to equity, current and quick ratios and more. Use this to screen or compare valuations.
Inputs
average_volumenumber- Average trading volume over the last 30 trading days, providing context for liquidity. Value must be a floating point number. Example: 1.
cashnumber- Cash ratio, calculated as cash and cash equivalents divided by current liabilities, measuring the most liquid form of liquidity coverage. Value must be a floating point number. Example: 1.
cikstring- Central Index Key (CIK) number assigned by the SEC to identify the company. Example: 0000320193.
currentnumber- Current ratio, calculated as total current assets divided by total current liabilities, measuring short-term liquidity. Value must be a floating point number. Example: 1.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
debt_to_equitynumber- Debt-to-equity ratio, calculated as total debt (current debt plus long-term debt) divided by total shareholders' equity, measuring financial leverage. Value must be a floating point number. Example: 1.
dividend_yieldnumber- Dividend yield, calculated as annual dividends per share divided by stock price, measuring the income return on investment. Value must be a floating point number. Example: 1.
earnings_per_sharenumber- Earnings per share, calculated as trailing twelve months (TTM) net income available to common shareholders divided by point-in-time shares outstanding as of the price date, assuming all shares of other share classes are converted to this share class. This is not weighted average basic or diluted shares outstanding, so this value will not match the reported basic or diluted EPS on the income statements endpoint. Value must be a floating point number. Example: 1.
enterprise_valuenumber- Enterprise value, calculated as market capitalization plus total debt minus cash and cash equivalents, representing total company value. Value must be a floating point number. Example: 1.
ev_to_ebitdanumber- Enterprise value to EBITDA ratio, calculated as enterprise value divided by EBITDA, measuring company valuation relative to earnings before interest, taxes, depreciation, and amortization. Value must be a floating point number. Example: 1.
ev_to_salesnumber- Enterprise value to sales ratio, calculated as enterprise value divided by revenue, measuring company valuation relative to sales. Value must be a floating point number. Example: 1.
free_cash_flownumber- Free cash flow, calculated as operating cash flow minus capital expenditures (purchase of property, plant, and equipment). Value must be a floating point number. Example: 1.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
market_capnumber- Market capitalization, calculated as stock price multiplied by total shares outstanding. Value must be a floating point number. Example: 1.
pricenumber- Stock price used in ratio calculations, typically the closing price for the given date. Value must be a floating point number. Example: 200.
price_to_booknumber- Price-to-book ratio, calculated as stock price divided by book value per share, comparing market value to book value. Value must be a floating point number. Example: 1.
price_to_cash_flownumber- Price-to-cash-flow ratio, calculated as stock price divided by operating cash flow per share. Only calculated when operating cash flow per share is positive. Value must be a floating point number. Example: 1.
price_to_earningsnumber- Price-to-earnings ratio, calculated as stock price divided by earnings per share. Only calculated when earnings per share is positive. Value must be a floating point number. Example: 1.
price_to_free_cash_flownumber- Price-to-free-cash-flow ratio, calculated as stock price divided by free cash flow per share. Only calculated when free cash flow per share is positive. Value must be a floating point number. Example: 1.
price_to_salesnumber- Price-to-sales ratio, calculated as stock price divided by revenue per share, measuring valuation relative to sales. Value must be a floating point number. Example: 1.
quicknumber- Quick ratio (acid-test ratio), calculated as (current assets minus inventories) divided by current liabilities, measuring immediate liquidity. Value must be a floating point number. Example: 1.
return_on_assetsnumber- Return on assets ratio, calculated as net income divided by total assets, measuring how efficiently a company uses its assets to generate profit. Value must be a floating point number. Example: 1.
return_on_equitynumber- Return on equity ratio, calculated as net income divided by total shareholders' equity, measuring profitability relative to shareholders' equity. Value must be a floating point number. Example: 1.
sortstring- 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. Example: ticker.
tickerstring- Stock ticker symbol for the company. Example: AAPL.
polygon_risk_factors_listList the risk factors companies disclose in SEC filings, classified into a risk taxonomy, filtered by ticker, CIK or filing date.Read-onlyList Risk Factors
List the risk factors companies disclose in SEC filings, classified into a risk taxonomy, filtered by ticker, CIK or filing date. Returns filing date, ticker, the primary, secondary and tertiary risk category and the supporting text, plus next_url. Use this to review a company's disclosed risks.
Inputs
cikstring- SEC Central Index Key (10 digits, zero-padded). Example: 0000320193.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
filing_datestring- Date when the filing was submitted to the SEC (formatted as YYYY-MM-DD). Example: 2025-10-31.
filing_date_gtestring- Return records with filing date on or after (greater than or equal to) this value. Example: 2025-10-31.
filing_date_ltestring- Return records with filing date on or before (less than or equal to) this value. Example: 2025-10-31.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
sortstring- 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. Example: filing_date.desc.
tickerstring- Stock ticker symbol for the company. Example: AAPL.
polygon_short_interest_listList bi-monthly short interest for US stocks, filtered by ticker, days to cover or settlement date.Read-onlyList Short Interest
List bi-monthly short interest for US stocks, filtered by ticker, days to cover or settlement date. Returns settlement date, short interest, average daily volume and days to cover, plus next_url. Use this to gauge short positioning. Use polygon_short_volume_list for daily short sale volume.
Inputs
avg_daily_volumeinteger- The average daily trading volume for the stock over a specified period, typically used to contextualize short interest. Value must be an integer. Example: 1.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
days_to_covernumber- 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. Value must be a floating point number. Example: 1.5.
limitinteger- Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'. Example: 25.
settlement_datestring- The date (formatted as YYYY-MM-DD) on which the short interest data is considered settled, typically based on exchange reporting schedules. Example: 2025-10-15.
settlement_date_gtestring- Return records with settlement date on or after (greater than or equal to) this value. Example: 2025-10-15.
settlement_date_ltestring- Return records with settlement date on or before (less than or equal to) this value. Example: 2025-10-15.
sortstring- 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. Example: settlement_date.desc.
tickerstring- The primary ticker symbol for the stock. Example: AAPL.
polygon_short_volume_listList daily short sale volume for US stocks, filtered by ticker, date or short volume ratio.Read-onlyList Short Volume
List daily short sale volume for US stocks, filtered by ticker, date or short volume ratio. Returns total volume, short volume, exempt volume, the short volume ratio and per-venue breakdowns, plus next_url. Use this for daily short selling activity.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
datestring- The date of trade activity reported in the format YYYY-MM-DD. Example: 2025-11-03.
date_gtestring- Return records with date on or after (greater than or equal to) this value. Example: 2025-11-03.
date_ltestring- Return records with date on or before (less than or equal to) this value. Example: 2025-11-03.
limitinteger- Limit the maximum number of results returned. Defaults to '10' if not specified. The maximum allowed limit is '50000'. Example: 25.
short_volume_rationumber- The percentage of total volume that was sold short. Calculated as (short_volume / total_volume) * 100. Value must be a floating point number. Example: 0.4.
sortstring- 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. Example: date.desc.
tickerstring- The primary ticker symbol for the stock. Example: AAPL.
polygon_splits_listList historical stock splits for US stocks, filtered by ticker, execution date or adjustment type.Read-onlyList Stock Splits
List historical stock splits for US stocks, filtered by ticker, execution date or adjustment type. Returns ticker, execution date, split-from and split-to ratios, adjustment type and historical adjustment factor, plus next_url. Use this to adjust prices or check a stock's split history.
Inputs
adjustment_typestring- Classification of the share-change event. Possible values include: forward_split (share count increases), reverse_split (share count decreases), stock_dividend (shares issued as a dividend). One of: forward_split, reverse_split, stock_dividend. Example: forward_split.one of
forward_splitreverse_splitstock_dividend cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
execution_datestring- Date when the stock split takes effect. The adjustment is applied overnight. On the prior trading day, the post-market session is the last session that shows pre-split prices. On the execution date, all trading is already adjusted for the split. This includes the pre-market session. Value must be formatted 'yyyy-mm-dd'. Example: 2025-06-10.
execution_date_gtestring- Return records with execution date on or after (greater than or equal to) this value. Example: 2025-06-10.
execution_date_ltestring- Return records with execution date on or before (less than or equal to) this value. Example: 2025-06-10.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '5000'. Example: 25.
sortstring- 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. Example: execution_date.desc.
tickerstring- Stock symbol for the company that executed the split. Example: AAPL.
polygon_stock_snapshot_getGet the current snapshot of one US stock.Read-onlyGet Stock Snapshot
Get the current snapshot of one US stock. Returns the day and previous-day bars, latest minute bar, last trade and quote, and today's change and change percent. Use this for one stock's live picture.
Inputs
tickerstringrequired- Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. Example: AAPL.
polygon_stocks_movers_getGet the top 20 US stock gainers or losers of the day by percent change.Read-onlyGet Top Stock Movers
Get the top 20 US stock gainers or losers of the day by percent change. Returns snapshots for those tickers. Use this for today's biggest movers.
Inputs
directionstringrequired- The direction of the snapshot results to return. One of: gainers, losers. Example: gainers.one of
gainerslosers include_otcboolean- Include OTC securities in the response. Default is false (don't include OTC securities). Example: true.
polygon_stocks_snapshot_listGet current snapshots for all US stocks, or for a list of tickers.Read-onlyList Stock Snapshots
Get current snapshots for all US stocks, or for a list of tickers. Returns per ticker the day and previous-day bars, minute bar, last trade and quote, and today's change and change percent. Use this to scan the market. Use polygon_stock_snapshot_get for one ticker.
Inputs
include_otcboolean- Include OTC securities in the response. Default is false (don't include OTC securities). Example: true.
tickersstring- Comma-separated stock tickers to include; leave empty for all tickers. Example: ["AAPL","MSFT"].
polygon_ticker_events_getGet the timeline of events for a ticker, CUSIP or Composite FIGI, such as ticker symbol changes.Read-onlyGet Ticker Events
Get the timeline of events for a ticker, CUSIP or Composite FIGI, such as ticker symbol changes. Returns the entity name and a list of dated events. Use this to trace a company's past symbols.
Inputs
idstringrequired- A ticker symbol, CUSIP or Composite FIGI. Example: AAPL.
typesstring- 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. Example: ticker_change.
polygon_ticker_getGet the details of one ticker, optionally as of a past date.Read-onlyGet Ticker Details
Get the details of one ticker, optionally as of a past date. Returns the company name, description, market cap, share counts, SIC code, homepage, address, listing date and branding image URLs. Use this for one known symbol. Use polygon_tickers_list to search.
Inputs
tickerstringrequired- Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc. Example: AAPL.
datestring- Specify a point in time to get information about the ticker available on that date. Fields that describe the security, including name, type, primary_exchange and list_date, reflect the security trading under this ticker on that date. For example, ASND returns type ADRC and list_date 2015-01-28 for 2026-04-17, and type CS and list_date 2026-04-20 from 2026-04-20, when its American Depositary Shares were exchanged for ordinary shares. Some fields may be empty for older dates. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing. For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing. Defaults to the most recent available date. Example: 2025-11-03.
polygon_ticker_types_listList the ticker type codes Massive uses (CS common stock, ETF, ADRC and so on), optionally for one asset class or locale.Read-onlyList Ticker Types
List the ticker type codes Massive uses (CS common stock, ETF, ADRC and so on), optionally for one asset class or locale. Returns code, description, asset class and locale. Use this to pick a type filter for polygon_tickers_list.
Inputs
asset_classstring- Filter by asset class. One of: stocks, options, crypto, fx, indices. Example: stocks.one of
stocksoptionscryptofxindices localestring- Filter by locale. One of: us, global. Example: us.one of
usglobal
polygon_tickers_listList ticker symbols across stocks, OTC, indices, forex and crypto, filtered by symbol, type, market, exchange, CUSIP, CIK or a name search.Read-onlyList Tickers
List ticker symbols across stocks, OTC, indices, forex and crypto, filtered by symbol, type, market, exchange, CUSIP, CIK or a name search. Returns ticker, name, market, locale, primary exchange, type, active flag and currency, plus next_url for paging. Use this to find a symbol. Use polygon_ticker_get for one company's details.
Inputs
activeboolean- Specify if the tickers returned should be actively traded on the queried date. Default is true. Example: true.
cikstring- Specify the CIK of the asset you want to search for. Find more information about CIK codes at their website (https://www.sec.gov/edgar/searchedgar/cik.htm). Defaults to empty string which queries all CIKs. Example: 0000320193.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
cusipstring- Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes at their website (https://www.cusip.com/identifiers.html#/CUSIP). Defaults to empty string which queries all CUSIPs. Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response. Example: 037833100.
datestring- Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date. Example: 2025-11-03.
exchangestring- Specify the asset's primary exchange Market Identifier Code (MIC) according to ISO 10383 (https://www.iso20022.org/market-identifier-codes). Defaults to empty string which queries all exchanges. Example: XNAS.
limitinteger- Limit the number of results returned, default is 100 and max is 1000. Example: 25.
marketstring- Filter by market type. By default all markets are included. One of: stocks, crypto, fx, otc, indices. Example: stocks.one of
stockscryptofxotcindices orderstring- Order results based on the sort field. One of: asc, desc. Example: asc.one of
ascdesc searchstring- Search for terms within the ticker and/or company name. Example: Apple.
sortstring- Sort field used for ordering. One of: ticker, name, market, locale, primary_exchange, type, currency_symbol, currency_name, base_currency_symbol, base_currency_name, cik, composite_figi, share_class_figi, last_updated_utc, delisted_utc. Defaults to ticker. Example: ticker.one of
tickernamemarketlocaleprimary_exchangetypecurrency_symbolcurrency_namebase_currency_symbolbase_currency_namecikcomposite_figishare_class_figilast_updated_utcdelisted_utc tickerstring- Specify a ticker symbol. Defaults to empty string which queries all tickers. Example: AAPL.
typestring- Specify the type of the tickers. Find the types that we support via our Ticker Types API (https://massive.com/docs/rest/stocks/tickers/ticker-types). Defaults to empty string which queries all types. One of: CS, ADRC, ADRP, ADRR, UNIT, RIGHT, PFD, FUND, SP, WARRANT, INDEX, ETF, ETN, OS, GDR, OTHER, NYRS, AGEN, EQLK, BOND, ADRW, BASKET, LT. Example: CS.one of
CSADRCADRPADRRUNITRIGHTPFDFUNDSPWARRANTINDEXETFETNOSGDROTHERNYRSAGENEQLKBONDADRWBASKETLT
polygon_trades_listList tick-level trades for a stock, option or crypto ticker, optionally limited to a timestamp or range.Read-onlyList Trades
List tick-level trades for a stock, option or crypto ticker, optionally limited to a timestamp or range. Returns per trade the price, size, exchange, conditions, SIP and participant timestamps, plus next_url. Use this for individual trades. Use polygon_aggregates_get for bars.
Inputs
tickerstringrequired- Ticker symbol, case-sensitive. Stocks use the plain symbol (AAPL); options use O: (O:AAPL251219C00200000), indices I: (I:SPX), forex C: (C:EURUSD) and crypto X: (X:BTCUSD). Example: AAPL.
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
limitinteger- Limit the number of results returned, default is 1000 and max is 50000. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Defaults to desc. Example: desc.one of
ascdesc sortstring- Sort field used for ordering. One of: timestamp. Defaults to timestamp. Example: timestamp.one of
timestamp timestampstring- Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp. Example: 2025-11-03.
timestamp_gtestring- Return records with timestamp on or after (greater than or equal to) this value. Example: 2025-11-03.
timestamp_ltestring- Return records with timestamp on or before (less than or equal to) this value. Example: 2025-11-03.
polygon_treasury_yields_listList daily US Treasury yields across maturities (1 month to 30 years), filtered by date.Read-onlyList Treasury Yields
List daily US Treasury yields across maturities (1 month to 30 years), filtered by date. Returns date and the yield for each maturity, plus next_url. Use this for interest rate history.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
datestring- Calendar date of the yield observation (YYYY-MM-DD). Example: 2025-11-03.
date_gtestring- Return records with date on or after (greater than or equal to) this value. Example: 2025-11-03.
date_ltestring- Return records with date on or before (less than or equal to) this value. Example: 2025-11-03.
limitinteger- Limit the maximum number of results returned. Defaults to '100' if not specified. The maximum allowed limit is '50000'. Example: 25.
sortstring- A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'date' if not specified. The sort order defaults to 'asc' if not specified. Example: date.desc.
polygon_universal_snapshot_getGet snapshots for tickers across asset classes (stocks, options, indices, forex, crypto) in one call, by ticker, list of tickers or type.Read-onlyGet Universal Snapshot
Get snapshots for tickers across asset classes (stocks, options, indices, forex, crypto) in one call, by ticker, list of tickers or type. Returns, per ticker, the last trade and quote, current session OHLC and change, and for options the greeks, implied volatility and open interest. Use this to compare mixed assets at once.
Inputs
cursorstring- Pagination cursor. Copy the cursor value from the next_url returned by the previous call to get the next page. Example: YXA9MjAyNS0xMS0wMyZhcz0mbGltaXQ9MjU.
limitinteger- Limit the number of results returned, default is 10 and max is 250. Example: 25.
orderstring- Order results based on the sort field. One of: asc, desc. Example: asc.one of
ascdesc sortstring- Sort field used for ordering. One of: ticker. Defaults to ticker. Example: ticker.one of
ticker tickerstring- Specify a single ticker symbol. Ticker symbols are case-sensitive and use a prefix for non-stock assets, for example NVDA for stocks, O:SPY280121C00750000 for options, C:EURUSD for forex, X:BTCUSD for crypto, and I:SPX for indices. To request more than one ticker or a range of tickers, expand the filter modifiers. Example: AAPL.
ticker_any_ofstring- Comma-separated list of up to 250 tickers to snapshot. Example: AAPL,O:AAPL251219C00200000,X:BTCUSD.
typestring- Query by the type of asset. One of: stocks, options, crypto, fx, indices. Example: stocks.one of
stocksoptionscryptofxindices
No tools match.