Getting Started

The Polygon.io API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The financial data that you can access through the Polygon.io API differs based on your plan. These docs are customized to your version of the API and display your key and data, which only you can see.

Authentication

Pass your API key in the query string like follows:

https://api.polygon.io/v2/aggs/ticker/AAPL/range/1/day/2020-06-01/2020-06-17?apiKey=*

Alternatively, you can add an Authorization header to the request with your API Key as the token in the following form:

Authorization: Bearer <token>

Tickers

get
/v3/reference/tickers

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

Parameters

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

Return results where this field is less than the value.

Return results where this field is less than or equal to the value.

Return results where this field is greater than the value.

Return results where this field is greater than or equal to the value.

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.

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.

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

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.

https://api.polygon.io/v3/reference/tickers?apiKey=*

Response Attributes
resultsarray

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.

activeboolean

Whether or not the asset is actively traded. False means the asset has been delisted.


cikstring

The CIK number for this ticker. Find more information here.


composite_figistring

The composite OpenFIGI number for this ticker. Find more information here


currency_namestring

The name of the currency that this asset is traded with.


delisted_utcstring

The last date that the asset was traded.


last_updated_utcstring

The information is accurate up to this time.


localeenum [us, global]

The locale of the asset.


marketenum [stocks, crypto, fx]

The market type of the asset.


namestring

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.


primary_exchangestring

The ISO code of the primary listing exchange for this asset.


share_class_figistring

The share Class OpenFIGI number for this ticker. Find more information here


tickerstring

The exchange symbol that this item is traded under.


typestring

The type of the asset. Find the types that we support via our Ticker Types API.


next_urlstring

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


request_idstring

A request id assigned by the server.


countinteger

The total number of results for this request.


statusstring

The status of this request's response.


Response Object

