Reference API

Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Crypto, and Forex.


Agilent Technologies Inc.

Specify a ticker symbol.
Defaults to empty string which queries all tickers.


ticker

Specify the type of the tickers. Find the types that we support via our [Ticker Types API](https://polygon.io/docs/get_v2_reference_types_anchor).
Defaults to empty string which queries all types.


type

Filter by market type. By default all markets are included.


market

Specify the primary exchange of the asset in the ISO code format. Find more information about the ISO codes [at the ISO org website](https://www.iso20022.org/market-identifier-codes).
Defaults to empty string which queries all exchanges.


exchange

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.


cusip

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.


Specify a point in time to retrieve tickers available on that date.
Defaults to the most recent available date.


date

Search for terms within the ticker and/or company name.


search

Specify if the tickers returned should be actively traded on the queried date. Default is true.


active

The field to sort the results on. Default is ticker.
If the `search` query parameter is present, `sort` is ignored and results are ordered by relevance.


sort

The order to sort the results on. Default is asc (ascending).


order

Limit the size of the response, default is 100 and max is 1000.

If your query returns more than the max limit and you want to retrieve the next page of results,
see the `next_url` response attribute.


limit

The total number of results for this request.

If present, this value can be used to fetch the next page of data.

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.                                                                                                                                                                                                                                                                                                   


Unauthorized - Check our API Key and account status

reference

Ticker Types v3

Get a mapping of ticker types to their descriptive names.


List all ticker types that Polygon.io has.

asset_class

An identifier for a group of similar financial instruments.

locale

An identifier for a geographical location.

Describes the type of financial instrument represented by a ticker.

Get details for a ticker symbol's company/entity.  This provides 
a general overview of the entity with information such as name, 
sector, exchange, logo and similar companies.


Apple Inc is designs, manufactures and markets mobile communication and media devices and personal computers, and sells a variety of related software, services, accessories, networking solutions and third-party digital content and applications.

Apple Inc.

stocksTicker

Indicates if the security is actively listed.  If false, this means the company is no longer listed and cannot be traded.

The official CIK guid used for SEC database/filings.

The country in which the company is registered.

A description of the company and what they do/offer.

The approximate number of employees for the company.

The exchange code (id) of the symbol's primary exchange.

The OpenFigi project guid for the symbol. (<a rel="nofollow" target="_blank" href="https://openfigi.com/">https://openfigi.com/</a>)

The street address for the company's headquarters.

The country in which the company's headquarters is located.

The state in which the company's headquarters is located.

The industry in which the company operates.

The Legal Entity Identifier (LEI) guid for the symbol. (<a rel="nofollow" target="_blank" href="https://en.wikipedia.org/wiki/Legal_Entity_Identifier">https://en.wikipedia.org/wiki/Legal_Entity_Identifier</a>)

The date that the symbol was listed on the exchange.

The phone number for the company. This is usually a corporate contact number.

The sector of the indsutry in which the symbol operates.

Standard Industrial Classification (SIC) id for the symbol. (<a rel="nofollow" target="_blank" href="https://en.wikipedia.org/wiki/Standard_Industrial_Classification">https://en.wikipedia.org/wiki/Legal_Entity_Identifier</a>)

The exchange symbol that this item is traded under.

The type or class of the security. (<a alt="Full List of Ticker Types" href="https://polygon.io/docs/get_v2_reference_types_anchor">Full List of Ticker Types</a>)

The last time this company record was updated.

Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it.


Ticker Details

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.


Query for contracts relating to an underlying stock ticker.

underlying_ticker

Query by the type of contract (ie call/put)

contract_type

Query by contract expiration date in YYYY-MM-DD format.

expiration_date

Limit the number of results returned, default is 10 and max is 1000.

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.

Cathie Wood-led Ark Investment Management on Friday snapped up another 221,167 shares of the cryptocurrency exchange Coinbase Global Inc (NASDAQ: <a class="ticker" href="https://www.benzinga.com/stock/coin#NASDAQ">COIN</a>) worth about $64.49 million on the stock&rsquo;s Friday&rsquo;s dip and also its fourth-straight loss.
The investment firm&rsquo;s Ark Innovation ETF (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&rsquo;s market cap has dropped from $85.8 billion on its blockbuster listing earlier this month.
The New York-based company also added another 3,873 shares of the mobile gaming company Skillz Inc (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.
ARKK bought the shares of the company which closed ...<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>

Cathie Wood Adds More Coinbase, Skillz, Trims Square

Return results published on, before, or after this date.

published_utc

Get a list of historical dividends for a stock, including the relevant dates and the amount of the dividend.


stocks

Get historical financial data for a stock ticker.
The financials data is extracted from XBRL from company SEC filings using the methodology outlined <a rel="noopener noreferrer nofollow" target="_blank" href="http://xbrl.squarespace.com/understanding-sec-xbrl-financi/">here</a>.

Stock Financials

Query by central index key (<a rel="noopener noreferrer nofollow" target="_blank" href="https://www.sec.gov/edgar/searchedgar/cik.htm">CIK</a>) Number

company_name

Query by standard industrial classification (<a rel="noopener noreferrer nofollow" target="_blank" href="https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list">SIC</a>)

Query by the date when the filing with financials data was filed in YYYY-MM-DD format.

Best used when querying over date ranges to find financials based on filings that happen in a time period.

Examples:

To get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01

To get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01

filing_date

The period of report for the filing with financials data in YYYY-MM-DD format.

period_of_report_date

Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4

timeframe

Whether or not to include the `xpath` and `formula` attributes for each financial data point.
See the `xpath` and `formula` response attributes for more info. False by default.

include_sources

Get a list of historical stock splits for a ticker symbol, including the execution and payment dates of the stock split, and the split ratio.


Get upcoming market holidays and their open/close times.


Thanksgiving

The market close time on the holiday (if it's not closed).

The market open time on the holiday (if it's not closed).

Holidays for each market in the near future.

Get the current trading status of the exchanges and overall financial markets.


Whether or not the market is in post-market hours.

Whether or not the market is in pre-market hours.

Get a unified numerical mapping for conditions on trades and quotes.  Each feed/exchange uses its own set of codes to identify conditions, so the same condition may have a different code depending on the originator of the data. Polygon.io defines its own mapping to allow for uniformly identifying a condition across feeds/exchanges.


The type of ticks to return mappings for.


ticktype

Polygon.io's mapping for condition codes. For more information, see our <a href="https://polygon.io/glossary/us/stocks/trade-conditions" alt="Trade Conditions Glossary" target="_blank">Trade Conditions Glossary</a>.

List all conditions that Polygon.io uses.

Average Price Trade

Filter for conditions within a given asset class.

data_type

The type of financial data represented by a data model.

An identifier used by Polygon.io for this condition. Unique per data type.

Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned.

An array of conditions that match your query.

A condition generally refers to any extra information passed in a trade or a quote. These conditions
may or may not affect the behavior of aggregates.

Exchanges v3

Get a list of stock exchanges which are supported by Polygon.io.


Multiple

NYSE American (AMEX)

NASDAQ OMX BX

National Stock Exchange

A unique identifier for the exchange internal to Polygon.io.  This is not an industry code or ISO standard.

The market data type that this exchange contains.

The Market Identification Code or MIC as defined in ISO 10383 (<a rel="nofollow" target="_blank" href="https://en.wikipedia.org/wiki/Market_Identifier_Code">https://en.wikipedia.org/wiki/Market_Identifier_Code</a>).

The type of exchange.
- TRF = Trade Reporting Facility
- exchange = Reporting exchange on the tape


Get a list of cryptocurrency exchanges which are supported by Polygon.io.


Coinbase

BITFINEX

Bitstamp

Kraken

The exchange ID. See <a href="https://polygon.io/docs/get_v1_meta_exchanges_anchor" alt="Exchanges">Exchanges</a> for Polygon.io's mapping of exchange IDs.

Market data type this exchange contains ( crypto only currently )

crypto

List all exchanges that Polygon.io knows about.

NYSE American, LLC

Stocks API

Get trades for a given ticker symbol on a specified date.


orig_id

conditions

correction

trf_timestamp

price

sequence_number

trf_id

size

sip_timestamp

participant_timestamp

tape

The date/day of the trades to retrieve in the format YYYY-MM-DD.

The timestamp offset, used for pagination. This is the offset at which to start the results. Using the `timestamp` of the last result as the offset will give you the next page of results.


timestamp

The maximum timestamp allowed in the results.


timestampLimit

reverse

Limit the size of the response, max 50000 and default 5000.

Latency in milliseconds for the query results from the database.

Whether or not this query was executed successfully.

trades

Get trades for a ticker symbol in a given time range.

Trades

stockTicker

Query by trade timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.

Limit the number of results returned, default is 10 and max is 50000.

Get NBBO quotes for a given ticker symbol on a specified date.


ask_price

ask_size

ask_exchange

indicators

bid_price

bid_size

bid_exchange

The date/day of the quotes to retrieve in the format YYYY-MM-DD.

nbbo

Get NBBO quotes for a ticker symbol in a given time range.

Quotes (NBBO)

Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.

Get the most recent trade for a given stock.


realtime

delayed

aggregates

Get the most recent NBBO (Quote) tick for a given stock.


Get the open, close and afterhours prices of a stock symbol on a certain date.


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.


adjusted

The close price of the ticker symbol in after hours trading.

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 open price for the symbol in the given time period.

The open price of the ticker symbol in pre-market trading.

The trading volume of the symbol in the given time period.

Get aggregate bars for a stock 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.

multiplier

timespan

from

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 
<a href="https://polygon.io/blog/aggs-api-updates/" target="_blank" alt="Aggregate Data API Improvements">Aggregate Data API Improvements</a>.

Whether or not this response was adjusted for splits.

The number of aggregates (minute or day) used to generate the response.

Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets.


The beginning date for the aggregate window.