Options API Documentation
The Polygon.io Stock Options API provides REST endpoints that let you query the latest market data from all US options exchanges. You can find data on active and historical options contracts, greeks, implied volatility, and more.
Authentication
Pass your API key in the query string like follows:
Alternatively, you can add an Authorization header to the request with your API Key as the token in the following form:
Usage
Many of Polygon.io's REST endpoints allow you to extend query parameters with inequalities like date.lt=2023-01-01 (less than) and date.gte=2023-01-01 (greater than or equal to) to search ranges of values. You can also use the field name without any extension to query for exact equality. Fields that support extensions will have an "Additional filter parameters" dropdown beneath them in the docs that detail the supported extensions for that parameter.
Response Types
By default, all endpoints return a JSON response. Users with Options Starter plan and above can request a CSV response by including 'Accept': 'text/csv' as a request parameter.
Aggregates (Bars)
Get aggregate bars for an option contract over a given date range in custom time window sizes.
For example, if timespan = ‘minute’ and multiplier = ‘5’ then 5-minute bars will be returned.
The ticker symbol of the options contract.
The size of the timespan multiplier.
The size of the time window.
The start of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
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.
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).
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 Aggregate Data API Improvements.
The exchange symbol that this item is traded under.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
A request id assigned by the server.
The total number of results for this request.
The status of this request's response.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
{
"adjusted": true,
"count": 2,
"queryCount": 2,
"request_id": "5585acde-5085-42d6-95b2-2e388a28370a",
"results": [
{
"c": 26.2,
"h": 26.2,
"l": 26.2,
"n": 1,
"o": 26.2,
"t": 1632369600000,
"v": 2,
"vw": 26.2
},
{
"c": 28.3,
"h": 28.3,
"l": 28.3,
"n": 1,
"o": 28.3,
"t": 1632456000000,
"v": 2,
"vw": 28.3
}
],
"resultsCount": 2,
"status": "OK",
"ticker": "O:RDFN211119C00025000"
}Daily Open/Close
Get the open, close and afterhours prices of an options contract on a certain date.
The ticker symbol of the options contract.
The date of the requested open/close in the format YYYY-MM-DD.
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.
The close price of the ticker symbol in after hours trading.
The close price for the symbol in the given time period.
The requested date.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The open price of the ticker symbol in pre-market trading.
The status of this request's response.
The exchange symbol that this item is traded under.
The trading volume of the symbol in the given time period.
{
"afterHours": 26.35,
"close": 26.35,
"from": "2023-01-09",
"high": 26.35,
"low": 25,
"open": 25,
"preMarket": 25,
"status": "OK",
"symbol": "O:TSLA210903C00700000",
"volume": 2
}Previous Close
Get the previous day's open, high, low, and close (OHLC) for the specified option contract.
The ticker symbol of the options contract.
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.
The exchange symbol that this item is traded under.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
A request id assigned by the server.
The total number of results for this request.
The status of this request's response.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
{
"adjusted": true,
"queryCount": 1,
"request_id": "6a7e466379af0a71039d60cc78e72282",
"results": [
{
"T": "O:TSLA210903C00700000",
"c": 115.97,
"h": 117.59,
"l": 114.13,
"n": 2,
"o": 115.55,
"t": 1605042000000,
"v": 131704427,
"vw": 116.3058
}
],
"resultsCount": 1,
"status": "OK",
"ticker": "O:TSLA210903C00700000"
}The options ticker symbol to get trades for.
Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 50000.
Sort field used for ordering.
If present, this value can be used to fetch the next page of data.
A list of condition codes.
The trade correction indicator.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the trade was actually generated at the exchange.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.
The size of a trade (also known as volume).
The status of this request's response.
{
"next_url": "https://api.polygon.io/v3/trades/O:AZO140621P00530000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": [
{
"exchange": 46,
"participant_timestamp": 1401715883806000000,
"price": 6.91,
"sip_timestamp": 1401715883806000000,
"size": 1
},
{
"conditions": [
209
],
"exchange": 67,
"participant_timestamp": 1401716547786000000,
"price": 7.2,
"sip_timestamp": 1401716547786000000,
"size": 1
}
],
"status": "OK"
}The ticker symbol of the options contract.
A request id assigned by the server.
The exchange symbol that this item is traded under.
A list of condition codes.
The trade correction indicator.
The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.
The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The sequence number represents the sequence in which message events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
The ID for the Trade Reporting Facility where the trade took place.
The size of a trade (also known as volume).
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.
There are 3 tapes which define which exchange the ticker is listed on. These are integers in our objects which represent the letter of the alphabet. Eg: 1 = A, 2 = B, 3 = C.
- Tape A is NYSE listed securities
- Tape B is NYSE ARCA / NYSE American
- Tape C is NASDAQ
The status of this request's response.
{
"request_id": "f05562305bd26ced64b98ed68b3c5d96",
"results": {
"T": "O:TSLA210903C00700000",
"c": [
227
],
"f": 1617901342969796400,
"i": "",
"p": 115.55,
"q": 1325541950,
"r": 202,
"s": 25,
"t": 1617901342969834000,
"x": 312
},
"status": "OK"
}The ticker symbol to get quotes for.
Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 50000.
Sort field used for ordering.
If present, this value can be used to fetch the next page of data.
The ask exchange ID
The ask price.
The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.
The bid exchange ID
The bid price.
The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.
The sequence number represents the sequence in which quote events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this quote from the exchange which produced it.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v3/quotes/O:SPY241220P00720000?cursor=YXA9NzY5Nzg0NzAxJmFzPSZsaW1pdD0xMCZvcmRlcj1kZXNjJnNvcnQ9dGltZXN0YW1wJnRpbWVzdGFtcC5sdGU9MjAyMi0wMi0xN1QxNyUzQTI1JTNBMTMuMDA5MzU2MDMyWg",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": [
{
"ask_exchange": 323,
"ask_price": 282,
"ask_size": 10,
"bid_exchange": 316,
"bid_price": 277.5,
"bid_size": 1,
"sequence_number": 789539218,
"sip_timestamp": 1645119125346243600
},
{
"ask_exchange": 301,
"ask_price": 282,
"ask_size": 1,
"bid_exchange": 323,
"bid_price": 277.5,
"bid_size": 10,
"sequence_number": 788994206,
"sip_timestamp": 1645119118474271000
}
],
"status": "OK"
}Option Contract
Get the snapshot of an option contract for a stock equity.
The underlying ticker symbol of the option contract.
The option contract identifier.
If present, this value can be used to fetch the next page of data.
The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).
The most recent daily bar for this contract.
The value of the price change for the contract from the previous trading day.
The percent of the price change for the contract from the previous trading day.
The closing price for the contract of the day.
The highest price for the contract of the day.
The nanosecond timestamp of when this information was updated.
The lowest price for the contract of the day.
The open price for the contract of the day.
The closing price for the contract of previous trading day.
The trading volume for the contract of the day.
The trading volume weighted average price for the contract of the day.
The details for this contract.
The type of contract. Can be "put", "call", or in some rare cases, "other".
The exercise style of this contract. See this link for more details on exercise styles.
The contract's expiration date in YYYY-MM-DD format.
The number of shares per contract for this contract.
The strike price of the option contract.
The ticker symbol for the asset.
The greeks for this contract. This is only returned if your current plan includes greeks.
The change in the option's price per $0.01 increment in the price of the underlying asset.
The change in delta per $0.01 change in the price of the underlying asset.
The change in the option's price per day.
The change in the option's price per 1% increment in volatility.
The market's forecast for the volatility of the underlying asset, based on this option's current price.
The most recent quote for this contract. This is only returned if your current plan includes quotes.
The ask price.
The ask size.
The bid price.
The bid size.
The nanosecond timestamp of when this information was updated.
The average of the bid and ask price.
The time relevance of the data.
The most recent trade for this contract. This is only returned if your current plan includes trades.
A list of condition codes.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.
The size of a trade (also known as volume).
The time relevance of the data.
The quantity of this contract held at the end of the last trading day.
Information on the underlying stock for this options contract. The market data returned depends on your current stocks plan.
The change in price for the contract to break even.
The nanosecond timestamp of when this information was updated.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The ticker symbol for the contract's underlying asset.
The time relevance of the data.
The value of the underlying index.
The status of this request's response.
{
"request_id": "d9ff18dac69f55c218f69e4753706acd",
"results": {
"break_even_price": 171.075,
"day": {
"change": -1.05,
"change_percent": -4.67,
"close": 21.4,
"high": 22.49,
"last_updated": 1636520400000000000,
"low": 21.35,
"open": 22.49,
"previous_close": 22.45,
"volume": 37,
"vwap": 21.6741
},
"details": {
"contract_type": "call",
"exercise_style": "american",
"expiration_date": "2023-06-16",
"shares_per_contract": 100,
"strike_price": 150,
"ticker": "O:AAPL230616C00150000"
},
"greeks": {
"delta": 0.5520187372272933,
"gamma": 0.00706756515659829,
"theta": -0.018532772783847958,
"vega": 0.7274811132998142
},
"implied_volatility": 0.3048997097864957,
"last_quote": {
"ask": 21.25,
"ask_size": 110,
"bid": 20.9,
"bid_size": 172,
"last_updated": 1636573458756383500,
"midpoint": 21.075,
"timeframe": "REAL-TIME"
},
"last_trade": {
"conditions": [
209
],
"exchange": 316,
"price": 0.05,
"sip_timestamp": 1675280958783136800,
"size": 2,
"timeframe": "REAL-TIME"
},
"open_interest": 8921,
"underlying_asset": {
"change_to_break_even": 23.123999999999995,
"last_updated": 1636573459862384600,
"price": 147.951,
"ticker": "AAPL",
"timeframe": "REAL-TIME"
}
},
"status": "OK"
}Options Chain
Get the snapshot of all options contracts for an underlying ticker.
The underlying ticker symbol of the option contract.
Query by strike price of a contract.
Query by contract expiration with date format YYYY-MM-DD.
Query by the type of contract.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 250.
Sort field used for ordering.
If present, this value can be used to fetch the next page of data.
The price of the underlying asset for the contract to break even. For a call, this value is (strike price + premium paid). For a put, this value is (strike price - premium paid).
The most recent daily bar for this contract.
The value of the price change for the contract from the previous trading day.
The percent of the price change for the contract from the previous trading day.
The closing price for the contract of the day.
The highest price for the contract of the day.
The nanosecond timestamp of when this information was updated.
The lowest price for the contract of the day.
The open price for the contract of the day.
The closing price for the contract of previous trading day.
The trading volume for the contract of the day.
The trading volume weighted average price for the contract of the day.
The details for this contract.
The type of contract. Can be "put", "call", or in some rare cases, "other".
The exercise style of this contract. See this link for more details on exercise styles.
The contract's expiration date in YYYY-MM-DD format.
The number of shares per contract for this contract.
The strike price of the option contract.
The ticker symbol for the asset.
The greeks for this contract. This is only returned if your current plan includes greeks.
The change in the option's price per $0.01 increment in the price of the underlying asset.
The change in delta per $0.01 change in the price of the underlying asset.
The change in the option's price per day.
The change in the option's price per 1% increment in volatility.
The market's forecast for the volatility of the underlying asset, based on this option's current price.
The most recent quote for this contract. This is only returned if your current plan includes quotes.
The ask price.
The ask size.
The bid price.
The bid size.
The nanosecond timestamp of when this information was updated.
The average of the bid and ask price.
The time relevance of the data.
The most recent trade for this contract. This is only returned if your current plan includes trades.
A list of condition codes.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this trade from the exchange which produced it.
The size of a trade (also known as volume).
The time relevance of the data.
The quantity of this contract held at the end of the last trading day.
Information on the underlying stock for this options contract. The market data returned depends on your current stocks plan.
The change in price for the contract to break even.
The nanosecond timestamp of when this information was updated.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The ticker symbol for the contract's underlying asset.
The time relevance of the data.
The value of the underlying index.
The status of this request's response.
{
"request_id": "6a7e466379af0a71039d60cc78e72282",
"results": [
{
"break_even_price": 151.2,
"day": {
"change": 4.5,
"change_percent": 6.76,
"close": 120.73,
"high": 120.81,
"last_updated": 1605195918507251700,
"low": 118.9,
"open": 119.32,
"previous_close": 119.12,
"volume": 868,
"vwap": 119.31
},
"details": {
"contract_type": "call",
"exercise_style": "american",
"expiration_date": "2022-01-21",
"shares_per_contract": 100,
"strike_price": 150,
"ticker": "O:AAPL211022C000150000"
},
"greeks": {
"delta": 1,
"gamma": 0,
"theta": 0.00229,
"vega": 0
},
"implied_volatility": 5,
"last_quote": {
"ask": 120.3,
"ask_size": 4,
"bid": 120.28,
"bid_size": 8,
"last_updated": 1605195918507251700,
"midpoint": 120.29
},
"last_trade": {
"conditions": [
209
],
"exchange": 316,
"price": 0.05,
"sip_timestamp": 1675280958783136800,
"size": 2,
"timeframe": "REAL-TIME"
},
"open_interest": 1543,
"underlying_asset": {
"change_to_break_even": 4.2,
"last_updated": 1605195918507251700,
"price": 147,
"ticker": "AAPL",
"timeframe": "DELAYED"
}
}
],
"status": "OK"
}Simple Moving Average (SMA)
Get the simple moving average (SMA) for a ticker symbol over a given time range.
The ticker symbol for which to get simple moving average (SMA) data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
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.
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.
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).
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/sma/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"aggregates": [
{
"c": 75.0875,
"h": 75.15,
"l": 73.7975,
"n": 1,
"o": 74.06,
"t": 1577941200000,
"v": 135647456,
"vw": 74.6099
},
{
"c": 74.3575,
"h": 75.145,
"l": 74.125,
"n": 1,
"o": 74.2875,
"t": 1578027600000,
"v": 146535512,
"vw": 74.7026
}
],
"url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"timestamp": 1517562000016,
"value": 140.139
}
]
},
"status": "OK"
}Exponential Moving Average (EMA)
Get the exponential moving average (EMA) for a ticker symbol over a given time range.
The ticker symbol for which to get exponential moving average (EMA) data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
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.
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.
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).
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/ema/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"timestamp": 1517562000016,
"value": 140.139
}
]
},
"status": "OK"
}Moving Average Convergence/Divergence (MACD)
Get moving average convergence/divergence (MACD) for a ticker symbol over a given time range.
The ticker symbol for which to get MACD data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
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.
The short window size used to calculate MACD data.
The long window size used to calculate MACD data.
The window size used to calculate the MACD signal line.
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.
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The indicator value for this period.
The indicator value for this period.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/macd/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"histogram": 38.3801666667,
"signal": 106.9811666667,
"timestamp": 1517562000016,
"value": 145.3613333333
},
{
"histogram": 41.098859136,
"signal": 102.7386283473,
"timestamp": 1517562001016,
"value": 143.8374874833
}
]
},
"status": "OK"
}Relative Strength Index (RSI)
Get the relative strength index (RSI) for a ticker symbol over a given time range.
The ticker symbol for which to get relative strength index (RSI) data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
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.
The window size used to calculate the relative strength index (RSI).
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).
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/rsi/O:SPY241220P00720000?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"url": "https://api.polygon.io/v2/aggs/ticker/O:SPY241220P00720000/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"timestamp": 1517562000016,
"value": 140.139
}
]
},
"status": "OK"
}Query for a contract by options ticker. You can learn more about the structure of options tickers here.
Specify a point in time for the contract as of this date with format YYYY-MM-DD. Defaults to today's date.
If an option contract has additional underlyings or deliverables associated with it, they will appear here. See here for some examples of what might cause a contract to have additional underlyings.
The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency.
The type of the additional underlying asset, either equity or currency.
The name of the additional underlying asset.
The 6 letter CFI code of the contract (defined in ISO 10962)
The type of contract. Can be "put", "call", or in some rare cases, "other".
The correction number for this option contract.
The exercise style of this contract. See this link for more details on exercise styles.
The contract's expiration date in YYYY-MM-DD format.
The MIC code of the primary exchange that this contract is listed on.
The number of shares per contract for this contract.
The strike price of the option contract.
The ticker for the option contract.
The underlying ticker that the option contract relates to.
{
"request_id": "603902c0-a5a5-406f-bd08-f030f92418fa",
"results": {
"additional_underlyings": [
{
"amount": 44,
"type": "equity",
"underlying": "VMW"
},
{
"amount": 6.53,
"type": "currency",
"underlying": "USD"
}
],
"cfi": "OCASPS",
"contract_type": "call",
"exercise_style": "american",
"expiration_date": "2021-11-19",
"primary_exchange": "BATO",
"shares_per_contract": 100,
"strike_price": 85,
"ticker": "O:AAPL211119C00085000",
"underlying_ticker": "AAPL"
},
"status": "OK"
}Options Contracts
Query for historical options contracts. This provides both active and expired options contracts.
This parameter has been deprecated. To search by specific options ticker, use the Options Contract endpoint here.
Query for contracts relating to an underlying stock ticker.
Query by the type of contract.
Query by contract expiration with date format YYYY-MM-DD.
Specify a point in time for contracts as of this date with format YYYY-MM-DD. Defaults to today's date.
Query by strike price of a contract.
Query for expired contracts. Default is false.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 1000.
Sort field used for ordering.
If present, this value can be used to fetch the next page of data.
If an option contract has additional underlyings or deliverables associated with it, they will appear here. See here for some examples of what might cause a contract to have additional underlyings.
The number of shares per contract of the additional underlying, or the cash-in-lieu amount of the currency.
The type of the additional underlying asset, either equity or currency.
The name of the additional underlying asset.
The 6 letter CFI code of the contract (defined in ISO 10962)
The type of contract. Can be "put", "call", or in some rare cases, "other".
The correction number for this option contract.
The exercise style of this contract. See this link for more details on exercise styles.
The contract's expiration date in YYYY-MM-DD format.
The MIC code of the primary exchange that this contract is listed on.
The number of shares per contract for this contract.
The strike price of the option contract.
The ticker for the option contract.
The underlying ticker that the option contract relates to.
{
"request_id": "603902c0-a5a5-406f-bd08-f030f92418fa",
"results": [
{
"cfi": "OCASPS",
"contract_type": "call",
"exercise_style": "american",
"expiration_date": "2021-11-19",
"primary_exchange": "BATO",
"shares_per_contract": 100,
"strike_price": 85,
"ticker": "O:AAPL211119C00085000",
"underlying_ticker": "AAPL"
},
{
"additional_underlyings": [
{
"amount": 44,
"type": "equity",
"underlying": "VMW"
},
{
"amount": 6.53,
"type": "currency",
"underlying": "USD"
}
],
"cfi": "OCASPS",
"contract_type": "call",
"exercise_style": "american",
"expiration_date": "2021-11-19",
"primary_exchange": "BATO",
"shares_per_contract": 100,
"strike_price": 90,
"ticker": "O:AAPL211119C00090000",
"underlying_ticker": "AAPL"
}
],
"status": "OK"
}Tickers
Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Indices, Forex, and Crypto.
Specify a ticker symbol. Defaults to empty string which queries all tickers.
Specify the type of the tickers. Find the types that we support via our Ticker Types API. Defaults to empty string which queries all types.
Filter by market type. By default all markets are included.
Specify the primary exchange of the asset in the ISO code format. Find more information about the ISO codes at the ISO org website. Defaults to empty string which queries all exchanges.
Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes at their website. 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.
Specify the CIK of the asset you want to search for. Find more information about CIK codes at their website. Defaults to empty string which queries all CIKs.
Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date.
Search for terms within the ticker and/or company name.
Specify if the tickers returned should be actively traded on the queried date. Default is true.
Order results based on the sort field.
Limit the number of results returned, default is 100 and max is 1000.
Sort field used for ordering.
The total number of results for this request.
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
An array of tickers that match your query.
Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.
Whether or not the asset is actively traded. False means the asset has been delisted.
The CIK number for this ticker. Find more information here.
The composite OpenFIGI number for this ticker. Find more information here
The name of the currency that this asset is traded with.
The last date that the asset was traded.
The information is accurate up to this time.
The locale of the asset.
The market type of the asset.
The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.
The ISO code of the primary listing exchange for this asset.
The share Class OpenFIGI number for this ticker. Find more information here
The exchange symbol that this item is traded under.
The type of the asset. Find the types that we support via our Ticker Types API.
The status of this request's response.
{
"count": 1,
"next_url": "https://api.polygon.io/v3/reference/tickers?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "e70013d92930de90e089dc8fa098888e",
"results": [
{
"active": true,
"cik": "0001090872",
"composite_figi": "BBG000BWQYZ5",
"currency_name": "usd",
"last_updated_utc": "2021-04-25T00:00:00Z",
"locale": "us",
"market": "stocks",
"name": "Agilent Technologies Inc.",
"primary_exchange": "XNYS",
"share_class_figi": "BBG001SCTQY4",
"ticker": "A",
"type": "CS"
}
],
"status": "OK"
}Ticker Details v3
Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it.
The ticker symbol of the asset.
Specify a point in time to get information about the ticker available on that date. 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.
The total number of results for this request.
A request id assigned by the server.
Ticker with details.
Whether or not the asset is actively traded. False means the asset has been delisted.
The first line of the company's headquarters address.
The city of the company's headquarters address.
The postal code of the company's headquarters address.
The state of the company's headquarters address.
A link to this ticker's company's icon. Icon's are generally smaller, square images that represent the company at a glance. Note that you must provide an API key when accessing this URL. See the "Authentication" section at the top of this page for more details.
A link to this ticker's company's logo. Note that you must provide an API key when accessing this URL. See the "Authentication" section at the top of this page for more details.
The CIK number for this ticker. Find more information here.
The composite OpenFIGI number for this ticker. Find more information here
The name of the currency that this asset is traded with.
The last date that the asset was traded.
A description of the company and what they do/offer.
The URL of the company's website homepage.
The date that the symbol was first publicly listed in the format YYYY-MM-DD.
The locale of the asset.
The market type of the asset.
The most recent close price of the ticker multiplied by weighted outstanding shares.
The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.
The phone number for the company behind this ticker.
The ISO code of the primary listing exchange for this asset.
Round lot size of this security.
The share Class OpenFIGI number for this ticker. Find more information here
The recorded number of outstanding shares for this particular share class.
The standard industrial classification code for this ticker. For a list of SIC Codes, see the SEC's SIC Code List.
A description of this ticker's SIC code.
The exchange symbol that this item is traded under.
The root of a specified ticker. For example, the root of BRK.A is BRK.
The suffix of a specified ticker. For example, the suffix of BRK.A is A.
The approximate number of employees for the company.
The type of the asset. Find the types that we support via our Ticker Types API.
The shares outstanding calculated assuming all shares of other share classes are converted to this share class.
The status of this request's response.
{
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"results": {
"active": true,
"address": {
"address1": "One Apple Park Way",
"city": "Cupertino",
"postal_code": "95014",
"state": "CA"
},
"branding": {
"icon_url": "https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_icon.png",
"logo_url": "https://api.polygon.io/v1/reference/company-branding/d3d3LmFwcGxlLmNvbQ/images/2022-01-10_logo.svg"
},
"cik": "0000320193",
"composite_figi": "BBG000B9XRY4",
"currency_name": "usd",
"description": "Apple designs a wide variety of consumer electronic devices, including smartphones (iPhone), tablets (iPad), PCs (Mac), smartwatches (Apple Watch), AirPods, and TV boxes (Apple TV), among others. The iPhone makes up the majority of Apple's total revenue. In addition, Apple offers its customers a variety of services such as Apple Music, iCloud, Apple Care, Apple TV+, Apple Arcade, Apple Card, and Apple Pay, among others. Apple's products run internally developed software and semiconductors, and the firm is well known for its integration of hardware, software and services. Apple's products are distributed online as well as through company-owned stores and third-party retailers. The company generates roughly 40% of its revenue from the Americas, with the remainder earned internationally.",
"homepage_url": "https://www.apple.com",
"list_date": "1980-12-12",
"locale": "us",
"market": "stocks",
"market_cap": 2771126040150,
"name": "Apple Inc.",
"phone_number": "(408) 996-1010",
"primary_exchange": "XNAS",
"round_lot": 100,
"share_class_figi": "BBG001S5N8V8",
"share_class_shares_outstanding": 16406400000,
"sic_code": "3571",
"sic_description": "ELECTRONIC COMPUTERS",
"ticker": "AAPL",
"ticker_root": "AAPL",
"total_employees": 154000,
"type": "CS",
"weighted_shares_outstanding": 16334371000
},
"status": "OK"
}Ticker News
Get the most recent news articles relating to a stock ticker symbol, including a summary of the article and a link to the original source.
Return results that contain this ticker.
Return results published on, before, or after this date.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 1000.
Sort field used for ordering.
The total number of results for this request.
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The mobile friendly Accelerated Mobile Page (AMP) URL.
A link to the news article.
The article's author.
A description of the article.
Unique identifier for the article.
The article's image URL.
The keywords associated with the article (which will vary depending on the publishing source).
The date the article was published on.
The publisher's homepage favicon URL.
The publisher's homepage URL.
The publisher's logo URL.
The publisher's name.
The ticker symbols associated with the article.
The title of the news article.
The status of this request's response.
{
"count": 1,
"next_url": "https://api.polygon.io:443/v2/reference/news?cursor=eyJsaW1pdCI6MSwic29ydCI6InB1Ymxpc2hlZF91dGMiLCJvcmRlciI6ImFzY2VuZGluZyIsInRpY2tlciI6e30sInB1Ymxpc2hlZF91dGMiOnsiZ3RlIjoiMjAyMS0wNC0yNiJ9LCJzZWFyY2hfYWZ0ZXIiOlsxNjE5NDA0Mzk3MDAwLG51bGxdfQ",
"request_id": "831afdb0b8078549fed053476984947a",
"results": [
{
"amp_url": "https://amp.benzinga.com/amp/content/20784086",
"article_url": "https://www.benzinga.com/markets/cryptocurrency/21/04/20784086/cathie-wood-adds-more-coinbase-skillz-trims-square",
"author": "Rachit Vats",
"description": "<p>Cathie Wood-led Ark Investment Management on Friday snapped up another 221,167 shares of the cryptocurrency exchange <strong>Coinbase Global Inc </strong>(NASDAQ <a class=\"ticker\" href=\"https://www.benzinga.com/stock/coin#NASDAQ\">COIN</a>) worth about $64.49 million on the stock’s Friday’s dip and also its fourth-straight loss.</p>\n<p>The investment firm’s <strong>Ark Innovation ETF</strong> (NYSE <a class=\" ticker\" href=\"https://www.benzinga.com/stock/arkk#NYSE\">ARKK</a>) bought the shares of the company that closed 0.63% lower at $291.60 on Friday, giving the cryptocurrency exchange a market cap of $58.09 billion. Coinbase’s market cap has dropped from $85.8 billion on its blockbuster listing earlier this month.</p>\n<p>The New York-based company also added another 3,873 shares of the mobile gaming company <strong>Skillz Inc</strong> (NYSE <a class=\" ticker\" href=\"https://www.benzinga.com/stock/sklz#NYSE\">SKLZ</a>), <a href=\"http://www.benzinga.com/markets/cryptocurrency/21/04/20762794/cathie-woods-ark-loads-up-another-1-2-million-shares-in-skillz-also-adds-coinbase-draftkin\" >just a day after</a> snapping 1.2 million shares of the stock.</p>\n <p>ARKK bought the shares of the company which closed ...</p><p><a href=https://www.benzinga.com/markets/cryptocurrency/21/04/20784086/cathie-wood-adds-more-coinbase-skillz-trims-square alt=Cathie Wood Adds More Coinbase, Skillz, Trims Square>Full story available on Benzinga.com</a></p>",
"id": "nJsSJJdwViHZcw5367rZi7_qkXLfMzacXBfpv-vD9UA",
"image_url": "https://cdn2.benzinga.com/files/imagecache/og_image_social_share_1200x630/images/story/2012/andre-francois-mckenzie-auhr4gcqcce-unsplash.jpg?width=720",
"keywords": [
"Sector ETFs",
"Penny Stocks",
"Cryptocurrency",
"Small Cap",
"Markets",
"Trading Ideas",
"ETFs"
],
"published_utc": "2021-04-26T02:33:17Z",
"publisher": {
"favicon_url": "https://s3.polygon.io/public/public/assets/news/favicons/benzinga.ico",
"homepage_url": "https://www.benzinga.com/",
"logo_url": "https://s3.polygon.io/public/public/assets/news/logos/benzinga.svg",
"name": "Benzinga"
},
"tickers": [
"DOCU",
"DDD",
"NIU",
"ARKF",
"NVDA",
"SKLZ",
"PCAR",
"MASS",
"PSTI",
"SPFR",
"TREE",
"PHR",
"IRDM",
"BEAM",
"ARKW",
"ARKK",
"ARKG",
"PSTG",
"SQ",
"IONS",
"SYRS"
],
"title": "Cathie Wood Adds More Coinbase, Skillz, Trims Square"
}
],
"status": "OK"
}Filter by asset class.
Filter by locale.
The total number of results for this request.
A request ID assigned by the server.
An identifier for a group of similar financial instruments.
A code used by Polygon.io to refer to this ticker type.
A short description of this ticker type.
An identifier for a geographical location.
The status of this request's response.
{
"count": 1,
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"results": [
{
"asset_class": "stocks",
"code": "CS",
"description": "Common Stock",
"locale": "us"
}
],
"status": "OK"
}The market close time on the holiday (if it's not closed).
The date of the holiday.
Which market the record is for.
The name of the holiday.
The market open time on the holiday (if it's not closed).
The status of the market on the holiday.
[
{
"date": "2020-11-26T00:00:00.000Z",
"exchange": "NYSE",
"name": "Thanksgiving",
"status": "closed"
},
{
"date": "2020-11-26T00:00:00.000Z",
"exchange": "NASDAQ",
"name": "Thanksgiving",
"status": "closed"
},
{
"date": "2020-11-26T00:00:00.000Z",
"exchange": "OTC",
"name": "Thanksgiving",
"status": "closed"
},
{
"close": "2020-11-27T18:00:00.000Z",
"date": "2020-11-27T00:00:00.000Z",
"exchange": "NASDAQ",
"name": "Thanksgiving",
"open": "2020-11-27T14:30:00.000Z",
"status": "early-close"
},
{
"close": "2020-11-27T18:00:00.000Z",
"date": "2020-11-27T00:00:00.000Z",
"exchange": "NYSE",
"name": "Thanksgiving",
"open": "2020-11-27T14:30:00.000Z",
"status": "early-close"
}
]Market Status
Get the current trading status of the exchanges and overall financial markets.
Whether or not the market is in post-market hours.
The status of the crypto market.
The status of the forex market.
Whether or not the market is in pre-market hours.
The status of the Nasdaq market.
The status of the NYSE market.
The status of the OTC market.
The status of the market as a whole.
The current time of the server.
{
"afterHours": true,
"currencies": {
"crypto": "open",
"fx": "open"
},
"earlyHours": false,
"exchanges": {
"nasdaq": "extended-hours",
"nyse": "extended-hours",
"otc": "closed"
},
"market": "extended-hours",
"serverTime": "2020-11-10T22:37:37.000Z"
}Filter for conditions within a given asset class.
Filter by data type.
Filter for conditions with a given ID.
Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 1000.
Sort field used for ordering.
The total number of results for this request.
If present, this value can be used to fetch the next page of data.
A request ID assigned by the server.
An array of conditions that match your query.
A commonly-used abbreviation for this condition.
An identifier for a group of similar financial instruments.
Data types that this condition applies to.
A short description of the semantics of this condition.
If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute. In other words, data with this condition attached comes exclusively from the given exchange.
An identifier used by Polygon.io for this condition. Unique per data type.
If true, this condition is from an old version of the SIPs' specs and no longer is used. Other conditions may or may not reuse the same symbol as this one.
The name of this condition.
A mapping to a symbol for each SIP that has this condition.
An identifier for a collection of related conditions.
A list of aggregation rules.
Describes aggregation rules on a consolidated (all exchanges) basis.
Whether or not trades with this condition update the high/low.
Whether or not trades with this condition update the open/close.
Whether or not trades with this condition update the volume.
Describes aggregation rules on a per-market-center basis.
Whether or not trades with this condition update the high/low.
Whether or not trades with this condition update the open/close.
Whether or not trades with this condition update the volume.
The status of this request's response.
{
"count": 1,
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"results": [
{
"asset_class": "stocks",
"data_types": [
"trade"
],
"id": 2,
"name": "Average Price Trade",
"sip_mapping": {
"CTA": "B",
"UTP": "W"
},
"type": "condition",
"update_rules": {
"consolidated": {
"updates_high_low": false,
"updates_open_close": false,
"updates_volume": true
},
"market_center": {
"updates_high_low": false,
"updates_open_close": false,
"updates_volume": true
}
}
}
],
"status": "OK"
}Filter by asset class.
Filter by locale.
The total number of results for this request.
A request ID assigned by the server.
A commonly used abbreviation for this exchange.
An identifier for a group of similar financial instruments.
A unique identifier used by Polygon.io for this exchange.
An identifier for a geographical location.
The Market Identifer Code of this exchange (see ISO 10383).
Name of this exchange.
The MIC of the entity that operates this exchange.
The ID used by SIP's to represent this exchange.
Represents the type of exchange.
A link to this exchange's website, if one exists.
The status of this request's response.
{
"count": 1,
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"results": [
{
"acronym": "AMEX",
"asset_class": "stocks",
"id": 1,
"locale": "us",
"mic": "XASE",
"name": "NYSE American, LLC",
"operating_mic": "XNYS",
"participant_id": "A",
"type": "exchange",
"url": "https://www.nyse.com/markets/nyse-american"
}
],
"status": "OK"
}Options WebSocket Documentation
The Polygon.io Options WebSocket API provides streaming access to the latest stock options market data from all US options exchanges. You can specify which channels you want to consume by sending instructions in the form of actions. Our WebSockets emit events to notify you when an event has occurred in a channel you've subscribed to.
Our WebSocket APIs are based on entitlements that control which WebSocket Clusters you can connect to and which kinds of data you can access. You can login to see examples that include your API key and are personalized to your entitlements.
Step 1: Connect
With a premium Options plan, you will be able to use a single connection to the Options Cluster. If another connection attempts to connect to the Options Cluster simultaneously, the current connection will be disconnected. If you need more simultaneous connections to this cluster, you can contact support.
Connecting to a cluster:
On connection you will receive the following message:
[{
"ev":"status",
"status":"connected",
"message": "Connected Successfully"
}]Step 2: Authenticate
You must authenticate before you can make any other requests.
On successful authentication you will receive the following message:
[{
"ev":"status",
"status":"auth_success",
"message": "authenticated"
}]Step 3: Subscribe
Once authenticated, you can request a stream. You can request multiple streams in the same request.
You can also request multiple streams from the same cluster.
Usage
Things happen very quickly in the world of finance, which means a Polygon.io WebSocket client must be able to handle many incoming messages per second. Due to the nature of the WebSocket protocol, if a client is slow to consume messages from the server, Polygon.io's server must buffer messages and send them only as fast as the client can consume them. To help prevent the message buffer from getting too long, Polygon.io may send more than one JSON object in a single WebSocket message. We accomplish this by wrapping all messages in a JSON array, and adding more objects to the array if the message buffer is getting longer. For example, consider a WebSocket message with a single trade event in it:
[
{"ev":"T","sym":"O:MSFT211203C00225000","x":325,"p":100.3,"s":1,"c":[209],"t":1638545640121,"q":466984517}
]If your client is consuming a bit slow, or 2+ events happened in very short succession, you may receive a single WebSocket message with more than one event inside it, like this:
[
{"ev":"T","sym":"O:MSFT211203C00225000","x":325,"p":100.3,"s":1,"c":[209],"t":1638545640121,"q":466984517},
{"ev":"T","sym":"O:LPL211217C00002500","x":289,"p":73.3,"s":1,"c":[201],"t":46729026472345,"q":759205639}
]Note that if a client is consuming messages too slowly for too long, Polygon.io's server-side buffer may get too large. If that happens, Polygon.io will terminate the WebSocket connection. You can check your account dashboard to see if a connection was terminated as a slow consumer. If this happens to you consistently, consider subscribing to fewer symbols or channels.
Aggregates (Per Minute)
Stream real-time minute aggregates for a given option contract.
Specify an option contract or use * to subscribe to all option contracts. You can also use a comma separated list to subscribe to multiple option contracts. You can retrieve active options contracts from our Options Contracts API.
The event type.
The ticker symbol for the given option contract.
The tick volume.
Today's accumulated volume.
Today's official opening price.
The tick's volume weighted average price.
The opening tick price for this aggregate window.
The closing tick price for this aggregate window.
The highest tick price for this aggregate window.
The lowest tick price for this aggregate window.
Today's volume weighted average price.
The average trade size for this aggregate window.
The timestamp of the starting tick for this aggregate window in Unix Milliseconds.
The timestamp of the ending tick for this aggregate window in Unix Milliseconds.
{
"ev": "AM",
"sym": "O:ONEM220121C00025000",
"v": 2,
"av": 8,
"op": 2.2,
"vw": 2.05,
"o": 2.05,
"c": 2.05,
"h": 2.05,
"l": 2.05,
"a": 2.1312,
"z": 2,
"s": 1632419640000,
"e": 1632419700000
}Aggregates (Per Second)
Stream real-time second aggregates for a given option contract.
Specify an option contract or use * to subscribe to all option contracts. You can also use a comma separated list to subscribe to multiple option contracts. You can retrieve active options contracts from our Options Contracts API.
The event type.
The ticker symbol for the given option contract.
The tick volume.
Today's accumulated volume.
Today's official opening price.
The tick's volume weighted average price.
The opening tick price for this aggregate window.
The closing tick price for this aggregate window.
The highest tick price for this aggregate window.
The lowest tick price for this aggregate window.
Today's volume weighted average price.
The average trade size for this aggregate window.
The timestamp of the starting tick for this aggregate window in Unix Milliseconds.
The timestamp of the ending tick for this aggregate window in Unix Milliseconds.
{
"ev": "AM",
"sym": "O:ONEM220121C00025000",
"v": 2,
"av": 8,
"op": 2.2,
"vw": 2.05,
"o": 2.05,
"c": 2.05,
"h": 2.05,
"l": 2.05,
"a": 2.1312,
"z": 2,
"s": 1632419640000,
"e": 1632419700000
}Trades
Stream real-time trades for a given option contract.
Specify an option contract or use * to subscribe to all option contracts. You can also use a comma separated list to subscribe to multiple option contracts. You can retrieve active options contracts from our Options Contracts API.
The event type.
The ticker symbol for the given option contract.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The price.
The trade size.
The trade conditions
The Timestamp in Unix MS.
The sequence number represents the sequence in which trade events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
{
"ev": "T",
"sym": "O:AMC210827C00037000",
"x": 65,
"p": 1.54,
"s": 1,
"c": [
233
],
"t": 1629820676333,
"q": 651921857
}Quotes
Stream real-time quotes for a given option contract.
Specify an option contract. You're only allowed to subscribe to 1,000 option contracts per connection. You can also use a comma separated list to subscribe to multiple option contracts. You can retrieve active options contracts from our Options Contracts API.
The event type.
The ticker symbol for the given option contract.
The bid exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The ask exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The bid price.
The ask price.
The bid size.
The ask size.
The Timestamp in Unix MS.
The sequence number represents the sequence in which trade events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
{
"ev": "Q",
"sym": "O:SPY241220P00720000",
"bx": 302,
"ax": 302,
"bp": 9.71,
"ap": 9.81,
"bs": 17,
"as": 24,
"t": 1644506128351,
"q": 844090872
}