{
 "count": 1,
 "next_url": "https://api.polygon.io/vX/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 Types

get
/v2/reference/types

Get a mapping of ticker types to their descriptive names.

This API has been deprecated and will be replaced by Ticker Types v3 on November 01, 2021

https://api.polygon.io/v2/reference/types?apiKey=*

Response Attributes
statusstring

The status of this request's response.


resultsobject
indexTypesobject
ALPHAINDEXstring

Alpha Index


ETFstring

Exchange Traded Fund (ETF)


ETMFstring

Exchange Traded Managed Fund (ETMF)


ETNstring

Exchange Traded Note (ETN)


INDEXstring

Index


SETTLEMENTstring

Settlement


SPOTstring

Spot


SUBPRODstring

Subordinated product


WCstring

World Currency


typesobject
ADRstring

American Depository Receipt


CEFstring

Closed-End Fund


CSstring

Common Stock


ETPstring

Exchange Traded Product/Fund


FDRstring

Foreign Ordinary Shares


FUNDstring

Fund


GDRstring

Global Depositary Receipt


LTDPstring

Limited Partnership


MFstring

Mutual Fund


MLPstring

Master Limited Partnership


NVDRstring

Non-Voting Depository Receipt


NYRSstring

New York Registry Shares


OSTstring

Other Security Type


PFDstring

Preferred Stock


PUBstring

Public


REITstring

Real Estate Investment Trust


RIGHTstring

Right


RYLTstring

Royalty Trust


SDRstring

Special Drawing Right


SIstring

Secondary Issue


SPstring

Structured Product


TRAKstring

Tracking stock or targeted stock


UNITstring

Unit


WRTstring

Equity WRT


Response Object

{
 "results": {
  "indexTypes": {
   "ALPHAINDEX": "Alpha Index",
   "ETF": "Exchange Traded Fund (ETF)",
   "ETMF": "Exchange Traded Managed Fund (ETMF)",
   "ETN": "Exchange Traded Note (ETN)",
   "INDEX": "Index",
   "SETTLEMENT": "Settlement",
   "SPOT": "Spot",
   "SUBPROD": "Subordinated product",
   "WC": "World Currency"
  },
  "types": {
   "ADRC": "American Depository Receipt Common",
   "ADRP": "American Depository Receipt Preferred",
   "ADRR": "American Depository Receipt Right",
   "ADRW": "American Depository Receipt Warrant",
   "BASKET": "Basket",
   "BOND": "Bond",
   "CEF": "Closed-End Fund",
   "CS": "Common Stock",
   "ETP": "Exchange Traded Product/Fund",
   "FDR": "Foreign Ordinary Shares",
   "FUND": "Fund",
   "GDR": "Global Depositary Receipt",
   "LTDP": "Limited Partnership",
   "MF": "Mutual Fund",
   "MLP": "Master Limited Partnership",
   "NVDR": "Non-Voting Depository Receipt",
   "NYRS": "New York Registry Shares",
   "OST": "Other Security Type",
   "PFD": "Preferred Stock",
   "PUB": "Public",
   "REIT": "Real Estate Investment Trust",
   "RIGHT": "Right",
   "RYLT": "Royalty Trust",
   "SDR": "Special Drawing Right",
   "SI": "Secondary Issue",
   "SP": "Structured Product",
   "TRAK": "Tracking stock or targeted stock",
   "UNIT": "Unit",
   "WARRANT": "Warrant",
   "WRT": "Equity WRT"
  }
 },
 "status": "OK"
}

Ticker Types v3

get
/v3/reference/tickers/types

List all ticker types that Polygon.io has.

Parameters

Filter by asset class.

Filter by locale.

https://api.polygon.io/v3/reference/tickers/types?apiKey=*

Response Attributes
countinteger

The total number of results for this request.


request_id*string

A request ID assigned by the server.


resultsarray
asset_class*enum [stocks, options, crypto, fx]

An identifier for a group of similar financial instruments.


code*string

A code used by Polygon.io to refer to this ticker type.


description*string

A short description of this ticker type.


locale*enum [us, global]

An identifier for a geographical location.


status*string

The status of this request's response.


Response Object

{
 "count": 1,
 "request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
 "results": [
  {
   "asset_class": "stocks",
   "code": "CS",
   "description": "Common Stock",
   "locale": "us"
  }
 ],
 "status": "OK"
}

Ticker Details

get
/v1/meta/symbols/{stocksTicker}/company

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.

Parameters

The ticker symbol of the stock/equity.

https://api.polygon.io/v1/meta/symbols/{stocksTicker}/company?apiKey=*

Response Attributes
activeboolean

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


bloombergstring

The Bloomberg guid for the symbol.


ceostring

The name of the company's current CEO.


cikstring

The official CIK guid used for SEC database/filings.


countrystring

The country in which the company is registered.


descriptionstring

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


employeesinteger

The approximate number of employees for the company.


exchangestring

The symbol's primary exchange.


exchangeSymbolstring

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


figistring

The OpenFigi project guid for the symbol. (https://openfigi.com/)


hq_addressstring

The street address for the company's headquarters.


hq_countrystring

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


hq_statestring

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


industrystring

The industry in which the company operates.


leistring

The Legal Entity Identifier (LEI) guid for the symbol. (https://en.wikipedia.org/wiki/Legal_Entity_Identifier)


listdatestring

The date that the symbol was listed on the exchange.


logostring

The URL of the entity's logo.


marketcapinteger

The current market cap for the company.


namestring

The name of the company/entity.


phonestring

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


sectorstring

The sector of the indsutry in which the symbol operates.


sicinteger

Standard Industrial Classification (SIC) id for the symbol. (https://en.wikipedia.org/wiki/Legal_Entity_Identifier)


similararray [string]

A list of ticker symbols for similar companies.


symbolstring

The exchange symbol that this item is traded under.


tagsarray [string]

A list of words related to the company.


typestring

The type or class of the security. (Full List of Ticker Types)


updatedstring

The last time this company record was updated.


urlstring

The URL of the company's website


Response Object

{
 "active": true,
 "bloomberg": "EQ0010169500001000",
 "ceo": "Timothy D. Cook",
 "cik": 320193,
 "country": "usa",
 "description": "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.",
 "employees": 123000,
 "exchange": "Nasdaq Global Select",
 "exchangeSymbol": "NGS",
 "figi": null,
 "hq_address": "1 Infinite Loop Cupertino CA, 95014",
 "hq_country": "USA",
 "hq_state": "CA",
 "industry": "Computer Hardware",
 "lei": "HWUPKR0MPOU8FGXBT394",
 "listdate": "1990-01-02T00:00:00.000Z",
 "logo": "https://s3.polygon.io/logos/aapl/logo.png",
 "marketcap": 908316631180,
 "name": "Apple Inc.",
 "phone": "+1 408 996-1010",
 "sector": "Technology",
 "sic": 3571,
 "similar": [
  "MSFT",
  "NOK",
  "IBM",
  "HPQ",
  "GOOGL",
  "BB",
  "XLK"
 ],
 "symbol": "AAPL",
 "tags": [
  "Technology",
  "Consumer Electronics",
  "Computer Hardware"
 ],
 "type": "CS",
 "updated": "11/16/2018",
 "url": "http://www.apple.com"
}

Ticker Details vX

get
/vX/reference/tickers/{ticker}

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

This API is experimental and will replace Ticker Details

Parameters

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.

https://api.polygon.io/vX/reference/tickers/{ticker}?apiKey=*

Response Attributes
resultsobject

Ticker with details.

activeboolean

Whether or not the asset is actively traded. False means the asset has been delisted.


addressobject
address1string

The first line of the company's headquarters address.


citystring

The city of the company's headquarters address.


statestring

The state of the company's headquarters address.


cikstring

The CIK number for this ticker. Find more information here.


composite_figistring

The composite OpenFIGI number for this ticker. Find more information here


currency_namestring

The name of the currency that this asset is traded with.


delisted_utcstring

The last date that the asset was traded.


last_updated_utcstring

The last time this asset record was updated.


localeenum [us, global]

The locale of the asset.


marketenum [stocks, crypto, fx]

The market type of the asset.


market_capnumber

The most recent close price of the ticker multiplied by outstanding shares.


namestring

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.


outstanding_sharesnumber

The recorded number of outstanding shares.


phone_numberstring

The phone number for the company behind this ticker.


primary_exchangestring

The ISO code of the primary listing exchange for this asset.


share_class_figistring

The share Class OpenFIGI number for this ticker. Find more information here


sic_codestring

The standard industrial classification code for this ticker. For a list of SIC Codes, see the SEC's SIC Code List.


sic_descriptionstring

A description of this ticker's SIC code.


tickerstring

The exchange symbol that this item is traded under.


typestring

The type of the asset. Find the types that we support via our Ticker Types API.


request_idstring

A request id assigned by the server.


countinteger

The total number of results for this request.


statusstring

The status of this request's response.


Response Object

{
 "count": 1,
 "request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
 "results": {
  "active": true,
  "address": {
   "address1": "One Apple Park Way",
   "city": "Cupertino",
   "state": "CA"
  },
  "cik": "0000320193",
  "composite_figi": "BBG000B9XRY4",
  "currency_name": "usd",
  "last_updated_utc": "2020-12-27T00:00:00Z",
  "locale": "us",
  "market": "stocks",
  "market_cap": 2082042128180,
  "name": "Apple Inc.",
  "outstanding_shares": 17001800000,
  "phone_number": "(408) 996-1010",
  "primary_exchange": "XNAS",
  "share_class_figi": "BBG001S5N8V8",
  "sic_code": "3571",
  "sic_description": "ELECTRONIC COMPUTERS",
  "ticker": "AAPL",
  "type": "CS"
 },
 "status": "OK"
}

Ticker News

get
/v2/reference/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.

Parameters

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.

Order the results in ascending or descending order.

The field key to sort the results on.

Return results where this field equals the value.

Return results where this field is less than the value.

Return results where this field is less than or equal to the value.

Return results where this field is greater than the value.

Return results where this field is greater than or equal to the value.

Return results where this field equals the value.

Return results where this field is less than the value.

Return results where this field is less than or equal to the value.

Return results where this field is greater than the value.

Return results where this field is greater than or equal to the value.

https://api.polygon.io/v2/reference/news?apiKey=*

Response Attributes
resultsarray
amp_urlstring

The mobile friendly Accelerated Mobile Page (AMP) URL.


article_url*string

A link to the news article.


author*string

The article's author.


descriptionstring

A description of the article.


id*string

Unique identifier for the article.


image_urlstring

The article's image URL.


keywordsarray [string]

The keywords associated with the article (which will vary depending on the publishing source).


published_utc*string

The date the article was published on.


publisher*object
favicon_urlstring

The publisher's homepage favicon URL.


homepage_urlstring

The publisher's homepage URL.


logo_urlstring

The publisher's logo URL.


namestring

The publisher's name.


tickers*array [string]

The ticker symbols associated with the article.


title*string

The title of the news article.


next_urlstring

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


request_idstring

A request id assigned by the server.


countinteger

The total number of results for this request.


statusstring

The status of this request's response.


Response Object

{
 "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&rsquo;s Friday&rsquo;s dip and also its fourth-straight loss.</p>\n<p>The investment firm&rsquo;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&rsquo;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"
}

Stock Dividends

get
/v2/reference/dividends/{stocksTicker}

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

Parameters

The ticker symbol of the stock/equity.

https://api.polygon.io/v2/reference/dividends/{stocksTicker}?apiKey=*

Response Attributes
countinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
amountnumber

The amount of the dividend.


exDatestring

The execution date of the dividend.


paymentDatestring

The payment date of the dividend.


recordDatestring

The date of record for the dividend.

See Investor.gov for an explanation on dividend dates and their meaning.


tickerstring

The exchange symbol that this item is traded under.


Response Object

{
 "count": 2,
 "results": [
  {
   "amount": 0.82,
   "exDate": "2020-05-08T00:00:00.000Z",
   "paymentDate": "2020-05-14T00:00:00.000Z",
   "recordDate": "2020-05-11T00:00:00.000Z",
   "ticker": "AAPL"
  },
  {
   "amount": 0.77,
   "exDate": "2020-02-07T00:00:00.000Z",
   "paymentDate": "2020-02-13T00:00:00.000Z",
   "recordDate": "2020-02-10T00:00:00.000Z",
   "ticker": "AAPL"
  }
 ],
 "status": "OK"
}

Stock Financials

get
/v2/reference/financials/{stocksTicker}

Get historical financial data for a stock ticker.

Parameters

The ticker symbol of the stock/equity.

Limit the number of results.

Specify a type of report to return.

Y = Year YA = Year annualized Q = Quarter QA = Quarter Annualized T = Trailing twelve months TA = trailing twelve months annualized

The direction to sort the returned results.

https://api.polygon.io/v2/reference/financials/{stocksTicker}?apiKey=*

Response Attributes
countinteger

resultsarray
EBITDAMarginnumber

accumulatedOtherComprehensiveIncomeinteger

accumulatedRetainedEarningsDeficitinteger

assetTurnoverinteger

assetsinteger

assetsAverageinteger

assetsCurrentinteger

assetsNonCurrentinteger

averageEquityinteger

bookValuePerSharenumber

calendarDatestring

capitalExpenditureinteger

cashAndEquivalentsinteger

cashAndEquivalentsUSDinteger

consolidatedIncomeinteger

costOfRevenueinteger

currentLiabilitiesinteger

currentRationumber

debtinteger

debtCurrentinteger

debtNonCurrentinteger

debtToEquityRationumber

debtUSDinteger

deferredRevenueinteger

depositsinteger

depreciationAmortizationAndAccretioninteger

dividendYieldinteger

dividendsPerBasicCommonShareinteger

earningBeforeInterestTaxesinteger

earningBeforeInterestTaxesUSDinteger

earningsBeforeInterestTaxesDepreciationAmortizationinteger

earningsBeforeInterestTaxesDepreciationAmortizationUSDinteger

earningsBeforeTaxinteger

earningsPerBasicSharenumber

earningsPerBasicShareUSDnumber

earningsPerDilutedSharenumber

effectOfExchangeRateChangesOnCashinteger

enterpriseValueinteger

enterpriseValueOverEBITinteger

enterpriseValueOverEBITDAnumber

foreignCurrencyUSDExchangeRateinteger

freeCashFlowinteger

freeCashFlowPerSharenumber

goodwillAndIntangibleAssetsinteger

grossMarginnumber

grossProfitinteger

incomeTaxExpenseinteger

interestExpenseinteger

inventoryinteger

investedCapitalinteger

investedCapitalAverageinteger

investmentsinteger

investmentsCurrentinteger

investmentsNonCurrentinteger

issuanceDebtSecuritiesinteger

issuanceEquitySharesinteger

liabilitiesNonCurrentinteger

marketCapitalizationinteger

netCashFlowinteger

netCashFlowBusinessAcquisitionsDisposalsinteger

netCashFlowFromFinancinginteger

netCashFlowFromInvestinginteger

netCashFlowFromOperationsinteger

netCashFlowInvestmentAcquisitionsDisposalsinteger

netIncomeinteger

netIncomeCommonStockinteger

netIncomeCommonStockUSDinteger

netIncomeToNonControllingInterestsinteger

netLossIncomeFromDiscontinuedOperationsinteger

operatingExpensesinteger

operatingIncomeinteger

paymentDividendsOtherCashDistributionsinteger

payoutRatiointeger

periodenum [Q, T, QA, TA, Y, YA]

Reporting period.


preferredDividendsIncomeStatementImpactinteger

priceEarningsnumber

priceSalesnumber

priceToBookValuenumber

priceToEarningsRationumber

priceToSalesRationumber

profitMarginnumber

propertyPlantEquipmentNetinteger

reportPeriodstring

researchAndDevelopmentExpenseinteger

returnOnAverageAssetsinteger

returnOnAverageEquityinteger

returnOnInvestedCapitalinteger

returnOnSalesnumber

revenuesinteger

revenuesUSDinteger

salesPerSharenumber

sellingGeneralAndAdministrativeExpenseinteger

shareBasedCompensationinteger

shareFactorinteger

sharePriceAdjustedClosenumber

shareholdersEquityinteger

shareholdersEquityUSDinteger

sharesinteger

tangibleAssetValueinteger

tangibleAssetsBookValuePerSharenumber

taxAssetsinteger

taxLiabilitiesinteger

ticker*string

The exchange symbol that this item is traded under.


totalLiabilitiesinteger

tradeAndNonTradePayablesinteger

tradeAndNonTradeReceivablesinteger

updatedstring

weightedAverageSharesinteger

weightedAverageSharesDilutedinteger

workingCapitalinteger

statusstring

Response Object

{
 "count": 1,
 "results": [
  {
   "EBITDAMargin": 0,
   "accumulatedOtherComprehensiveIncome": 0,
   "accumulatedRetainedEarningsDeficit": 0,
   "assetTurnover": 0,
   "assets": 0,
   "assetsAverage": 0,
   "assetsCurrent": 0,
   "assetsNonCurrent": 0,
   "averageEquity": 0,
   "bookValuePerShare": 0,
   "calendarDate": "2019-03-31",
   "capitalExpenditure": 0,
   "cashAndEquivalents": 0,
   "cashAndEquivalentsUSD": 0,
   "consolidatedIncome": 0,
   "costOfRevenue": 0,
   "currentLiabilities": 0,
   "currentRatio": 0,
   "debt": 0,
   "debtCurrent": 0,
   "debtNonCurrent": 0,
   "debtToEquityRatio": 0,
   "debtUSD": 0,
   "deferredRevenue": 0,
   "deposits": 0,
   "depreciationAmortizationAndAccretion": 0,
   "dividendYield": 0,
   "dividendsPerBasicCommonShare": 0,
   "earningBeforeInterestTaxes": 0,
   "earningBeforeInterestTaxesUSD": 0,
   "earningsBeforeInterestTaxesDepreciationAmortization": 0,
   "earningsBeforeInterestTaxesDepreciationAmortizationUSD": 0,
   "earningsBeforeTax": 0,
   "earningsPerBasicShare": 0,
   "earningsPerBasicShareUSD": 0,
   "earningsPerDilutedShare": 0,
   "effectOfExchangeRateChangesOnCash": 0,
   "enterpriseValue": 0,
   "enterpriseValueOverEBIT": 0,
   "enterpriseValueOverEBITDA": 0,
   "foreignCurrencyUSDExchangeRate": 0,
   "freeCashFlow": 0,
   "freeCashFlowPerShare": 0,
   "goodwillAndIntangibleAssets": 0,
   "grossMargin": 0,
   "grossProfit": 0,
   "incomeTaxExpense": 0,
   "interestExpense": 0,
   "inventory": 0,
   "investedCapital": 0,
   "investedCapitalAverage": 0,
   "investments": 0,
   "investmentsCurrent": 0,
   "investmentsNonCurrent": 0,
   "issuanceDebtSecurities": 0,
   "issuanceEquityShares": 0,
   "liabilitiesNonCurrent": 0,
   "marketCapitalization": 0,
   "netCashFlow": 0,
   "netCashFlowBusinessAcquisitionsDisposals": 0,
   "netCashFlowFromFinancing": 0,
   "netCashFlowFromInvesting": 0,
   "netCashFlowFromOperations": 0,
   "netCashFlowInvestmentAcquisitionsDisposals": 0,
   "netIncome": 0,
   "netIncomeCommonStock": 0,
   "netIncomeCommonStockUSD": 0,
   "netIncomeToNonControllingInterests": 0,
   "netLossIncomeFromDiscontinuedOperations": 0,
   "operatingExpenses": 0,
   "operatingIncome": 0,
   "paymentDividendsOtherCashDistributions": 0,
   "payoutRatio": 0,
   "period": "Q",
   "preferredDividendsIncomeStatementImpact": 0,
   "priceEarnings": 0,
   "priceSales": 0,
   "priceToBookValue": 0,
   "priceToEarningsRatio": 0,
   "priceToSalesRatio": 0,
   "profitMargin": 0,
   "propertyPlantEquipmentNet": 0,
   "reportPeriod": "2019-03-31",
   "researchAndDevelopmentExpense": 0,
   "returnOnAverageAssets": 0,
   "returnOnAverageEquity": 0,
   "returnOnInvestedCapital": 0,
   "returnOnSales": 0,
   "revenues": 0,
   "revenuesUSD": 0,
   "salesPerShare": 0,
   "sellingGeneralAndAdministrativeExpense": 0,
   "shareBasedCompensation": 0,
   "shareFactor": 0,
   "sharePriceAdjustedClose": 0,
   "shareholdersEquity": 0,
   "shareholdersEquityUSD": 0,
   "shares": 0,
   "tangibleAssetValue": 0,
   "tangibleAssetsBookValuePerShare": 0,
   "taxAssets": 0,
   "taxLiabilities": 0,
   "ticker": "string",
   "totalLiabilities": 0,
   "tradeAndNonTradePayables": 0,
   "tradeAndNonTradeReceivables": 0,
   "updated": "1999-03-28",
   "weightedAverageShares": 0,
   "weightedAverageSharesDiluted": 0,
   "workingCapital": 0
  }
 ],
 "status": "OK"
}

Stock Financials vX

get
/vX/reference/financials

Get historical financial data for a stock ticker. The financials data is extracted from XBRL from company SEC filings using the methodology outlined here.

This API is experimental and will replace Stock Financials

Parameters

Query by company ticker.

Query by central index key (CIK) Number

Query by company name.

company_name.search partial-match text search

Query by standard industrial classification (SIC)

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.lt less than
filing_date.lte less than or equal to
filing_date.gt greater than
filing_date.gte greater than or equal to

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

period_of_report_date.lt less than
period_of_report_date.lte less than or equal to
period_of_report_date.gt greater than
period_of_report_date.gte greater than or equal to

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

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.

Order results based on the sort field.

Limit results.

Sort field used for ordering.

https://api.polygon.io/vX/reference/financials?apiKey=*

Response Attributes
count*integer

The total number of results for this request.


next_urlstring

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


request_id*string

A request id assigned by the server.


results*array
cik*string

The CIK number for the company.


company_name*string

The company name.


end_datestring

The end date of the period that these financials cover in YYYYMMDD format.


financials*object
balance_sheetobject

Balance sheet. Note that the keys in this object can be any of the balance sheet concepts defined in this table of fundamental accounting concepts but converted to snake_case.

*object

An individual financial data point.

formula

The name of the formula used to derive this data point from other financial data points. Information about the formulas can be found here. This value is only returned for data points that are not explicitly expressed within the XBRL source file when the include_sources query parameter is true.


labelstring

A human readable label for the financial data point.


orderinteger

An indicator of what order within the statement that you would find this data point.


unitstring

The unit of the financial data point.


valuenumber

The value of the financial data point.


xpath

The XPath 1.0 query that identifies the fact from within the XBRL source file. This value is only returned for data points taken directly from XBRL when the include_sources query parameter is true.


cash_flow_statementobject

Cash flow statement. Note that the keys in this object can be any of the cash flow statement concepts defined in this table of fundamental accounting concepts but converted to snake_case. See the attributes of the objects within balance_sheet for more details.

comprehensive_incomeobject

Comprehensive income. Note that the keys in this object can be any of the comprehensive income statement concepts defined in this table of fundamental accounting concepts but converted to snake_case. See the attributes of the objects within balance_sheet for more details.

income_statementobject

Income statement. Note that the keys in this object can be any of the income statement concepts defined in this table of fundamental accounting concepts but converted to snake_case. See the attributes of the objects within balance_sheet for more details.

fiscal_period*string

Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY).


fiscal_year*string

Fiscal year of the report according to the company.


source_filing_file_url*

The URL of the specific XBRL instance document within the SEC filing that these financials were derived from.


source_filing_url*string

The URL of the SEC filing that these financials were derived from.


start_datestring

The start date of the period that these financials cover in YYYYMMDD format.


status*string

The status of this request's response.


Response Object

{
 "cik": "0000789019",
 "company_name": "MICROSOFT CORPORATION",
 "end_date": "2020-12-31",
 "financials": {
  "balance_sheet": {
   "assets": {
    "label": "Assets",
    "order": 100,
    "unit": "USD",
    "value": 304137000000,
    "xpath": "//*[local-name()='Assets' and @id='F_000165']"
   },
   "equity": {
    "formula": "BS-Impute-07",
    "label": "Equity",
    "order": 1400,
    "unit": "USD",
    "value": 130236000000
   },
   "liabilities": {
    "label": "Liabilities",
    "order": 600,
    "unit": "USD",
    "value": 173901000000,
    "xpath": "//*[local-name()='Liabilities' and @id='F_000193']"
   }
  },
  "cash_flow_statement": {
   "exchange_gains_losses": {
    "label": "Exchange Gains/Losses",
    "order": 1000,
    "unit": "USD",
    "value": 14000000,
    "xpath": "//*[local-name()='EffectOfExchangeRateOnCashAndCashEquivalents' and @id='F_000327']"
   },
   "net_cash_flow": {
    "formula": "CF-Impute-20",
    "label": "Net Cash Flow",
    "order": 1100,
    "unit": "USD",
    "value": -2773000000
   },
   "net_cash_flow_from_financing_activities": {
    "label": "Net Cash Flow From Financing Activities",
    "order": 700,
    "unit": "USD",
    "value": -13634000000,
    "xpath": "//*[local-name()='NetCashProvidedByUsedInFinancingActivities' and @id='F_000295']"
   }
  },
  "comprehensive_income": {
   "comprehensive_income_loss": {
    "formula": "CI-Impute-04",
    "label": "Comprehensive Income/Loss",
    "order": 100,
    "unit": "USD",
    "value": 15720000000
   },
   "comprehensive_income_loss_attributable_to_parent": {
    "label": "Comprehensive Income/Loss Attributable To Parent",
    "order": 300,
    "unit": "USD",
    "value": 15720000000,
    "xpath": "//*[local-name()='ComprehensiveIncomeNetOfTax' and @id='F_000135']"
   },
   "other_comprehensive_income_loss": {
    "formula": "CI-Impute-07",
    "label": "Other Comprehensive Income/Loss",
    "order": 400,
    "unit": "USD",
    "value": 15720000000
   }
  },
  "income_statement": {
   "basic_earnings_per_share": {
    "label": "Basic Earnings Per Share",
    "order": 4200,
    "unit": "USD / shares",
    "value": 2.05,
    "xpath": "//*[local-name()='EarningsPerShareBasic' and @id='F_000099']"
   },
   "cost_of_revenue": {
    "label": "Cost Of Revenue",
    "order": 300,
    "unit": "USD",
    "value": 14194000000,
    "xpath": "//*[local-name()='CostOfGoodsAndServicesSold' and @id='F_000059']"
   },
   "gross_profit": {
    "label": "Gross Profit",
    "order": 800,
    "unit": "USD",
    "value": 28882000000,
    "xpath": "//*[local-name()='GrossProfit' and @id='F_000063']"
   },
   "operating_expenses": {
    "formula": "IS-Impute-22",
    "label": "Operating Expenses",
    "order": 1000,
    "unit": "USD",
    "value": 10985000000
   },
   "revenues": {
    "label": "Revenues",
    "order": 100,
    "unit": "USD",
    "value": 43076000000,
    "xpath": "//*[local-name()='RevenueFromContractWithCustomerExcludingAssessedTax' and @id='F_000047']"
   }
  }
 },
 "fiscal_period": "Q2",
 "fiscal_year": "2021",
 "source_filing_file_url": "https:/api.polygon.io/v1/reference/sec/filings/0001564590-21-002316/files/0001564590-21-002316:12:msft-10q_20201231_htm.xml",
 "source_filing_url": "https://api.polygon.io/v1/reference/sec/filings/0001564590-21-002316",
 "start_date": "2020-10-01"
}

Stock Splits

get
/v2/reference/splits/{stocksTicker}

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.

Parameters

The ticker symbol of the stock/equity.

https://api.polygon.io/v2/reference/splits/{stocksTicker}?apiKey=*

Response Attributes
countinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
declaredDatestring

The declared date of the stock split.


exDatestring

The execution date of the stock split.


forfactorinteger

The "for" factor of the split. This is used to calculate the split ratio forfactor/tofactor = ratio (eg ½ = 0.5).


paymentDatestring

The payment date of the stock split.


rationumber

This refers to the split ratio. The split ratio is an inverse of the number of shares that a holder of the stock would have after the split divided by the number of shares that the holder had before.

For example: A split ratio of .5 means a 2 for 1 split.


tickerstring

The exchange symbol that this item is traded under.


tofactorinteger

The "to" factor of the split. This is used to calculate the split ratio forfactor/tofactor = ratio (eg ½ = 0.5).


Response Object

{
 "count": 4,
 "results": [
  {
   "declaredDate": "2020-07-30T00:00:00.000Z",
   "exDate": "2020-08-31T00:00:00.000Z",
   "forfactor": 4,
   "paymentDate": "2020-08-28T00:00:00.000Z",
   "ratio": 0.25,
   "ticker": "AAPL",
   "tofactor": 1
  },
  {
   "exDate": "2014-06-09T00:00:00.000Z",
   "forfactor": 7,
   "paymentDate": "2014-06-10T00:00:00.000Z",
   "ratio": 0.14285714285714285,
   "ticker": "AAPL",
   "tofactor": 1
  },
  {
   "exDate": "2005-02-28T00:00:00.000Z",
   "paymentDate": "2005-02-28T00:00:00.000Z",
   "ratio": 0.5,
   "ticker": "AAPL"
  },
  {
   "exDate": "2000-06-21T00:00:00.000Z",
   "paymentDate": "2000-06-21T00:00:00.000Z",
   "ratio": 0.5,
   "ticker": "AAPL"
  }
 ],
 "status": "OK"
}

Market Holidays

get
/v1/marketstatus/upcoming

Get upcoming market holidays and their open/close times.

https://api.polygon.io/v1/marketstatus/upcoming?apiKey=*

Response Attributes
responsearray
closestring

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


datestring

The date of the holiday.


exchangestring

Which market the record is for.


namestring

The name of the holiday.


openstring

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


statusstring

The status of the market on the holiday.


Response Object

[
 {
  "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
/v1/marketstatus/now

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

https://api.polygon.io/v1/marketstatus/now?apiKey=*

Response Attributes
afterHoursboolean

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


currenciesobject
cryptostring

The status of the crypto market.


fxstring

The status of the forex market.


earlyHoursboolean

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


exchangesobject
nasdaqstring

The status of the Nasdaq market.


nysestring

The status of the NYSE market.


otcstring

The status of the OTC market.


marketstring

The status of the market as a whole.


serverTimestring

The current time of the server.


Response Object

{
 "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"
}

Condition Mappings

get
/v1/meta/conditions/{ticktype}

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.

Parameters

The type of ticks to return mappings for.

https://api.polygon.io/v1/meta/conditions/{ticktype}?apiKey=*

Response Attributes
conditionstring

Polygon.io's mapping for condition codes. For more information, see our Trade Conditions Glossary.


Response Object

{
 "0": "Regular",
 "1": "Acquisition",
 "2": "AveragePrice",
 "3": "AutomaticExecution",
 "4": "Bunched",
 "5": "BunchSold",
 "6": "CAPElection",
 "7": "CashTrade",
 "8": "Closing",
 "9": "Cross",
 "10": "DerivativelyPriced",
 "11": "Distribution",
 "12": "FormT(ExtendedHours)",
 "13": "FormTOutOfSequence",
 "14": "InterMarketSweep",
 "15": "MarketCenterOfficialClose",
 "16": "MarketCenterOfficialOpen",
 "17": "MarketCenterOpening",
 "18": "MarketCenterReOpenning",
 "19": "MarketCenterClosing",
 "20": "NextDay",
 "21": "PriceVariation",
 "22": "PriorReferencePrice",
 "23": "Rule155Amex",
 "24": "Rule127Nyse",
 "25": "Opening",
 "26": "Opened",
 "27": "RegularStoppedStock",
 "28": "ReOpening",
 "29": "Seller",
 "30": "SoldLast",
 "31": "SoldLastStoppedStock",
 "32": "SoldOutOfSequence",
 "33": "SoldOutOfSequenceStoppedStock",
 "34": "Split",
 "35": "StockOption",
 "36": "YellowFlag",
 "37": "OddLot",
 "38": "CorrectedConsolidatedClosePrice",
 "39": "Unknown",
 "40": "Held",
 "41": "TradeThruExempt",
 "42": "NonEligible",
 "43": "NonEligible-extended",
 "44": "Cancelled",
 "45": "Recovery",
 "46": "Correction",
 "47": "AsOf",
 "48": "AsOfCorrection",
 "49": "AsOfCancel",
 "50": "OOB",
 "51": "Summary",
 "52": "Contingent",
 "53": "Contingent(Qualified)",
 "54": "Errored"
}

Stock Exchanges

get
/v1/meta/exchanges

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

This API has been deprecated and will be replaced by Exchanges v3 on November 01, 2021

https://api.polygon.io/v1/meta/exchanges?apiKey=*

Response Attributes
responsearray
codestring

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


idnumber

The ID of the exchange.


marketstring

The market data type that this exchange contains.


micstring

The Market Identification Code or MIC as defined in ISO 10383 (https://en.wikipedia.org/wiki/Market_Identifier_Code).


namestring

The name of the exchange.


tapestring

The tape id of the exchange.


typestring

The type of exchange.

  • TRF = Trade Reporting Facility
  • exchange = Reporting exchange on the tape

Response Object

[
 {
  "id": 0,
  "market": "equities",
  "mic": "TFF",
  "name": "Multiple",
  "tape": "-",
  "type": "TRF"
 },
 {
  "code": "AMX",
  "id": 1,
  "market": "equities",
  "mic": "XASE",
  "name": "NYSE American (AMEX)",
  "tape": "A",
  "type": "exchange"
 },
 {
  "code": "NSD",
  "id": 2,
  "market": "equities",
  "mic": "XNAS",
  "name": "NASDAQ OMX BX",
  "tape": "B",
  "type": "exchange"
 },
 {
  "id": 3,
  "market": "equities",
  "mic": "XCIS",
  "name": "National Stock Exchange",
  "tape": "C",
  "type": "TRF"
 }
]

Crypto Exchanges

get
/v1/meta/crypto-exchanges

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

This API has been deprecated and will be replaced by Exchanges v3 on November 01, 2021

https://api.polygon.io/v1/meta/crypto-exchanges?apiKey=*

Response Attributes
responsearray
idinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


marketstring

Market data type this exchange contains ( crypto only currently )


namestring

Name of the exchange


typestring

Type of exchange feed


urlstring

URL of this exchange


Response Object

[
 {
  "id": 1,
  "market": "crypto",
  "name": "Coinbase",
  "type": "exchange",
  "url": "https://www.coinbase.com/"
 },
 {
  "id": 2,
  "market": "crypto",
  "name": "BITFINEX",
  "type": "exchange",
  "url": "https://www.bitfinex.com/"
 },
 {
  "id": 6,
  "market": "crypto",
  "name": "Bitstamp",
  "type": "exchange",
  "url": "https://www.bitstamp.net/"
 },
 {
  "id": 23,
  "market": "crypto",
  "name": "Kraken",
  "type": "exchange",
  "url": "https://www.kraken.com/en-us/"
 }
]

Exchanges v3

get
/v3/reference/exchanges

List all exchanges that Polygon.io knows about.

Parameters

Filter by asset class.

Filter by locale.

https://api.polygon.io/v3/reference/exchanges?apiKey=*

Response Attributes
countinteger

The total number of results for this request.


request_id*string

A request ID assigned by the server.


resultsarray
acronymstring

A commonly used abbreviation for this exchange.


asset_class*enum [stocks, options, crypto, fx]

An identifier for a group of similar financial instruments.


id*integer

A unique identifier used by Polygon.io for this exchange.


locale*enum [us, global]

An identifier for a geographical location.


micstring

The Market Identifer Code of this exchange (see ISO 10383).


name*string

Name of this exchange.


operating_micstring

The MIC of the entity that operates this exchange.


participant_idstring

The ID used by SIP's to represent this exchange.


type*enum [exchange, TRF, SIP]

Represents the type of exchange.


urlstring

A link to this exchange's website, if one exists.


status*string

The status of this request's response.


Response Object

{
 "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"
}

Locales

get
/v2/reference/locales

Get a list of locales currently supported by Polygon.io.

https://api.polygon.io/v2/reference/locales?apiKey=*

Response Attributes
statusstring

The status of this request's response.


resultsarray
localestring

An abbreviated country name.


namestring

The name of the country.


Response Object

{
 "results": [
  {
   "locale": "G",
   "name": "Global"
  },
  {
   "locale": "US",
   "name": "United States of America"
  },
  {
   "locale": "GB",
   "name": "Great Britain"
  },
  {
   "locale": "CA",
   "name": "Canada"
  },
  {
   "locale": "NL",
   "name": "Netherlands"
  },
  {
   "locale": "GR",
   "name": "Greece"
  },
  {
   "locale": "SP",
   "name": "Spain"
  },
  {
   "locale": "DE",
   "name": "Germany"
  },
  {
   "locale": "BE",
   "name": "Belgium"
  },
  {
   "locale": "DK",
   "name": "Denmark"
  },
  {
   "locale": "FI",
   "name": "Finland"
  },
  {
   "locale": "IE",
   "name": "Ireland"
  },
  {
   "locale": "PT",
   "name": "Portugal"
  },
  {
   "locale": "IN",
   "name": "India"
  },
  {
   "locale": "MX",
   "name": "Mexico"
  },
  {
   "locale": "FR",
   "name": "France"
  },
  {
   "locale": "CN",
   "name": "China"
  },
  {
   "locale": "CH",
   "name": "Switzerland"
  },
  {
   "locale": "SE",
   "name": "Sweden"
  }
 ],
 "status": "OK"
}

Markets

get
/v2/reference/markets

Get a list of markets that are currently supported by Polygon.io.

https://api.polygon.io/v2/reference/markets?apiKey=*

Response Attributes
statusstring

The status of this request's response.


resultsarray

A list of supported markets.

descstring

A description of the market.


marketstring

The name of the market.


Response Object

{
 "results": [
  {
   "desc": "Stocks / Equities / ETFs",
   "market": "STOCKS"
  },
  {
   "desc": "Indices",
   "market": "INDICES"
  },
  {
   "desc": "Mutual Funds",
   "market": "MF"
  },
  {
   "desc": "Money Market Funds",
   "market": "MMF"
  },
  {
   "desc": "Crypto",
   "market": "CRYPTO"
  },
  {
   "desc": "Forex / Currencies",
   "market": "FX"
  },
  {
   "desc": "Bonds",
   "market": "BONDS"
  }
 ],
 "status": "OK"
}

Trades

get
/v2/ticks/stocks/trades/{ticker}/{date}

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

Parameters

The ticker symbol we want trades for.

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.

The maximum timestamp allowed in the results.

Reverse the order of the results.

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

https://api.polygon.io/v2/ticks/stocks/trades/{ticker}/{date}?apiKey=*

Response Attributes
db_latencyinteger

Latency in milliseconds for the query results from the database.


results_countinteger

The total number of results for this request.


successboolean

Whether or not this query was executed successfully.


tickerstring

The exchange symbol that this item is traded under.


resultsarray
Tstring

The exchange symbol that this item is traded under.


finteger

The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.


qinteger

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).


tinteger

The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.


yinteger

The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.


carray [integer]

A list of condition codes.


einteger

The trade correction indicator.


istring

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.


pnumber

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.


rinteger

The ID for the Trade Reporting Facility where the trade took place.


snumber

The size of a trade (also known as volume).


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


zinteger

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

Response Object

{
 "db_latency": 11,
 "map": {
  "I": {
   "name": "orig_id",
   "type": "string"
  },
  "c": {
   "name": "conditions",
   "type": "int"
  },
  "e": {
   "name": "correction",
   "type": "int"
  },
  "f": {
   "name": "trf_timestamp",
   "type": "int64"
  },
  "i": {
   "name": "id",
   "type": "string"
  },
  "p": {
   "name": "price",
   "type": "float64"
  },
  "q": {
   "name": "sequence_number",
   "type": "int64"
  },
  "r": {
   "name": "trf_id",
   "type": "int"
  },
  "s": {
   "name": "size",
   "type": "int"
  },
  "t": {
   "name": "sip_timestamp",
   "type": "int64"
  },
  "x": {
   "name": "exchange",
   "type": "int"
  },
  "y": {
   "name": "participant_timestamp",
   "type": "int64"
  },
  "z": {
   "name": "tape",
   "type": "int"
  }
 },
 "results": [
  {
   "c": [
    12,
    41
   ],
   "i": "1",
   "p": 171.55,
   "q": 1063,
   "s": 100,
   "t": 1517562000016036600,
   "x": 11,
   "y": 1517562000015577000,
   "z": 3
  },
  {
   "c": [
    12,
    41
   ],
   "i": "2",
   "p": 171.55,
   "q": 1064,
   "s": 100,
   "t": 1517562000016038100,
   "x": 11,
   "y": 1517562000015577600,
   "z": 3
  }
 ],
 "results_count": 2,
 "success": true,
 "ticker": "AAPL"
}

Quotes (NBBO)

get
/v2/ticks/stocks/nbbo/{ticker}/{date}

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

Parameters

The ticker symbol we want quotes for.

The date/day of the quotes 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.

The maximum timestamp allowed in the results.

Reverse the order of the results.

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

https://api.polygon.io/v2/ticks/stocks/nbbo/{ticker}/{date}?apiKey=*

Response Attributes
db_latencyinteger

Latency in milliseconds for the query results from the database.


results_countinteger

The total number of results for this request.


successboolean

Whether or not this query was executed successfully.


tickerstring

The exchange symbol that this item is traded under.


resultsarray
Tstring

The exchange symbol that this item is traded under.


finteger

The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.


qinteger

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).


tinteger

The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.


yinteger

The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.


Pnumber

The ask price.


Sinteger

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.


Xinteger

Ask Exchange Id


carray [integer]

A list of condition codes.


iarray [integer]

The indicators. For more information, see our glossary of Conditions and Indicators.


pnumber

The bid price.


sinteger

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.


xinteger

Bid Exchange Id


zinteger

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

Response Object

{
 "db_latency": 43,
 "map": {
  "P": {
   "name": "ask_price",
   "type": "float64"
  },
  "S": {
   "name": "ask_size",
   "type": "int"
  },
  "X": {
   "name": "ask_exchange",
   "type": "int"
  },
  "c": {
   "name": "conditions",
   "type": "int"
  },
  "f": {
   "name": "trf_timestamp",
   "type": "int64"
  },
  "i": {
   "name": "indicators",
   "type": "int"
  },
  "p": {
   "name": "bid_price",
   "type": "float64"
  },
  "q": {
   "name": "sequence_number",
   "type": "int"
  },
  "s": {
   "name": "bid_size",
   "type": "int"
  },
  "t": {
   "name": "sip_timestamp",
   "type": "int64"
  },
  "x": {
   "name": "bid_exchange",
   "type": "int"
  },
  "y": {
   "name": "participant_timestamp",
   "type": "int64"
  },
  "z": {
   "name": "tape",
   "type": "int"
  }
 },
 "results": [
  {
   "P": 0,
   "S": 0,
   "X": 0,
   "c": [
    1
   ],
   "p": 102.7,
   "q": 2060,
   "s": 60,
   "t": 1517562000065700400,
   "x": 11,
   "y": 1517562000065321200,
   "z": 3
  },
  {
   "P": 0,
   "S": 0,
   "X": 0,
   "c": [
    1
   ],
   "p": 170,
   "q": 2061,
   "s": 2,
   "t": 1517562000065791500,
   "x": 11,
   "y": 1517562000065408300,
   "z": 3
  }
 ],
 "results_count": 2,
 "success": true,
 "ticker": "AAPL"
}

Last Trade

get
/v2/last/trade/{stocksTicker}

Get the most recent trade for a given stock.

Parameters

The ticker symbol of the stock/equity.

https://api.polygon.io/v2/last/trade/{stocksTicker}?apiKey=*

Response Attributes
request_idstring

A request id assigned by the server.


statusstring

The status of this request's response.


resultsobject
Tstring

The exchange symbol that this item is traded under.


finteger

The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.


qinteger

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).


tinteger

The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.


yinteger

The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.


carray [integer]

A list of condition codes.


einteger

The trade correction indicator.


istring

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.


pnumber

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.


rinteger

The ID for the Trade Reporting Facility where the trade took place.


snumber

The size of a trade (also known as volume).


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


zinteger

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

Response Object

{
 "request_id": "f05562305bd26ced64b98ed68b3c5d96",
 "results": {
  "T": "AAPL",
  "c": [
   37
  ],
  "f": 1617901342969796400,
  "i": "118749",
  "p": 129.8473,
  "q": 3135876,
  "r": 202,
  "s": 25,
  "t": 1617901342969834000,
  "x": 4,
  "y": 1617901342968000000,
  "z": 3
 },
 "status": "OK"
}

Last Quote

get
/v2/last/nbbo/{stocksTicker}

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

Parameters

The ticker symbol of the stock/equity.

https://api.polygon.io/v2/last/nbbo/{stocksTicker}?apiKey=*

Response Attributes
request_idstring

A request id assigned by the server.


statusstring

The status of this request's response.


resultsobject
Tstring

The exchange symbol that this item is traded under.


finteger

The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.


qinteger

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).


tinteger

The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.


yinteger

The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.


Pnumber

The ask price.


Sinteger

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.


Xinteger

Ask Exchange Id


carray [integer]

A list of condition codes.


iarray [integer]

The indicators. For more information, see our glossary of Conditions and Indicators.


pnumber

The bid price.


sinteger

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.


xinteger

Bid Exchange Id


zinteger

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

Response Object

{
 "request_id": "b84e24636301f19f88e0dfbf9a45ed5c",
 "results": {
  "P": 127.98,
  "S": 7,
  "T": "AAPL",
  "X": 19,
  "p": 127.96,
  "q": 83480742,
  "s": 1,
  "t": 1617827221349730300,
  "x": 11,
  "y": 1617827221349366000,
  "z": 3
 },
 "status": "OK"
}

Daily Open/Close

get
/v1/open-close/{stocksTicker}/{date}

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

Parameters

The ticker symbol of the stock/equity.

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.

https://api.polygon.io/v1/open-close/{stocksTicker}/{date}?apiKey=*

Response Attributes
afterHoursnumber

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


closenumber

The close price for the symbol in the given time period.


fromstring

The requested date.


highnumber

The highest price for the symbol in the given time period.


lownumber

The lowest price for the symbol in the given time period.


opennumber

The open price for the symbol in the given time period.


preMarketinteger

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


statusstring

The status of this request's response.


symbolstring

The exchange symbol that this item is traded under.


volumenumber

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


Response Object

{
 "afterHours": 322.1,
 "close": 325.12,
 "from": "2020-10-14T00:00:00.000Z",
 "high": 326.2,
 "low": 322.3,
 "open": 324.66,
 "preMarket": 324.5,
 "status": "OK",
 "symbol": "AAPL",
 "volume": 26122646
}

Aggregates (Bars)

get
/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}

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.

Parameters

The ticker symbol of the stock/equity.

The size of the timespan multiplier.

The size of the time window.

The start of the aggregate time window.

The end of the aggregate time window.

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.

https://api.polygon.io/v2/aggs/ticker/{stocksTicker}/range/{multiplier}/{timespan}/{from}/{to}?apiKey=*

Response Attributes
tickerstring

The exchange symbol that this item is traded under.


adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


nnumber

The number of transactions in the aggregate window.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


vwnumber

The volume weighted average price.


Response Object

{
 "adjusted": true,
 "queryCount": 2,
 "request_id": "6a7e466379af0a71039d60cc78e72282",
 "results": [
  {
   "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
  }
 ],
 "resultsCount": 2,
 "status": "OK",
 "ticker": "AAPL"
}

Grouped Daily (Bars)

get
/v2/aggs/grouped/locale/us/market/stocks/{date}

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

Parameters

The beginning date for the aggregate window.

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.

https://api.polygon.io/v2/aggs/grouped/locale/us/market/stocks/{date}?apiKey=*

Response Attributes
adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
Tstring

The exchange symbol that this item is traded under.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


nnumber

The number of transactions in the aggregate window.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


vwnumber

The volume weighted average price.


Response Object

{
 "adjusted": true,
 "queryCount": 3,
 "results": [
  {
   "T": "C:AUDCHF",
   "c": 0.6619247,
   "h": 0.6643625,
   "l": 0.6596,
   "o": 0.6618886,
   "t": 1599796800000,
   "v": 160131
  },
  {
   "T": "C:AUDCAD",
   "c": 0.9598082,
   "h": 0.9620029,
   "l": 0.9575,
   "o": 0.9584955,
   "t": 1599796800000,
   "v": 92488
  },
  {
   "T": "C:AUDBGN",
   "c": 1.2009374,
   "h": 1.2055938,
   "l": 1.199437,
   "o": 1.2023558,
   "t": 1599796800000,
   "v": 87209
  }
 ],
 "resultsCount": 3,
 "status": "OK"
}

Previous Close

get
/v2/aggs/ticker/{stocksTicker}/prev

Get the previous day's open, high, low, and close (OHLC) for the specified stock ticker.

Parameters

The ticker symbol of the stock/equity.

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.

https://api.polygon.io/v2/aggs/ticker/{stocksTicker}/prev?apiKey=*

Response Attributes
tickerstring

The exchange symbol that this item is traded under.


adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


nnumber

The number of transactions in the aggregate window.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


vwnumber

The volume weighted average price.


Response Object

{
 "adjusted": true,
 "queryCount": 1,
 "request_id": "6a7e466379af0a71039d60cc78e72282",
 "results": [
  {
   "T": "AAPL",
   "c": 115.97,
   "h": 117.59,
   "l": 114.13,
   "o": 115.55,
   "t": 1605042000000,
   "v": 131704427,
   "vw": 116.3058
  }
 ],
 "resultsCount": 1,
 "status": "OK",
 "ticker": "AAPL"
}

Snapshot - All Tickers

get
/v2/snapshot/locale/us/markets/stocks/tickers

Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded stock symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.

Parameters

A comma separated list of tickers to get snapshots for.

https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/tickers?apiKey=*

Response Attributes
countinteger

The total number of results for this request.


statusstring

The status of this request's response.


tickersarray
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


lastQuoteobject
Pnumber

The ask price.


Sinteger

The ask size in lots.


pnumber

The bid price.


sinteger

The bid size in lots.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


lastTradeobject
carray [string]

The trade conditions.


istring

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.


pnumber

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.


sinteger

The size (volume) of the trade.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


minobject

The last available minute bar.

avinteger

The accumulated volume.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "count": 1,
 "status": "OK",
 "tickers": [
  {
   "day": {
    "c": 20.506,
    "h": 20.64,
    "l": 20.506,
    "o": 20.64,
    "v": 37216,
    "vw": 20.616
   },
   "lastQuote": {
    "P": 20.6,
    "S": 22,
    "p": 20.5,
    "s": 13,
    "t": 1605192959994246100
   },
   "lastTrade": {
    "c": [
     14,
     41
    ],
    "i": "71675577320245",
    "p": 20.506,
    "s": 2416,
    "t": 1605192894630916600,
    "x": 4
   },
   "min": {
    "av": 37216,
    "c": 20.506,
    "h": 20.506,
    "l": 20.506,
    "o": 20.506,
    "v": 5000,
    "vw": 20.5105
   },
   "prevDay": {
    "c": 20.63,
    "h": 21,
    "l": 20.5,
    "o": 20.79,
    "v": 292738,
    "vw": 20.6939
   },
   "ticker": "BCAT",
   "todaysChange": -0.124,
   "todaysChangePerc": -0.601,
   "updated": 1605192894630916600
  }
 ]
}

