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.
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=*
Query all ticker symbols which are supported by Polygon.io. Returns basic reference data for each matched ticker symbol. This API includes Crypto, Forex, and Stocks/Equities.
Which field to sort by.
For desc place a -
in front of the field name.
Example:
?sort=-ticker
to sort symbols Z-A?sort=type
to sort symbols by typeGet tickers of a certain type. See Ticker Types for available types.
Example
?type=etp
to get all ETFs?type=cs
to get all Common StocksGet tickers for a specific market.
Example:
?market=stocks
to get all stock tickers?market=crypto
to get all crypto tickers?market=fx
to get all forex tickersGet tickers for a specific region/locale. See Locales for a list of possible values.
Example:
?locale=us
to get all US tickers?locale=g
to get all Global tickersSearch for specific tickers by name or ticker symbol.
Example:
?search=microsoft
Search tickers for microsoftThe maximum number of results to be returned on each page, max 50 and default 50.
Which page of results to return.
Filter for only active or inactive symbols.
https://api.polygon.io/v2/reference/tickers?&apiKey=*
The page number of the current response.
The number of results per page.
The total number of results for this request.
The status of this request's response.
The exchange symbol that this item is traded under.
The name of the item.
The market in which this ticker participates.
The locale of where this ticker is traded.
The currency this ticker is traded in.
Whether or not the ticker is active. False means the ticker has been delisted.
The listing exchange for this ticker.
A URL that can be used to get more detailed information about the ticker.
The last time this ticker record was updated.
The name of the variable/quote currency.
The currency code of the variable/quote currency.
The name of the base currency.
The currency code of the base currency.
The CIK number for this ticker.
The OpenFIGI number for this ticker.
The composite OpenFIGI number for this ticker.
The shared Class OpenFIGI number for this ticker.
The unique OpenFIGI ID number for this ticker.
{
"page": 1,
"perPage": 50,
"count": 121859,
"status": "OK",
"tickers": [
{
"ticker": "AAPL",
"name": "Apple Inc.",
"market": "STOCKS",
"locale": "US",
"currency": "USD",
"active": true,
"primaryExch": "NGS",
"type": "cs",
"codes": {
"cik": "0000320193",
"figiuid": "EQ0010169500001000",
"scfigi": "BBG001S5N8V8",
"cfigi": "BBG000B9XRY4",
"figi": "BBG000B9Y5X2"
},
"updated": "2019-01-15T00:00:00.000Z",
"url": "https://api.polygon.io/v2/reference/tickers/AAPL"
},
{
"ticker": "$AEDAUD",
"name": "United Arab Emirates dirham - Australian dollar",
"market": "FX",
"locale": "G",
"currency": "AUD",
"active": true,
"primaryExch": "FX",
"updated": "2019-01-25T00:00:00.000Z",
"attrs": {
"currencyName": "Australian dollar",
"currency": "AUD",
"baseName": "United Arab Emirates dirham",
"base": "AED"
},
"url": "https://api.polygon.io/v2/tickers/$AEDAUD"
}
]
}
Query all ticker symbols which are supported by Polygon.io. This API currently includes Stocks/Equities, Crypto, and Forex.
Specify a ticker symbol. Defaults to empty string which queries all tickers.
Specify the type of the tickers. Find the types that we support via our Ticker Types API. Defaults to empty string which queries all types.
Filter by market type. By default all markets are included.
Specify the primary exchange of the asset in the ISO code format. Find more information about the ISO codes at the ISO org website. Defaults to empty string which queries all exchanges.
Specify the CUSIP code of the asset you want to search for. Find more information about CUSIP codes at their website. Defaults to empty string which queries all CUSIPs.
Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.
Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date.
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.
The order to sort the results on. Default is asc (ascending).
Limit the size of the response, default is 100 and max is 500.
If your query returns more than the max limit and you want to retrieve the next page of results,
see the next_page_path
response attribute.
https://api.polygon.io/vX/reference/tickers?&apiKey=*
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.
The exchange symbol that this item is traded under.
The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.
The market type of the asset.
The locale of the asset.
The ISO code of the primary listing exchange for this asset.
The type of the asset. Find the types that we support via our Ticker Types API.
Whether or not the asset is actively traded. False means the asset has been delisted.
The name of the currency that this asset is traded with.
The CIK number for this ticker. Find more information here.
The composite OpenFIGI number for this ticker. Find more information here
The share Class OpenFIGI number for this ticker. Find more information here
The last time this asset record was updated.
The last date that the asset was traded.
If present, this value can be used to fetch the next page of data by appending this to the API url host.
A request id assigned by the server.
The status of this request's response.
The total number of results for this request.
{
"results": [
{
"ticker": "AAPL",
"name": "APPLE COMPUTER INC",
"market": "stocks",
"locale": "us",
"primary_exchange": "XNAS",
"type": "CS",
"active": true,
"currency_name": "usd",
"cik": "0000320193",
"composite_figi": "BBG000B9XRY4",
"share_class_figi": "BBG001S5N8V8",
"last_updated_utc": "2019-01-25T00:00:00.000Z"
}
],
"status": "OK",
"request_id": "80b8c50f9de25d05168db79b5723341e",
"count": 1,
"next_page_path": "/vX/reference/tickers?active=true&apiKey=*******&date=2021-04-06&limit=1&order=asc&page_marker=AAPL%7C6ec768e0068819a88ae4282b7bf2fbadab7717e0b3a916e1ba61ac63cc1a8972&search=apple&sort=ticker"
}
Get a mapping of ticker types to their descriptive names.
https://api.polygon.io/v2/reference/types?&apiKey=*
The status of this request's response.
Common Stock
American Depository Receipt
Non-Voting Depository Receipt
Global Depositary Receipt
Special Drawing Right
Closed-End Fund
Exchange Traded Product/Fund
Real Estate Investment Trust
Master Limited Partnership
Equity WRT
Public
New York Registry Shares
Unit
Right
Tracking stock or targeted stock
Limited Partnership
Royalty Trust
Mutual Fund
Preferred Stock
Foreign Ordinary Shares
Other Security Type
Fund
Structured Product
Secondary Issue
Index
Exchange Traded Fund (ETF)
Exchange Traded Note (ETN)
Exchange Traded Managed Fund (ETMF)
Settlement
Spot
Subordinated product
World Currency
Alpha Index
{
"status": "OK",
"results": {
"types": {
"CS": "Common Stock",
"ADR": "American Depository Receipt",
"NVDR": "Non-Voting Depository Receipt",
"GDR": "Global Depositary Receipt",
"SDR": "Special Drawing Right",
"CEF": "Closed-End Fund",
"ETP": "Exchange Traded Product/Fund",
"REIT": "Real Estate Investment Trust",
"MLP": "Master Limited Partnership",
"WRT": "Equity WRT",
"PUB": "Public",
"NYRS": "New York Registry Shares",
"UNIT": "Unit",
"RIGHT": "Right",
"TRAK": "Tracking stock or targeted stock",
"LTDP": "Limited Partnership",
"RYLT": "Royalty Trust",
"MF": "Mutual Fund",
"PFD": "Preferred Stock",
"FDR": "Foreign Ordinary Shares",
"OST": "Other Security Type",
"FUND": "Fund",
"SP": "Structured Product",
"SI": "Secondary Issue"
},
"indexTypes": {
"INDEX": "Index",
"ETF": "Exchange Traded Fund (ETF)",
"ETN": "Exchange Traded Note (ETN)",
"ETMF": "Exchange Traded Managed Fund (ETMF)",
"SETTLEMENT": "Settlement",
"SPOT": "Spot",
"SUBPROD": "Subordinated product",
"WC": "World Currency",
"ALPHAINDEX": "Alpha Index"
}
}
}
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.
The ticker symbol of the stock/equity.
https://api.polygon.io/v1/meta/symbols/{stocksTicker}/company?&apiKey=*
The URL of the entity's logo.
The symbol's primary exchange.
The exchange code (id) of the symbol's primary exchange.
The type or class of the security. (Full List of Ticker Types)
The name of the company/entity.
The exchange symbol that this item is traded under.
The date that the symbol was listed on the exchange.
The official CIK guid used for SEC database/filings.
The Bloomberg guid for the symbol.
The OpenFigi project guid for the symbol. (https://openfigi.com/)
The Legal Entity Identifier (LEI) guid for the symbol. (https://en.wikipedia.org/wiki/Legal_Entity_Identifier)
Standard Industrial Classification (SIC) id for the symbol. (https://en.wikipedia.org/wiki/Legal_Entity_Identifier)
The country in which the company is registered.
The industry in which the company operates.
The sector of the indsutry in which the symbol operates.
The current market cap for the company.
The approximate number of employees for the company.
The phone number for the company. This is usually a corporate contact number.
The name of the company's current CEO.
The URL of the company's website
A description of the company and what they do/offer.
The street address for the company's headquarters.
The state in which the company's headquarters is located.
The country in which the company's headquarters is located.
A list of ticker symbols for similar companies.
A list of words related to the company.
The last time this company record was updated.
Indicates if the security is actively listed. If false, this means the company is no longer listed and cannot be traded.
{
"logo": "https://s3.polygon.io/logos/aapl/logo.png",
"listdate": "1990-01-02T00:00:00.000Z",
"cik": 320193,
"bloomberg": "EQ0010169500001000",
"figi": null,
"lei": "HWUPKR0MPOU8FGXBT394",
"sic": 3571,
"country": "usa",
"industry": "Computer Hardware",
"sector": "Technology",
"marketcap": 908316631180,
"employees": 123000,
"phone": "+1 408 996-1010",
"ceo": "Timothy D. Cook",
"url": "http://www.apple.com",
"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.",
"exchange": "Nasdaq Global Select",
"name": "Apple Inc.",
"symbol": "AAPL",
"exchangeSymbol": "NGS",
"hq_address": "1 Infinite Loop Cupertino CA, 95014",
"hq_state": "CA",
"hq_country": "USA",
"type": "CS",
"updated": "11/16/2018",
"tags": [
"Technology",
"Consumer Electronics",
"Computer Hardware"
],
"similar": [
"MSFT",
"NOK",
"IBM",
"HPQ",
"GOOGL",
"BB",
"XLK"
],
"active": true
}
Get a single ticker supported by Polygon.io. This response will have detailed information about the ticker and the company behind it.
The ticker symbol of the asset.
Specify a point in time to get information about the ticker available on that date. When retrieving information from SEC filings, we compare this date with the period of report date on the SEC filing.
For example, consider an SEC filing submitted by AAPL on 2019-07-31, with a period of report date ending on 2019-06-29. That means that the filing was submitted on 2019-07-31, but the filing was created based on information from 2019-06-29. If you were to query for AAPL details on 2019-06-29, the ticker details would include information from the SEC filing.
Defaults to the most recent available date.
https://api.polygon.io/vX/reference/tickers/{ticker}?&apiKey=*
Ticker with details.
The exchange symbol that this item is traded under.
The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.
The market type of the asset.
The locale of the asset.
The ISO code of the primary listing exchange for this asset.
The type of the asset. Find the types that we support via our Ticker Types API.
Whether or not the asset is actively traded. False means the asset has been delisted.
The name of the currency that this asset is traded with.
The CIK number for this ticker. Find more information here.
The composite OpenFIGI number for this ticker. Find more information here
The share Class OpenFIGI number for this ticker. Find more information here
The last time this asset record was updated.
The last date that the asset was traded.
The recorded number of outstanding shares.
The most recent close price of the ticker multiplied by outstanding shares.
The phone number for the company behind this ticker.
The first line of the company's headquarters address.
The city of the company's headquarters address.
The state of the company's headquarters address.
The standard industrial classification code for this ticker. For a list of SIC Codes, see the SEC's SIC Code List.
A description of this ticker's SIC code.
A request id assigned by the server.
The status of this request's response.
The total number of results for this request.
{
"results": {
"ticker": "AAPL",
"name": "Apple Inc.",
"market": "stocks",
"locale": "us",
"primary_exchange": "XNAS",
"type": "CS",
"active": true,
"currency_name": "usd",
"cik": "0000320193",
"composite_figi": "BBG000B9XRY4",
"share_class_figi": "BBG001S5N8V8",
"last_updated_utc": "2020-12-27T00:00:00Z",
"outstanding_shares": 17001800000,
"market_cap": 2082042128180,
"phone_number": "(408) 996-1010",
"address": {
"address1": "One Apple Park Way",
"city": "Cupertino",
"state": "CA"
},
"sic_code": "3571",
"sic_description": "ELECTRONIC COMPUTERS"
},
"status": "OK",
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"count": 1
}
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.
The ticker symbol of the stock/equity.
The maximum number of results to be returned on each page, max 50 and default 50.
Which page of results to return.
https://api.polygon.io/v1/meta/symbols/{stocksTicker}/news?&apiKey=*
A list of ticker symbols relating to the article.
The title of the news article.
A direct link to the news article from its source publication.
The publication source of the article.
A summary of the news article.
A URL of the image for the news article, if found.
The timestamp of the news article.
A list of common keywords related to the news article.
[
{
"symbols": [
"AAPL"
],
"timestamp": "2020-03-26T23:52:51.000Z",
"title": "Apple (AAPL): Despite Likely iPhone 12 Delays, the Risk-Reward Remains Compelling, Says Analyst",
"url": "https://finance.yahoo.com/news/apple-aapl-despite-likely-iphone-235251688.html",
"source": "finance yahoo",
"summary": "When considering the fortunes of the FAANG family since the viral outbreak, it appears Apple (AAPL) has most to lose. Amazon and Netflix can count their internet driven models as particularly well set up for a hibernation period. And while Google and Facebook stand to lose significant advertising revenue",
"image": "https://s.yimg.com/uu/api/res/1.2/Su.8VniRbi_GL2B3BruK5w--~B/aD0zMzc7dz0xMDI0O3NtPTE7YXBwaWQ9eXRhY2h5b24-/https://media.zenfs.com/en-US/smarteranalyst_347/6909df17d6ef3af25ac79e2e6c0078d5",
"keywords": [
"aapl"
]
}
]
Get a list of markets that are currently supported by Polygon.io.
https://api.polygon.io/v2/reference/markets?&apiKey=*
The status of this request's response.
A list of supported markets.
The name of the market.
A description of the market.
{
"status": "OK",
"results": [
{
"market": "STOCKS",
"desc": "Stocks / Equities / ETFs"
},
{
"market": "INDICES",
"desc": "Indices"
},
{
"market": "MF",
"desc": "Mutual Funds"
},
{
"market": "MMF",
"desc": "Money Market Funds"
},
{
"market": "CRYPTO",
"desc": "Crypto"
},
{
"market": "FX",
"desc": "Forex / Currencies"
},
{
"market": "BONDS",
"desc": "Bonds"
}
]
}
Get a list of locales currently supported by Polygon.io.
https://api.polygon.io/v2/reference/locales?&apiKey=*
The status of this request's response.
An abbreviated country name.
The name of the country.
{
"status": "OK",
"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"
}
]
}
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.
The ticker symbol of the stock/equity.
https://api.polygon.io/v2/reference/splits/{stocksTicker}?&apiKey=*
The status of this request's response.
The total number of results for this request.
The exchange symbol that this item is traded under.
The execution date of the stock split.
The payment date of the stock split.
The declared date of the stock split.
This referst 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.
The "to" factor of the split. This is used to calculate the split ratio forfactor/tofactor = ratio (eg ½ = 0.5).
The "for" factor of the split. This is used to calculate the split ratio forfactor/tofactor = ratio (eg ½ = 0.5).
{
"status": "OK",
"count": 4,
"results": [
{
"ticker": "AAPL",
"exDate": "2020-08-31T00:00:00.000Z",
"paymentDate": "2020-08-28T00:00:00.000Z",
"declaredDate": "2020-07-30T00:00:00.000Z",
"ratio": 0.25,
"tofactor": 1,
"forfactor": 4
},
{
"ticker": "AAPL",
"exDate": "2014-06-09T00:00:00.000Z",
"paymentDate": "2014-06-10T00:00:00.000Z",
"ratio": 0.14285714285714285,
"tofactor": 1,
"forfactor": 7
},
{
"ticker": "AAPL",
"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
}
]
}
Get a list of historical dividends for a stock, including the relevant dates and the amount of the dividend.
The ticker symbol of the stock/equity.
https://api.polygon.io/v2/reference/dividends/{stocksTicker}?&apiKey=*
The status of this request's response.
The total number of results for this request.
The exchange symbol that this item is traded under.
The execution date of the dividend.
The payment date of the dividend.
The date of record for the dividend.
See Investor.gov for an explanation on dividend dates and their meaning.
The amount of the dividend.
{
"status": "OK",
"count": 2,
"results": [
{
"ticker": "AAPL",
"exDate": "2020-05-08T00:00:00.000Z",
"paymentDate": "2020-05-14T00:00:00.000Z",
"recordDate": "2020-05-11T00:00:00.000Z",
"amount": 0.82
},
{
"ticker": "AAPL",
"exDate": "2020-02-07T00:00:00.000Z",
"paymentDate": "2020-02-13T00:00:00.000Z",
"recordDate": "2020-02-10T00:00:00.000Z",
"amount": 0.77
}
]
}
Get historical financial data for a stock ticker.
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=*
The exchange symbol that this item is traded under.
Reporting period.
{
"status": "OK",
"count": 1,
"results": [
{
"ticker": "string",
"period": "Q",
"calendarDate": "2019-03-31",
"reportPeriod": "2019-03-31",
"updated": "1999-03-28",
"accumulatedOtherComprehensiveIncome": 0,
"assets": 0,
"assetsAverage": 0,
"assetsCurrent": 0,
"assetTurnover": 0,
"assetsNonCurrent": 0,
"bookValuePerShare": 0,
"capitalExpenditure": 0,
"cashAndEquivalents": 0,
"cashAndEquivalentsUSD": 0,
"costOfRevenue": 0,
"consolidatedIncome": 0,
"currentRatio": 0,
"debtToEquityRatio": 0,
"debt": 0,
"debtCurrent": 0,
"debtNonCurrent": 0,
"debtUSD": 0,
"deferredRevenue": 0,
"depreciationAmortizationAndAccretion": 0,
"deposits": 0,
"dividendYield": 0,
"dividendsPerBasicCommonShare": 0,
"earningBeforeInterestTaxes": 0,
"earningsBeforeInterestTaxesDepreciationAmortization": 0,
"EBITDAMargin": 0,
"earningsBeforeInterestTaxesDepreciationAmortizationUSD": 0,
"earningBeforeInterestTaxesUSD": 0,
"earningsBeforeTax": 0,
"earningsPerBasicShare": 0,
"earningsPerDilutedShare": 0,
"earningsPerBasicShareUSD": 0,
"shareholdersEquity": 0,
"averageEquity": 0,
"shareholdersEquityUSD": 0,
"enterpriseValue": 0,
"enterpriseValueOverEBIT": 0,
"enterpriseValueOverEBITDA": 0,
"freeCashFlow": 0,
"freeCashFlowPerShare": 0,
"foreignCurrencyUSDExchangeRate": 0,
"grossProfit": 0,
"grossMargin": 0,
"goodwillAndIntangibleAssets": 0,
"interestExpense": 0,
"investedCapital": 0,
"investedCapitalAverage": 0,
"inventory": 0,
"investments": 0,
"investmentsCurrent": 0,
"investmentsNonCurrent": 0,
"totalLiabilities": 0,
"currentLiabilities": 0,
"liabilitiesNonCurrent": 0,
"marketCapitalization": 0,
"netCashFlow": 0,
"netCashFlowBusinessAcquisitionsDisposals": 0,
"issuanceEquityShares": 0,
"issuanceDebtSecurities": 0,
"paymentDividendsOtherCashDistributions": 0,
"netCashFlowFromFinancing": 0,
"netCashFlowFromInvesting": 0,
"netCashFlowInvestmentAcquisitionsDisposals": 0,
"netCashFlowFromOperations": 0,
"effectOfExchangeRateChangesOnCash": 0,
"netIncome": 0,
"netIncomeCommonStock": 0,
"netIncomeCommonStockUSD": 0,
"netLossIncomeFromDiscontinuedOperations": 0,
"netIncomeToNonControllingInterests": 0,
"profitMargin": 0,
"operatingExpenses": 0,
"operatingIncome": 0,
"tradeAndNonTradePayables": 0,
"payoutRatio": 0,
"priceToBookValue": 0,
"priceEarnings": 0,
"priceToEarningsRatio": 0,
"propertyPlantEquipmentNet": 0,
"preferredDividendsIncomeStatementImpact": 0,
"sharePriceAdjustedClose": 0,
"priceSales": 0,
"priceToSalesRatio": 0,
"tradeAndNonTradeReceivables": 0,
"accumulatedRetainedEarningsDeficit": 0,
"revenues": 0,
"revenuesUSD": 0,
"researchAndDevelopmentExpense": 0,
"returnOnAverageAssets": 0,
"returnOnAverageEquity": 0,
"returnOnInvestedCapital": 0,
"returnOnSales": 0,
"shareBasedCompensation": 0,
"sellingGeneralAndAdministrativeExpense": 0,
"shareFactor": 0,
"shares": 0,
"weightedAverageShares": 0,
"weightedAverageSharesDiluted": 0,
"salesPerShare": 0,
"tangibleAssetValue": 0,
"taxAssets": 0,
"incomeTaxExpense": 0,
"taxLiabilities": 0,
"tangibleAssetsBookValuePerShare": 0,
"workingCapital": 0
}
]
}
Get upcoming market holidays and their open/close times.
https://api.polygon.io/v1/marketstatus/upcoming?&apiKey=*
Which market the record is for.
The name of the holiday.
The status of the market on the holiday.
The date of the holiday.
The market open time on the holiday (if it's not closed).
The market close time on the holiday (if it's not closed).
[
{
"exchange": "NYSE",
"name": "Thanksgiving",
"date": "2020-11-26T00:00:00.000Z",
"status": "closed"
},
{
"exchange": "NASDAQ",
"name": "Thanksgiving",
"date": "2020-11-26T00:00:00.000Z",
"status": "closed"
},
{
"exchange": "OTC",
"name": "Thanksgiving",
"date": "2020-11-26T00:00:00.000Z",
"status": "closed"
},
{
"exchange": "NASDAQ",
"name": "Thanksgiving",
"date": "2020-11-27T00:00:00.000Z",
"status": "early-close",
"open": "2020-11-27T14:30:00.000Z",
"close": "2020-11-27T18:00:00.000Z"
},
{
"exchange": "NYSE",
"name": "Thanksgiving",
"date": "2020-11-27T00:00:00.000Z",
"status": "early-close",
"open": "2020-11-27T14:30:00.000Z",
"close": "2020-11-27T18:00:00.000Z"
}
]
Get the current trading status of the exchanges and overall financial markets.
https://api.polygon.io/v1/marketstatus/now?&apiKey=*
The status of the market as a whole.
The current time of the server.
The status of the NYSE market.
The status of the Nasdaq market.
The status of the OTC market.
The status of the forex market.
The status of the crypto market.
{
"market": "extended-hours",
"serverTime": "2020-11-10T22:37:37.000Z",
"exchanges": {
"nyse": "extended-hours",
"nasdaq": "extended-hours",
"otc": "closed"
},
"currencies": {
"fx": "open",
"crypto": "open"
}
}
Get a list of stock exchanges which are supported by Polygon.io.
https://api.polygon.io/v1/meta/exchanges?&apiKey=*
The ID of the exchange.
The type of exchange.
The market data type that this exchange contains.
The Market Identification Code or MIC as defined in ISO 10383 (https://en.wikipedia.org/wiki/Market_Identifier_Code).
The name of the exchange.
The tape id of the exchange.
A unique identifier for the exchange internal to Polygon.io. This is not an industry code or ISO standard.
[
{
"id": 0,
"type": "TRF",
"market": "equities",
"mic": "TFF",
"name": "Multiple",
"tape": "-"
},
{
"id": 1,
"type": "exchange",
"market": "equities",
"mic": "XASE",
"name": "NYSE American (AMEX)",
"tape": "A",
"code": "AMX"
},
{
"id": 2,
"type": "exchange",
"market": "equities",
"mic": "XNAS",
"name": "NASDAQ OMX BX",
"tape": "B",
"code": "NSD"
},
{
"id": 3,
"type": "TRF",
"market": "equities",
"name": "National Stock Exchange",
"mic": "XCIS",
"tape": "C"
}
]
Get a unified numerical mapping for conditions on trades and quotes. Each feed/exchange uses its own set of codes to identify conditions, so the same condition may have a different code depending on the originator of the data. Polygon.io defines its own mapping to allow for uniformly identifying a condition across feeds/exchanges.
The type of ticks to return mappings for.
https://api.polygon.io/v1/meta/conditions/{ticktype}?&apiKey=*
Polygon.io's mapping for condition codes. For more information, see our Trade Conditions Glossary.
{
"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"
}
Get a list of cryptocurrency exchanges which are supported by Polygon.io.
https://api.polygon.io/v1/meta/crypto-exchanges?&apiKey=*
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
Type of exchange feed
Market data type this exchange contains ( crypto only currently )
Name of the exchange
URL of this exchange
[
{
"id": 1,
"type": "exchange",
"market": "crypto",
"name": "GDAX",
"url": "https://www.gdax.com/"
},
{
"id": 2,
"type": "exchange",
"market": "crypto",
"name": "BITFINEX",
"url": "https://www.bitfinex.com/"
},
{
"id": 3,
"type": "exchange",
"market": "crypto",
"name": "BitMEX",
"url": "https://www.bitmex.com/"
},
{
"id": 4,
"type": "exchange",
"market": "crypto",
"name": "Binance",
"url": "https://www.binance.com/"
}
]
Get trades for a given ticker symbol on a specified date.
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=*
The exchange symbol that this item is traded under.
The total number of results for this request.
Latency in milliseconds for the query results from the database.
Whether or not this query was executed successfully.
The original ID of the trade. This is used when there is a trade correction to indicate the ID of the corrected trade.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The price of the trade. This is the actual dollar value per whole share of this trade. A trade of 100 shares with a price of $2.00 would be worth a total dollar value of $200.00.
The Trade ID which uniquely identifies a trade. These are unique per combination of ticker, exchange, and TRF. For example: A trade for AAPL executed on NYSE and a trade for AAPL executed on NASDAQ could potentially have the same Trade ID.
The trade correction indicator.
The ID for the Trade Reporting Facility where the trade took place.
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.
The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.
The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.
The sequence number representing the sequence in which trade events happened. These are increasing and unique per ticker symbol, but will not always be sequential (e.g., 1, 2, 6, 9, 10, 11).
The trade conditions. These are the conditions of this message. See Condition Mappings for a mapping to exchange conditions.
The size of a trade (also known as volume) as a number of whole shares traded.
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.
A mapping of the keys returned in the results to their descriptive name and data types.
A dynamic key from the results set
The descriptive name of this results key
The data type of this results key
{
"ticker": "AAPL",
"results_count": 2,
"db_latency": 11,
"success": true,
"results": [
{
"t": 1517562000016036600,
"y": 1517562000015577000,
"q": 1063,
"i": "1",
"x": 11,
"s": 100,
"c": [
12,
41
],
"p": 171.55,
"z": 3
},
{
"t": 1517562000016038100,
"y": 1517562000015577600,
"q": 1064,
"i": "2",
"x": 11,
"s": 100,
"c": [
12,
41
],
"p": 171.55,
"z": 3
}
],
"map": {
"I": {
"name": "orig_id",
"type": "string"
},
"x": {
"name": "exchange",
"type": "int"
},
"p": {
"name": "price",
"type": "float64"
},
"i": {
"name": "id",
"type": "string"
},
"e": {
"name": "correction",
"type": "int"
},
"r": {
"name": "trf_id",
"type": "int"
},
"t": {
"name": "sip_timestamp",
"type": "int64"
},
"y": {
"name": "participant_timestamp",
"type": "int64"
},
"f": {
"name": "trf_timestamp",
"type": "int64"
},
"q": {
"name": "sequence_number",
"type": "int64"
},
"c": {
"name": "conditions",
"type": "int"
},
"s": {
"name": "size",
"type": "int"
},
"z": {
"name": "tape",
"type": "int"
}
}
}
Get NBBO quotes for a given ticker symbol on a specified date.
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=*
The exchange symbol that this item is traded under.
The total number of results for this request.
Latency in milliseconds for the query results from the database.
Whether or not this query was executed successfully.
The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.
The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange.
The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message.
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).
A list of condition codes.
The indicators. For more information, see our glossary of Conditions and Indicators.
The bid price.
The bid Exchange ID.
The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.
The ask price.
The ask Exchange ID.
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.
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.
A mapping of the keys returned in the results to their descriptive name and data types.
A dynamic key from the results set
The descriptive name of this results key
The data type of this results key
{
"ticker": "AAPL",
"success": true,
"results_count": 2,
"db_latency": 43,
"results": [
{
"t": 1517562000065700400,
"y": 1517562000065321200,
"q": 2060,
"c": [
1
],
"z": 3,
"p": 102.7,
"s": 60,
"x": 11,
"P": 0,
"S": 0,
"X": 0
},
{
"t": 1517562000065791500,
"y": 1517562000065408300,
"q": 2061,
"c": [
1
],
"z": 3,
"p": 170,
"s": 2,
"x": 11,
"P": 0,
"S": 0,
"X": 0
}
],
"map": {
"t": {
"name": "sip_timestamp",
"type": "int64"
},
"y": {
"name": "participant_timestamp",
"type": "int64"
},
"i": {
"name": "indicators",
"type": "int"
},
"P": {
"name": "ask_price",
"type": "float64"
},
"X": {
"name": "ask_exchange",
"type": "int"
},
"f": {
"name": "trf_timestamp",
"type": "int64"
},
"q": {
"name": "sequence_number",
"type": "int"
},
"c": {
"name": "conditions",
"type": "int"
},
"p": {
"name": "bid_price",
"type": "float64"
},
"s": {
"name": "bid_size",
"type": "int"
},
"x": {
"name": "bid_exchange",
"type": "int"
},
"S": {
"name": "ask_size",
"type": "int"
},
"z": {
"name": "tape",
"type": "int"
}
}
}
Get the most recent trade for a given stock.
The ticker symbol of the stock/equity.
https://api.polygon.io/v1/last/stocks/{stocksTicker}?&apiKey=*
The exchange symbol that this item is traded under.
The status of this request's response.
A request id assigned by the server.
The price of the trade.
The size of the trade.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
Condition 1 of the trade. See Polygon.io's mapping of conditions to exchange descriptions.
Condition 2 of the trade. See Polygon.io's mapping of conditions to exchange descriptions.
Condition 3 of the trade. See Polygon.io's mapping of conditions to exchange descriptions.
Condition 4 of the trade. See Polygon.io's mapping of conditions to exchange descriptions.
The Unix Msec timestamp for the start of the aggregate window.
{
"symbol": "AAPL",
"status": "success",
"request_id": "fbb6074f249ea54a1ad924e4967c36af",
"last": {
"cond1": 37,
"exchange": 4,
"price": 119.1802,
"size": 10,
"timestamp": 1605122370210
}
}
Get the most recent quote tick for a given stock.
The ticker symbol of the stock/equity.
https://api.polygon.io/v1/last_quote/stocks/{stocksTicker}?&apiKey=*
The exchange symbol that this item is traded under.
The status of this request's response.
A request id assigned by the server.
The ask price.
The ask size. This represents the number of round lot orders at the given ask price. The normal round lot size is 100 shares. An ask size of 2 means there are 200 shares available to purchase at the given ask price.
The exchange ID that this liquidity is available on. See Exchanges for Polygon.io's mapping of exchange IDs.
The bid price.
The bid size. This represents the number of round lot orders at the given bid price. The normal round lot size is 100 shares. A bid size of 2 means there are 200 shares for purchase at the given bid price.
The exchange ID that this liquidity is available on. See Exchanges for Polygon.io's mapping of exchange IDs.
The Unix Msec timestamp for the start of the aggregate window.
{
"symbol": "AAPL",
"status": "success",
"request_id": "9463580f28a577b10c3b46266fc7203e",
"last": {
"askexchange": 8,
"askprice": 119.51,
"asksize": 8,
"bidexchange": 11,
"bidprice": 119.5,
"bidsize": 2,
"timestamp": 1605121721850
}
}
Get the open, close and afterhours prices of a stock symbol on a certain date.
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 true to get results that are NOT adjusted for splits.
https://api.polygon.io/v1/open-close/{stocksTicker}/{date}?&apiKey=*
The status of this request's response.
The requested date.
The exchange symbol that this item is traded under.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The open price of the ticker symbol in pre-market trading.
The close price of the ticker symbol in after hours trading.
{
"status": "OK",
"from": "2020-10-14T00:00:00.000Z",
"symbol": "AAPL",
"open": 324.66,
"high": 326.2,
"low": 322.3,
"close": 325.12,
"volume": 26122646,
"afterHours": 322.1,
"preMarket": 324.5
}
Get the daily open, high, low, and close (OHLC) for the entire stocks/equities markets.
The beginning date for the aggregate window.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to true to get results that are NOT adjusted for splits.
https://api.polygon.io/v2/aggs/grouped/locale/us/market/stocks/{date}?&apiKey=*
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The exchange symbol that this item is traded under.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The Unix Msec timestamp for the start of the aggregate window.
The number of transactions in the aggregate window.
{
"status": "OK",
"queryCount": 3,
"resultsCount": 3,
"adjusted": true,
"results": [
{
"T": "C:AUDCHF",
"v": 160131,
"o": 0.6618886,
"c": 0.6619247,
"h": 0.6643625,
"l": 0.6596,
"t": 1599796800000
},
{
"T": "C:AUDCAD",
"v": 92488,
"o": 0.9584955,
"c": 0.9598082,
"h": 0.9620029,
"l": 0.9575,
"t": 1599796800000
},
{
"T": "C:AUDBGN",
"v": 87209,
"o": 1.2023558,
"c": 1.2009374,
"h": 1.2055938,
"l": 1.199437,
"t": 1599796800000
}
]
}
Get the previous day's open, high, low, and close (OHLC) for the specified stock ticker.
The ticker symbol of the stock/equity.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to true to get results that are NOT adjusted for splits.
https://api.polygon.io/v2/aggs/ticker/{stocksTicker}/prev?&apiKey=*
The exchange symbol that this item is traded under.
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The Unix Msec timestamp for the start of the aggregate window.
The number of transactions in the aggregate window.
{
"ticker": "AAPL",
"status": "OK",
"queryCount": 1,
"resultsCount": 1,
"adjusted": true,
"results": [
{
"T": "AAPL",
"v": 131704427,
"vw": 116.3058,
"o": 115.55,
"c": 115.97,
"h": 117.59,
"l": 114.13,
"t": 1605042000000
}
],
"request_id": "6a7e466379af0a71039d60cc78e72282"
}
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.
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 true 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=*
The exchange symbol that this item is traded under.
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The Unix Msec timestamp for the start of the aggregate window.
The number of transactions in the aggregate window.
{
"ticker": "AAPL",
"status": "OK",
"queryCount": 2,
"resultsCount": 2,
"adjusted": true,
"results": [
{
"v": 135647456,
"vw": 74.6099,
"o": 74.06,
"c": 75.0875,
"h": 75.15,
"l": 73.7975,
"t": 1577941200000,
"n": 1
},
{
"v": 146535512,
"vw": 74.7026,
"o": 74.2875,
"c": 74.3575,
"h": 75.145,
"l": 74.125,
"t": 1578027600000,
"n": 1
}
],
"request_id": "6a7e466379af0a71039d60cc78e72282"
}
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.
A comma separated list of tickers to get snapshots for.
https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/tickers?&apiKey=*
The status of this request's response.
The total number of results for this request.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The bid price.
The bid size in lots.
The ask price.
The ask size in lots.
The Unix Msec timestamp for the start of the aggregate window.
The trade conditions.
The trade ID.
The price of the trade.
The size (volume) of the trade.
The Unix Msec timestamp for the start of the aggregate window.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The last available minute bar.
The accumulated volume.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"status": "OK",
"count": 1,
"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
}
]
}
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.
The ticker symbol of the stock/equity.
https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}?&apiKey=*
The status of this request's response.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The bid price.
The bid size in lots.
The ask price.
The ask size in lots.
The Unix Msec timestamp for the start of the aggregate window.
The trade conditions.
The trade ID.
The price of the trade.
The size (volume) of the trade.
The Unix Msec timestamp for the start of the aggregate window.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The last available minute bar.
The accumulated volume.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
}
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.
The direction of the snapshot results to return.
https://api.polygon.io/v2/snapshot/locale/us/markets/stocks/{direction}?&apiKey=*
The status of this request's response.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The bid price.
The bid size in lots.
The ask price.
The ask size in lots.
The Unix Msec timestamp for the start of the aggregate window.
The trade conditions.
The trade ID.
The price of the trade.
The size (volume) of the trade.
The Unix Msec timestamp for the start of the aggregate window.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The last available minute bar.
The accumulated volume.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
]
}
Get historic ticks for a forex currency pair.
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=*
The status of this request's response.
The date that was evaluated from the request.
A map for shortened result keys.
The milliseconds of latency for the query results.
The currency pair that was evaluated from the request.
The ask price.
The bid price.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The Unix Msec timestamp for the start of the aggregate window.
{
"day": "2020-10-14T00:00:00.000Z",
"map": {
"a": "ask",
"b": "bid",
"t": "timestamp"
},
"msLatency": 3,
"pair": "AUD/USD",
"status": "success",
"ticks": [
{
"b": 0.7177,
"a": 0.7182,
"x": 48,
"t": 1601596801000
},
{
"b": 0.71804,
"a": 0.71816,
"x": 48,
"t": 1601596802000
},
{
"b": 0.7178,
"a": 0.7183,
"x": 48,
"t": 1601596803000
}
],
"type": "forex"
}
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.
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=*
The status of this request's response.
The ask price.
The bid price.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The Unix Msec timestamp for the start of the aggregate window.
The "from" currency symbol.
The "to" currency symbol.
The amount to convert.
The result of the conversion.
{
"status": "success",
"last": {
"bid": 1.3672596,
"ask": 1.3673344,
"exchange": 48,
"timestamp": 1605555313000
},
"from": "AUD",
"to": "USD",
"initialAmount": 100,
"converted": 73.14
}
Get the last quote tick for a forex currency pair.
The "from" symbol of the pair.
The "to" symbol of the pair.
https://api.polygon.io/v1/last_quote/currencies/{from}/{to}?&apiKey=*
The status of this request's response.
A request id assigned by the server.
The ask price.
The bid price.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The Unix Msec timestamp for the start of the aggregate window.
The symbol pair that was evaluated from the request.
{
"last": {
"ask": 0.73124,
"bid": 0.73122,
"exchange": 48,
"timestamp": 1605557756000
},
"request_id": "a73a29dbcab4613eeaf48583d3baacf0",
"status": "success",
"symbol": "AUD/USD"
}
Get the daily open, high, low, and close (OHLC) for the entire forex markets.
The beginning date for the aggregate window.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to true to get results that are NOT adjusted for splits.
https://api.polygon.io/v2/aggs/grouped/locale/global/market/fx/{date}?&apiKey=*
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The exchange symbol that this item is traded under.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
{
"status": "OK",
"queryCount": 3,
"resultsCount": 3,
"adjusted": true,
"results": [
{
"T": "C:CZKMXN",
"v": 29035,
"o": 0.98688,
"c": 0.97531,
"h": 0.9884522,
"l": 0.97468,
"t": 1599019200000
},
{
"T": "C:GBPCAD",
"v": 174749,
"o": 1.74807,
"c": 1.74102,
"h": 1.748579,
"l": 1.73482,
"t": 1599019200000
},
{
"T": "C:DKKAUD",
"v": 97005,
"o": 0.217479,
"c": 0.217072,
"h": 0.2176943,
"l": 0.2166342,
"t": 1599019200000
}
]
}
Get the previous day's open, high, low, and close (OHLC) for the specified forex pair.
The ticker symbol of the currency pair.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to true to get results that are NOT adjusted for splits.
https://api.polygon.io/v2/aggs/ticker/{forexTicker}/prev?&apiKey=*
The exchange symbol that this item is traded under.
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The exchange symbol that this item is traded under.
The trading volume of the symbol in the given time period.
The open price for the symbol in the given time period.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
{
"ticker": "C:EURUSD",
"status": "OK",
"queryCount": 1,
"resultsCount": 1,
"adjusted": true,
"results": [
{
"T": "C:EURUSD",
"v": 14500,
"o": 1.18421,
"c": 1.18522,
"h": 1.18545,
"l": 1.18341,
"t": 1605416400000
}
]
}
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.
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 true 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=*
The exchange symbol that this item is traded under.
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
The number of transactions in the aggregate window.
{
"ticker": "C:EURUSD",
"status": "OK",
"queryCount": 2,
"resultsCount": 2,
"adjusted": true,
"results": [
{
"v": 126690,
"o": 1.11327,
"c": 1.1126,
"h": 1.11536,
"l": 1.1099,
"t": 1590984000000,
"n": 1
},
{
"v": 155844,
"o": 1.11269,
"c": 1.12084,
"h": 1.12111,
"l": 1.1114,
"t": 1591070400000,
"n": 1
}
],
"request_id": "bb8fedcdc2e6237fc61f32024602593b"
}
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.
The forex ticker.
https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers/{ticker}?&apiKey=*
The status of this request's response.
A request id assigned by the server.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The ask price.
The bid price.
The Unix Msec timestamp for the start of the aggregate window.
The exchange ID on which this quote happened.
The last available minute bar.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
}
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.
A comma separated list of tickers to get snapshots for.
https://api.polygon.io/v2/snapshot/locale/global/markets/forex/tickers?&apiKey=*
The status of this request's response.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The ask price.
The bid price.
The Unix Msec timestamp for the start of the aggregate window.
The exchange ID on which this quote happened.
The last available minute bar.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
]
}
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.
The direction of the snapshot results to return.
https://api.polygon.io/v2/snapshot/locale/global/markets/forex/{direction}?&apiKey=*
The status of this request's response.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The ask price.
The bid price.
The Unix Msec timestamp for the start of the aggregate window.
The exchange ID on which this quote happened.
The last available minute bar.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
]
}
Get the last trade tick for a cryptocurrency pair.
The "from" symbol of the pair.
The "to" symbol of the pair.
https://api.polygon.io/v1/last/crypto/{from}/{to}?&apiKey=*
The status of this request's response.
A request id assigned by the server.
Conditions of this trade.
empty: 0 (or empty array) sellside: 1 buyside: 2
The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.
The price of the trade.
The size of the trade.
The Unix Msec timestamp for the start of the aggregate window.
The symbol pair that was evaluated from the request.
{
"last": {
"conditions": [
1
],
"exchange": 4,
"price": 16835.42,
"size": 0.006909,
"timestamp": 1605560885027
},
"request_id": "d2d779df015fe2b7fbb8e58366610ef7",
"status": "success",
"symbol": "BTC-USD"
}
Get the open, close prices of a cryptocurrency symbol on a certain day.
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 true to get results that are NOT adjusted for splits.
https://api.polygon.io/v1/open-close/crypto/{from}/{to}/{date}?&apiKey=*
The symbol pair that was evaluated from the request.
Whether or not the timestamps are in UTC timezone.
The date requested.
The open price for the symbol in the given time period.
The close price for the symbol in the given time period.
The price of the trade.
The size of the trade.
The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.
Conditions of this trade.
empty: 0 (or empty array) sellside: 1 buyside: 2
The Unix Msec timestamp for the start of the aggregate window.
The price of the trade.
The size of the trade.
The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.
Conditions of this trade.
empty: 0 (or empty array) sellside: 1 buyside: 2
The Unix Msec timestamp for the start of the aggregate window.
{
"symbol": "BTC-USD",
"isUTC": true,
"day": "2020-10-09T00:00:00.000Z",
"open": 10932.44,
"close": 11050.64,
"openTrades": [
{
"s": 0.002,
"p": 10932.44,
"x": 1,
"t": 1602201600056,
"c": [
2
]
},
{
"s": 0.02,
"p": 10923.76,
"x": 4,
"t": 1602201600141,
"c": [
2
]
}
],
"closingTrades": [
{
"s": 0.006128,
"p": 11050.64,
"x": 4,
"t": 1602287999795,
"c": [
2
]
},
{
"s": 0.014,
"p": 11049.4,
"x": 17,
"t": 1602287999659,
"c": [
1
]
}
]
}
Get historic trade ticks for a cryptocurrency pair.
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=*
The date that was evaluated from the request.
A map for shortened result keys.
The milliseconds of latency for the query results.
The symbol pair that was evaluated from the request.
The price of the trade.
The size of the trade.
The exchange that this crypto trade happened on.
See Crypto Exchanges for a mapping of exchanges to IDs.
Conditions of this trade.
empty: 0 (or empty array) sellside: 1 buyside: 2
The Unix Msec timestamp for the start of the aggregate window.
{
"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": [
{
"s": 0.00188217,
"p": 15482.89,
"x": 1,
"t": 1604880000067,
"c": [
2
]
},
{
"s": 0.00161739,
"p": 15482.11,
"x": 1,
"t": 1604880000167,
"c": [
2
]
}
],
"type": "crypto"
}
Get the daily open, high, low, and close (OHLC) for the entire cryptocurrency markets.
The beginning date for the aggregate window.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to true to get results that are NOT adjusted for splits.
https://api.polygon.io/v2/aggs/grouped/locale/global/market/crypto/{date}?&apiKey=*
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The exchange symbol that this item is traded under.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The Unix Msec timestamp for the start of the aggregate window.
{
"status": "OK",
"queryCount": 3,
"resultsCount": 3,
"adjusted": true,
"results": [
{
"T": "X:ARDRUSD",
"v": 2,
"vw": 0.0551,
"o": 0.0550762,
"c": 0.0550762,
"h": 0.0550762,
"l": 0.0550762,
"t": 1580676480000
},
{
"T": "X:NGCUSD",
"v": 4734,
"vw": 0.0273,
"o": 0.0273733,
"c": 0.0272983,
"h": 0.0273733,
"l": 0.0272983,
"t": 1580674080000
},
{
"T": "X:ZSCUSD",
"v": 390,
"vw": 0.0003,
"o": 0.00028531,
"c": 0.00028531,
"h": 0.00028531,
"l": 0.00028531,
"t": 1580671080000
}
]
}
Get the previous day's open, high, low, and close (OHLC) for the specified cryptocurrency pair.
The ticker symbol of the currency pair.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to true to get results that are NOT adjusted for splits.
https://api.polygon.io/v2/aggs/ticker/{cryptoTicker}/prev?&apiKey=*
The exchange symbol that this item is traded under.
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The exchange symbol that this item is traded under.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The Unix Msec timestamp for the start of the aggregate window.
{
"ticker": "X:BTCUSD",
"status": "OK",
"queryCount": 1,
"resultsCount": 1,
"adjusted": true,
"results": [
{
"T": "X:BTCUSD",
"v": 95045.16897951,
"vw": 15954.2111,
"o": 15937.1,
"c": 16035.9,
"h": 16180,
"l": 15639.2,
"t": 1605416400000
}
]
}
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.
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 true 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=*
The exchange symbol that this item is traded under.
The status of this request's response.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
The total number of results for this request.
A request id assigned by the server.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The Unix Msec timestamp for the start of the aggregate window.
The number of transactions in the aggregate window.
{
"ticker": "X:BTCUSD",
"status": "OK",
"queryCount": 2,
"resultsCount": 2,
"adjusted": true,
"results": [
{
"v": 303067.6562332156,
"vw": 9874.5529,
"o": 9557.9,
"c": 10094.75,
"h": 10429.26,
"l": 9490,
"t": 1590984000000,
"n": 1
},
{
"v": 323339.6922892879,
"vw": 9729.5701,
"o": 10096.87,
"c": 9492.62,
"h": 10222.72,
"l": 9135.68,
"t": 1591070400000,
"n": 1
}
],
"request_id": "0cf72b6da685bcd386548ffe2895904a"
}
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.
A comma separated list of tickers to get snapshots for.
https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers?&apiKey=*
The status of this request's response.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The last available minute bar.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
]
}
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.
Ticker of the snapshot
https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}?&apiKey=*
The status of this request's response.
A request id assigned by the server.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The last available minute bar.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
}
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.
The cryptocurrency ticker.
https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book?&apiKey=*
The exchange symbol that this item is traded under.
The price of this book level.
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.
The price of this book level.
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.
The combined total number of bids in the book.
The combined total number of asks in the book.
The difference between the best bid and the best ask price accross exchanges.
The last updated timestamp.
{
"status": "OK",
"data": {
"ticker": "X:BTCUSD",
"bids": [
{
"p": 16303.17,
"x": {
"1": 2
}
},
{
"p": 16302.94,
"x": {
"1": 0.02859424,
"6": 0.023455
}
}
],
"asks": [
{
"p": 11454,
"x": {
"2": 1
}
},
{
"p": 11455,
"x": {
"2": 1
}
}
],
"bidCount": 694.951789670001,
"askCount": 593.1412981600005,
"spread": -4849.17,
"updated": 1605295074162
}
}
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.
The direction of the snapshot results to return.
https://api.polygon.io/v2/snapshot/locale/global/markets/crypto/{direction}?&apiKey=*
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The last available minute bar.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The open price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The close price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The exchange symbol that this item is traded under.
The value of the change the from previous day.
The percentage change since the previous day.
The last updated timestamp.
{
"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
}
]
}