Snapshot - Gainers/Losers

get
/v2/snapshot/locale/us/markets/stocks/{direction}

Get the current top 20 gainers or losers of the day in stocks/equities markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day's close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day's close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

Parameters

The direction of the snapshot results to return.

https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/{direction}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


tickersarray
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


lastQuoteobject
Pnumber

The ask price.


Sinteger

The ask size in lots.


pnumber

The bid price.


sinteger

The bid size in lots.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


lastTradeobject
carray [string]

The trade conditions.


istring

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.


pnumber

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.


sinteger

The size (volume) of the trade.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


minobject

The last available minute bar.

avinteger

The accumulated volume.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "status": "OK",
 "tickers": [
  {
   "day": {
    "c": 14.2284,
    "h": 15.09,
    "l": 14.2,
    "o": 14.33,
    "v": 133963,
    "vw": 14.5311
   },
   "lastQuote": {
    "P": 14.44,
    "S": 11,
    "p": 14.2,
    "s": 25,
    "t": 1605195929997325600
   },
   "lastTrade": {
    "c": [
     63
    ],
    "i": "79372124707124",
    "p": 14.2284,
    "s": 536,
    "t": 1605195848258266000,
    "x": 4
   },
   "min": {
    "av": 133963,
    "c": 14.2284,
    "h": 14.325,
    "l": 14.2,
    "o": 14.28,
    "v": 6108,
    "vw": 14.2426
   },
   "prevDay": {
    "c": 0.73,
    "h": 0.799,
    "l": 0.73,
    "o": 0.75,
    "v": 1568097,
    "vw": 0.7721
   },
   "ticker": "PDS",
   "todaysChange": 13.498,
   "todaysChangePerc": 1849.096,
   "updated": 1605195848258266000
  }
 ]
}

Snapshot - Ticker

get
/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}

Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded stock ticker.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.

Parameters

The ticker symbol of the stock/equity.

https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


tickerobject
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


lastQuoteobject
Pnumber

The ask price.


Sinteger

The ask size in lots.


pnumber

The bid price.


sinteger

The bid size in lots.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


lastTradeobject
carray [string]

The trade conditions.


istring

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.


pnumber

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.


sinteger

The size (volume) of the trade.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


minobject

The last available minute bar.

avinteger

The accumulated volume.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "status": "OK",
 "ticker": {
  "day": {
   "c": 120.4229,
   "h": 120.53,
   "l": 118.81,
   "o": 119.62,
   "v": 28727868,
   "vw": 119.725
  },
  "lastQuote": {
   "P": 120.47,
   "S": 4,
   "p": 120.46,
   "s": 8,
   "t": 1605195918507251700
  },
  "lastTrade": {
   "c": [
    14,
    41
   ],
   "i": "4046",
   "p": 120.47,
   "s": 236,
   "t": 1605195918306274000,
   "x": 10
  },
  "min": {
   "av": 28724441,
   "c": 120.4201,
   "h": 120.468,
   "l": 120.37,
   "o": 120.435,
   "v": 270796,
   "vw": 120.4129
  },
  "prevDay": {
   "c": 119.49,
   "h": 119.63,
   "l": 116.44,
   "o": 117.19,
   "v": 110597265,
   "vw": 118.4998
  },
  "ticker": "AAPL",
  "todaysChange": 0.98,
  "todaysChangePerc": 0.82,
  "updated": 1605195918306274000
 }
}

Last Trade

get
/v2/last/trade/{optionsTicker}

Get the most recent trade for a given options contract.

Options is currently being rolled out to certain beta users. Contact us to inquire about early access.Contact Us
Parameters

The ticker symbol of the options contract.

https://api.polygon.io/v2/last/trade/{optionsTicker}?apiKey=*

Response Attributes
request_idstring

A request id assigned by the server.


statusstring

The status of this request's response.


resultsobject
Tstring

The exchange symbol that this item is traded under.


finteger

The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.


qinteger

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).


tinteger

The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.


yinteger

The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.


carray [integer]

A list of condition codes.


einteger

The trade correction indicator.


istring

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.


pnumber

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.


rinteger

The ID for the Trade Reporting Facility where the trade took place.


snumber

The size of a trade (also known as volume).


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


zinteger

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

Response Object

{
 "request_id": "f05562305bd26ced64b98ed68b3c5d96",
 "results": {
  "T": "O:TSLA210903C00700000",
  "c": [
   227
  ],
  "f": 1617901342969796400,
  "i": "",
  "p": 33.13,
  "q": 1325541950,
  "r": 202,
  "s": 25,
  "t": 1617901342969834000,
  "x": 312
 },
 "status": "OK"
}

Historic Forex Ticks

get
/v1/historic/forex/{from}/{to}/{date}

Get historic ticks for a forex currency pair.

Parameters

The "from" symbol of the currency pair.

Example: For USD/JPY the from would be USD.

The "to" symbol of the currency pair.

Example: For USD/JPY the to would be JPY.

The date/day of the historic ticks to retrieve.

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.

Limit the size of the response, max 10000.

https://api.polygon.io/v1/historic/forex/{from}/{to}/{date}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


daystring

The date that was evaluated from the request.


mapobject

A map for shortened result keys.

msLatencyinteger

The milliseconds of latency for the query results.


pairstring

The currency pair that was evaluated from the request.


ticksarray
anumber

The ask price.


bnumber

The bid price.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


Response Object

{
 "day": "2020-10-14",
 "map": {
  "ap": "ask",
  "bp": "bid",
  "t": "timestamp"
 },
 "msLatency": "0",
 "pair": "AUD/USD",
 "status": "success",
 "ticks": [
  {
   "ap": 0.71703,
   "bp": 0.71701,
   "t": 1602633600000,
   "x": 48
  },
  {
   "ap": 0.71703,
   "bp": 0.717,
   "t": 1602633600000,
   "x": 48
  },
  {
   "ap": 0.71702,
   "bp": 0.717,
   "t": 1602633600000,
   "x": 48
  }
 ],
 "type": "forex"
}

Real-time Currency Conversion

get
/v1/conversion/{from}/{to}

Get currency conversions using the latest market conversion rates. Note than you can convert in both directions. For example USD to CAD or CAD to USD.

Parameters

The "from" symbol of the pair.

The "to" symbol of the pair.

The amount to convert, with a decimal.

The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy.

https://api.polygon.io/v1/conversion/{from}/{to}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


convertednumber

The result of the conversion.


fromstring

The "from" currency symbol.


initialAmountnumber

The amount to convert.


lastobject
asknumber

The ask price.


bidnumber

The bid price.


exchangeinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


timestampinteger

The Unix Msec timestamp for the start of the aggregate window.


tostring

The "to" currency symbol.


Response Object

{
 "converted": 73.14,
 "from": "AUD",
 "initialAmount": 100,
 "last": {
  "ask": 1.3673344,
  "bid": 1.3672596,
  "exchange": 48,
  "timestamp": 1605555313000
 },
 "status": "success",
 "to": "USD"
}

Last Quote for a Currency Pair

get
/v1/last_quote/currencies/{from}/{to}

Get the last quote tick for a forex currency pair.

Parameters

The "from" symbol of the pair.

The "to" symbol of the pair.

https://api.polygon.io/v1/last_quote/currencies/{from}/{to}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


request_idstring

A request id assigned by the server.


lastobject
asknumber

The ask price.


bidnumber

The bid price.


exchangeinteger

The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.


timestampinteger

The Unix Msec timestamp for the start of the aggregate window.


symbolstring

The symbol pair that was evaluated from the request.


Response Object

{
 "last": {
  "ask": 0.73124,
  "bid": 0.73122,
  "exchange": 48,
  "timestamp": 1605557756000
 },
 "request_id": "a73a29dbcab4613eeaf48583d3baacf0",
 "status": "success",
 "symbol": "AUD/USD"
}

Aggregates (Bars)

get
/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}

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

Parameters

The ticker symbol of the currency pair.

The size of the timespan multiplier.

The size of the time window.

The start of the aggregate time window.

The end of the aggregate time window.

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.

https://api.polygon.io/v2/aggs/ticker/{forexTicker}/range/{multiplier}/{timespan}/{from}/{to}?apiKey=*

Response Attributes
tickerstring

The exchange symbol that this item is traded under.


adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


nnumber

The number of transactions in the aggregate window.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


Response Object

{
 "adjusted": true,
 "queryCount": 2,
 "request_id": "bb8fedcdc2e6237fc61f32024602593b",
 "results": [
  {
   "c": 1.1126,
   "h": 1.11536,
   "l": 1.1099,
   "n": 1,
   "o": 1.11327,
   "t": 1590984000000,
   "v": 126690
  },
  {
   "c": 1.12084,
   "h": 1.12111,
   "l": 1.1114,
   "n": 1,
   "o": 1.11269,
   "t": 1591070400000,
   "v": 155844
  }
 ],
 "resultsCount": 2,
 "status": "OK",
 "ticker": "C:EURUSD"
}

Grouped Daily (Bars)

get
/v2/aggs/grouped/locale/global/market/fx/{date}

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

Parameters

The beginning date for the aggregate window.

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.

https://api.polygon.io/v2/aggs/grouped/locale/global/market/fx/{date}?apiKey=*

Response Attributes
adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
Tstring

The exchange symbol that this item is traded under.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


Response Object

{
 "adjusted": true,
 "queryCount": 3,
 "results": [
  {
   "T": "C:CZKMXN",
   "c": 0.97531,
   "h": 0.9884522,
   "l": 0.97468,
   "o": 0.98688,
   "t": 1599019200000,
   "v": 29035
  },
  {
   "T": "C:GBPCAD",
   "c": 1.74102,
   "h": 1.748579,
   "l": 1.73482,
   "o": 1.74807,
   "t": 1599019200000,
   "v": 174749
  },
  {
   "T": "C:DKKAUD",
   "c": 0.217072,
   "h": 0.2176943,
   "l": 0.2166342,
   "o": 0.217479,
   "t": 1599019200000,
   "v": 97005
  }
 ],
 "resultsCount": 3,
 "status": "OK"
}

Previous Close

get
/v2/aggs/ticker/{forexTicker}/prev

Get the previous day's open, high, low, and close (OHLC) for the specified forex pair.

Parameters

The ticker symbol of the currency pair.

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.

https://api.polygon.io/v2/aggs/ticker/{forexTicker}/prev?apiKey=*

Response Attributes
tickerstring

The exchange symbol that this item is traded under.


adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
Tstring

The exchange symbol that this item is traded under.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


Response Object

{
 "adjusted": true,
 "queryCount": 1,
 "results": [
  {
   "T": "C:EURUSD",
   "c": 1.18522,
   "h": 1.18545,
   "l": 1.18341,
   "o": 1.18421,
   "t": 1605416400000,
   "v": 14500
  }
 ],
 "resultsCount": 1,
 "status": "OK",
 "ticker": "C:EURUSD"
}

Snapshot - All Tickers

get
/v2/snapshot/locale/global/markets/forex/tickers

Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded forex symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.

Parameters

A comma separated list of tickers to get snapshots for.

https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers?apiKey=*

Response Attributes
statusstring

The status of this request's response.


tickersarray
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


lastQuoteobject
anumber

The ask price.


bnumber

The bid price.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID on which this quote happened.


minobject

The last available minute bar.

cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "status": "OK",
 "tickers": [
  {
   "day": {
    "c": 0.11778221,
    "h": 0.11812263,
    "l": 0.11766631,
    "o": 0.11797149,
    "v": 77794
   },
   "lastQuote": {
    "a": 0.11780678,
    "b": 0.11777952,
    "t": 1605280919000,
    "x": 48
   },
   "min": {
    "c": 0.117769,
    "h": 0.11779633,
    "l": 0.11773698,
    "o": 0.11778,
    "v": 202
   },
   "prevDay": {
    "c": 0.11797258,
    "h": 0.11797258,
    "l": 0.11797149,
    "o": 0.11797149,
    "v": 2,
    "vw": 0
   },
   "ticker": "C:HKDCHF",
   "todaysChange": -0.00019306,
   "todaysChangePerc": -0.1636482,
   "updated": 1605280919000
  }
 ]
}

Snapshot - Gainers/Losers

get
/v2/snapshot/locale/global/markets/forex/{direction}

Get the current top 20 gainers or losers of the day in forex markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day's close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day's close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

Parameters

The direction of the snapshot results to return.

https://api.polygon.io/v2/snapshot/locale/global/markets/forex/{direction}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


tickersarray
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


lastQuoteobject
anumber

The ask price.


bnumber

The bid price.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID on which this quote happened.


minobject

The last available minute bar.

cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "status": "OK",
 "tickers": [
  {
   "day": {
    "c": 0.886156,
    "h": 0.887111,
    "l": 0.8825327,
    "o": 0.8844732,
    "v": 1041
   },
   "lastQuote": {
    "a": 0.8879606,
    "b": 0.886156,
    "t": 1605283204000,
    "x": 48
   },
   "min": {
    "c": 0.886156,
    "h": 0.886156,
    "l": 0.886156,
    "o": 0.886156,
    "v": 1
   },
   "prevDay": {
    "c": 0.8428527,
    "h": 0.889773,
    "l": 0.8428527,
    "o": 0.8848539,
    "v": 1078,
    "vw": 0
   },
   "ticker": "C:PLNILS",
   "todaysChange": 0.0433033,
   "todaysChangePerc": 5.13770674,
   "updated": 1605330008999
  }
 ]
}

Snapshot - Ticker

get
/v2/snapshot/locale/global/markets/forex/tickers/{ticker}

Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded currency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

Parameters

The forex ticker.

https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers/{ticker}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


request_idstring

A request id assigned by the server.


tickerobject
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


lastQuoteobject
anumber

The ask price.


bnumber

The bid price.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange ID on which this quote happened.


minobject

The last available minute bar.

cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "request_id": "ad76e76ce183002c5937a7f02dfebde4",
 "status": "OK",
 "ticker": {
  "day": {
   "c": 1.18403,
   "h": 1.1906,
   "l": 1.18001,
   "o": 1.18725,
   "v": 83578
  },
  "lastQuote": {
   "a": 1.18403,
   "b": 1.18398,
   "i": 0,
   "t": 1606163759000,
   "x": 48
  },
  "min": {
   "c": 1.18396,
   "h": 1.18423,
   "l": 1.1838,
   "o": 1.18404,
   "v": 41
  },
  "prevDay": {
   "c": 1.18724,
   "h": 1.18727,
   "l": 1.18725,
   "o": 1.18725,
   "v": 5,
   "vw": 0
  },
  "ticker": "C:EURUSD",
  "todaysChange": -0.00316,
  "todaysChangePerc": -0.27458312,
  "updated": 1606163759000
 }
}

Historic Crypto Trades

get
/v1/historic/crypto/{from}/{to}/{date}

Get historic trade ticks for a cryptocurrency pair.

Parameters

The "from" symbol of the crypto pair.

The "to" symbol of the crypto pair.

The date/day of the historic ticks to retrieve.

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.

Limit the size of the response, max 10000.

https://api.polygon.io/v1/historic/crypto/{from}/{to}/{date}?apiKey=*

Response Attributes
daystring

The date that was evaluated from the request.


mapobject

A map for shortened result keys.

msLatencyinteger

The milliseconds of latency for the query results.


symbolstring

The symbol pair that was evaluated from the request.


ticksarray
carray [integer]

A list of condition codes.


pnumber

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.


snumber

The size of a trade (also known as volume).


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


Response Object

{
 "day": "2020-10-14T00:00:00.000Z",
 "map": {
  "c": "conditions",
  "p": "price",
  "s": "size",
  "t": "timestamp",
  "x": "exchange"
 },
 "msLatency": 1,
 "status": "success",
 "symbol": "BTC-USD",
 "ticks": [
  {
   "c": [
    2
   ],
   "p": 15482.89,
   "s": 0.00188217,
   "t": 1604880000067,
   "x": 1
  },
  {
   "c": [
    2
   ],
   "p": 15482.11,
   "s": 0.00161739,
   "t": 1604880000167,
   "x": 1
  }
 ],
 "type": "crypto"
}

Last Trade for a Crypto Pair

get
/v1/last/crypto/{from}/{to}

Get the last trade tick for a cryptocurrency pair.

Parameters

The "from" symbol of the pair.

The "to" symbol of the pair.

https://api.polygon.io/v1/last/crypto/{from}/{to}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


request_idstring

A request id assigned by the server.


lastobject
conditionsarray [integer]

A list of condition codes.


exchangeinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


pricenumber

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.


sizenumber

The size of a trade (also known as volume).


timestampinteger

The Unix Msec timestamp for the start of the aggregate window.


symbolstring

The symbol pair that was evaluated from the request.


Response Object

{
 "last": {
  "conditions": [
   1
  ],
  "exchange": 4,
  "price": 16835.42,
  "size": 0.006909,
  "timestamp": 1605560885027
 },
 "request_id": "d2d779df015fe2b7fbb8e58366610ef7",
 "status": "success",
 "symbol": "BTC-USD"
}

Daily Open/Close

get
/v1/open-close/crypto/{from}/{to}/{date}

Get the open, close prices of a cryptocurrency symbol on a certain day.

Parameters

The "from" symbol of the pair.

The "to" symbol of the pair.

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.

https://api.polygon.io/v1/open-close/crypto/{from}/{to}/{date}?apiKey=*

Response Attributes
closenumber

The close price for the symbol in the given time period.


closingTradesarray
carray [integer]

A list of condition codes.


pnumber

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.


snumber

The size of a trade (also known as volume).


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


daystring

The date requested.


isUTCboolean

Whether or not the timestamps are in UTC timezone.


opennumber

The open price for the symbol in the given time period.


openTradesarray
carray [integer]

A list of condition codes.


pnumber

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.


snumber

The size of a trade (also known as volume).


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


symbolstring

The symbol pair that was evaluated from the request.


Response Object

{
 "close": 11050.64,
 "closingTrades": [
  {
   "c": [
    2
   ],
   "p": 11050.64,
   "s": 0.006128,
   "t": 1602287999795,
   "x": 4
  },
  {
   "c": [
    1
   ],
   "p": 11049.4,
   "s": 0.014,
   "t": 1602287999659,
   "x": 17
  }
 ],
 "day": "2020-10-09T00:00:00.000Z",
 "isUTC": true,
 "open": 10932.44,
 "openTrades": [
  {
   "c": [
    2
   ],
   "p": 10932.44,
   "s": 0.002,
   "t": 1602201600056,
   "x": 1
  },
  {
   "c": [
    2
   ],
   "p": 10923.76,
   "s": 0.02,
   "t": 1602201600141,
   "x": 4
  }
 ],
 "symbol": "BTC-USD"
}

Aggregates (Bars)

get
/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}

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

Parameters

The ticker symbol of the currency pair.

The size of the timespan multiplier.

The size of the time window.

The start of the aggregate time window.

The end of the aggregate time window.

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.

https://api.polygon.io/v2/aggs/ticker/{cryptoTicker}/range/{multiplier}/{timespan}/{from}/{to}?apiKey=*

Response Attributes
tickerstring

The exchange symbol that this item is traded under.


adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


nnumber

The number of transactions in the aggregate window.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


vwnumber

The volume weighted average price.


Response Object

{
 "adjusted": true,
 "queryCount": 2,
 "request_id": "0cf72b6da685bcd386548ffe2895904a",
 "results": [
  {
   "c": 10094.75,
   "h": 10429.26,
   "l": 9490,
   "n": 1,
   "o": 9557.9,
   "t": 1590984000000,
   "v": 303067.6562332156,
   "vw": 9874.5529
  },
  {
   "c": 9492.62,
   "h": 10222.72,
   "l": 9135.68,
   "n": 1,
   "o": 10096.87,
   "t": 1591070400000,
   "v": 323339.6922892879,
   "vw": 9729.5701
  }
 ],
 "resultsCount": 2,
 "status": "OK",
 "ticker": "X:BTCUSD"
}

Grouped Daily (Bars)

get
/v2/aggs/grouped/locale/global/market/crypto/{date}

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

Parameters

The beginning date for the aggregate window.

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.

https://api.polygon.io/v2/aggs/grouped/locale/global/market/crypto/{date}?apiKey=*

Response Attributes
adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
Tstring

The exchange symbol that this item is traded under.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


vwnumber

The volume weighted average price.


Response Object

{
 "adjusted": true,
 "queryCount": 3,
 "results": [
  {
   "T": "X:ARDRUSD",
   "c": 0.0550762,
   "h": 0.0550762,
   "l": 0.0550762,
   "o": 0.0550762,
   "t": 1580676480000,
   "v": 2,
   "vw": 0.0551
  },
  {
   "T": "X:NGCUSD",
   "c": 0.0272983,
   "h": 0.0273733,
   "l": 0.0272983,
   "o": 0.0273733,
   "t": 1580674080000,
   "v": 4734,
   "vw": 0.0273
  },
  {
   "T": "X:ZSCUSD",
   "c": 0.00028531,
   "h": 0.00028531,
   "l": 0.00028531,
   "o": 0.00028531,
   "t": 1580671080000,
   "v": 390,
   "vw": 0.0003
  }
 ],
 "resultsCount": 3,
 "status": "OK"
}

Previous Close

get
/v2/aggs/ticker/{cryptoTicker}/prev

Get the previous day's open, high, low, and close (OHLC) for the specified cryptocurrency pair.

Parameters

The ticker symbol of the currency pair.

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.

https://api.polygon.io/v2/aggs/ticker/{cryptoTicker}/prev?apiKey=*

Response Attributes
tickerstring

The exchange symbol that this item is traded under.


adjustedboolean

Whether or not this response was adjusted for splits.


queryCountinteger

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


request_idstring

A request id assigned by the server.


resultsCountinteger

The total number of results for this request.


statusstring

The status of this request's response.


resultsarray
Tstring

The exchange symbol that this item is traded under.


cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


vnumber

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


vwnumber

The volume weighted average price.


Response Object

{
 "adjusted": true,
 "queryCount": 1,
 "results": [
  {
   "T": "X:BTCUSD",
   "c": 16035.9,
   "h": 16180,
   "l": 15639.2,
   "o": 15937.1,
   "t": 1605416400000,
   "v": 95045.16897951,
   "vw": 15954.2111
  }
 ],
 "resultsCount": 1,
 "status": "OK",
 "ticker": "X:BTCUSD"
}

Snapshot - All Tickers

get
/v2/snapshot/locale/global/markets/crypto/tickers

Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.

Parameters

A comma separated list of tickers to get snapshots for.

https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers?apiKey=*

Response Attributes
statusstring

The status of this request's response.


tickersarray
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


lastTradeobject
carray [string]

The trade conditions.


istring

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.


pnumber

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.


sinteger

The size (volume) of the trade.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


minobject

The last available minute bar.

cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "status": "OK",
 "tickers": [
  {
   "day": {
    "c": 0.296,
    "h": 0.59714,
    "l": 0.23706,
    "o": 0.28,
    "v": 4097699.5691991993,
    "vw": 0
   },
   "lastTrade": {
    "c": [
     1
    ],
    "i": 413131,
    "p": 0.293,
    "s": 13.6191,
    "t": 1605292686010,
    "x": 17
   },
   "min": {
    "c": 0.296,
    "h": 0.296,
    "l": 0.294,
    "o": 0.296,
    "v": 123.4866,
    "vw": 0
   },
   "prevDay": {
    "c": 0.281,
    "h": 0.59714,
    "l": 0.23706,
    "o": 0.27,
    "v": 6070178.786154971,
    "vw": 0.4076
   },
   "ticker": "X:FSNUSD",
   "todaysChange": 0.012,
   "todaysChangePerc": 4.270463,
   "updated": 1605330008999
  }
 ]
}

Snapshot - Gainers/Losers

get
/v2/snapshot/locale/global/markets/crypto/{direction}

Get the current top 20 gainers or losers of the day in cryptocurrency markets.

Top gainers are those tickers whose price has increased by the highest percentage since the previous day's close. Top losers are those tickers whose price has decreased by the highest percentage since the previous day's close.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

Parameters

The direction of the snapshot results to return.

https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/{direction}?apiKey=*

Response Attributes
tickersarray
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


lastTradeobject
carray [string]

The trade conditions.


istring

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.


pnumber

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.


sinteger

The size (volume) of the trade.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


minobject

The last available minute bar.

cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "status": "OK",
 "tickers": [
  {
   "day": {
    "c": 0.0374,
    "h": 0.062377,
    "l": 0.01162,
    "o": 0.044834,
    "v": 27313165.159427017,
    "vw": 0
   },
   "lastTrade": {
    "c": [
     2
    ],
    "i": "517478762",
    "p": 0.0374,
    "s": 499,
    "t": 1604409649544,
    "x": 2
   },
   "min": {
    "c": 0.062377,
    "h": 0.062377,
    "l": 0.062377,
    "o": 0.062377,
    "v": 35420,
    "vw": 0
   },
   "prevDay": {
    "c": 0.01162,
    "h": 0.044834,
    "l": 0.01162,
    "o": 0.044834,
    "v": 53616273.36827199,
    "vw": 0.0296
   },
   "ticker": "X:DRNUSD",
   "todaysChange": 0.02578,
   "todaysChangePerc": 221.858864,
   "updated": 1605330008999
  }
 ]
}

Snapshot - Ticker

get
/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}

Get the current minute, day, and previous day’s aggregate, as well as the last trade and quote for a single traded cryptocurrency symbol.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

Parameters

Ticker of the snapshot

https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}?apiKey=*

Response Attributes
statusstring

The status of this request's response.


request_idstring

A request id assigned by the server.


tickerobject
dayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


lastTradeobject
carray [string]

The trade conditions.


istring

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.


pnumber

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.


sinteger

The size (volume) of the trade.


tinteger

The Unix Msec timestamp for the start of the aggregate window.


xinteger

The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.


minobject

The last available minute bar.

cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


prevDayobject
cnumber

The close price for the symbol in the given time period.


hnumber

The highest price for the symbol in the given time period.


lnumber

The lowest price for the symbol in the given time period.


onumber

The open price for the symbol in the given time period.


vnumber

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


vwnumber

The volume weighted average price.


tickerstring

The exchange symbol that this item is traded under.


todaysChangenumber

The value of the change the from previous day.


todaysChangePercnumber

The percentage change since the previous day.


updatedinteger

The last updated timestamp.


Response Object

{
 "request_id": "ad92e92ce183112c593717f00dfebd2c",
 "status": "OK",
 "ticker": {
  "day": {
   "c": 16260.85,
   "h": 16428.4,
   "l": 15830.4,
   "o": 16418.07,
   "v": 105008.84231068,
   "vw": 0
  },
  "lastTrade": {
   "c": [
    2
   ],
   "i": "464569520",
   "p": 16242.31,
   "s": 0.001933,
   "t": 1605294230780,
   "x": 4
  },
  "min": {
   "c": 16235.1,
   "h": 16264.29,
   "l": 16129.3,
   "o": 16257.51,
   "v": 19.30791925,
   "vw": 0
  },
  "prevDay": {
   "c": 16399.24,
   "h": 16418.07,
   "l": 16399.24,
   "o": 16418.07,
   "v": 0.99167108,
   "vw": 16402.6893
  },
  "ticker": "X:BTCUSD",
  "todaysChange": -156.93,
  "todaysChangePerc": -0.956935,
  "updated": 1605330008999
 }
}

Snapshot - Ticker Full Book (L2)

get
/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book

Get the current level 2 book of a single ticker. This is the combined book from all of the exchanges.

Note: Snapshot data is cleared at 12am EST and gets populated as data is received from the exchanges.

Parameters

The cryptocurrency ticker.

https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book?apiKey=*

Response Attributes
askCountnumber

The combined total number of asks in the book.


asksarray
pnumber

The price of this book level.


xobject

A map of the exchange ID to number of shares at this price level.

Example:
{ "p": 16302.94, "x": { "1": 0.02859424, "6": 0.023455 } }

In this example, exchange ID 1 has 0.02859424 shares available at $16,302.94, and exchange ID 6 has 0.023455 shares at the same price level.

bidCountnumber

The combined total number of bids in the book.


bidsarray
pnumber

The price of this book level.


xobject

A map of the exchange ID to number of shares at this price level.

Example:
{ "p": 16302.94, "x": { "1": 0.02859424, "6": 0.023455 } }

In this example, exchange ID 1 has 0.02859424 shares available at $16,302.94, and exchange ID 6 has 0.023455 shares at the same price level.

spreadnumber

The difference between the best bid and the best ask price accross exchanges.


tickerstring

The exchange symbol that this item is traded under.


updatedinteger

The last updated timestamp.


Response Object

{
 "data": {
  "askCount": 593.1412981600005,
  "asks": [
   {
    "p": 11454,
    "x": {
     "2": 1
    }
   },
   {
    "p": 11455,
    "x": {
     "2": 1
    }
   }
  ],
  "bidCount": 694.951789670001,
  "bids": [
   {
    "p": 16303.17,
    "x": {
     "1": 2
    }
   },
   {
    "p": 16302.94,
    "x": {
     "1": 0.02859424,
     "6": 0.023455
    }
   }
  ],
  "spread": -4849.17,
  "ticker": "X:BTCUSD",
  "updated": 1605295074162
 },
 "status": "OK"
}