Forex API Documentation
The Polygon.io Forex API provides REST endpoints that let you query the latest market data for global currency pairs including forex trades and quotes, currency conversion rates, custom aggregate bars, and more.
Authentication
Pass your API key in the query string like follows:
Alternatively, you can add an Authorization header to the request with your API Key as the token in the following form:
Usage
Many of Polygon.io's REST endpoints allow you to extend query parameters with inequalities like date.lt=2023-01-01 (less than) and date.gte=2023-01-01 (greater than or equal to) to search ranges of values. You can also use the field name without any extension to query for exact equality. Fields that support extensions will have an "Additional filter parameters" dropdown beneath them in the docs that detail the supported extensions for that parameter.
Response Types
By default, all endpoints return a JSON response. Users with currencies Starter plan and above can request a CSV response by including 'Accept': 'text/csv' as a request parameter.
Aggregates (Bars)
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. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The end of the aggregate time window. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
Whether or not the results are adjusted for splits. By default, results are adjusted. Set this to false to get results that are NOT adjusted for splits.
Sort the results by timestamp.
asc will return results in ascending order (oldest at the top),
desc will return results in descending order (newest at the top).
Limits the number of base aggregates queried to create the aggregate results. Max 50000 and Default 5000. Read more about how limit is used to calculate aggregate results in our article on Aggregate Data API Improvements.
The exchange symbol that this item is traded under.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
A request id assigned by the server.
The total number of results for this request.
The status of this request's response.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
{
"adjusted": true,
"queryCount": 1,
"request_id": "79c061995d8b627b736170bc9653f15d",
"results": [
{
"c": 1.17721,
"h": 1.18305,
"l": 1.1756,
"n": 125329,
"o": 1.17921,
"t": 1626912000000,
"v": 125329,
"vw": 1.1789
}
],
"resultsCount": 1,
"status": "OK",
"ticker": "C:EURUSD"
}Grouped Daily (Bars)
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 false to get results that are NOT adjusted for splits.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
A request id assigned by the server.
The total number of results for this request.
The status of this request's response.
The exchange symbol that this item is traded under.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
{
"adjusted": true,
"queryCount": 3,
"results": [
{
"T": "C:ILSCHF",
"c": 0.2704,
"h": 0.2706,
"l": 0.2693,
"n": 689,
"o": 0.2698,
"t": 1602719999999,
"v": 689,
"vw": 0.2702
},
{
"T": "C:GBPCAD",
"c": 1.71103,
"h": 1.71642,
"l": 1.69064,
"n": 407324,
"o": 1.69955,
"t": 1602719999999,
"v": 407324,
"vw": 1.7062
},
{
"T": "C:DKKAUD",
"c": 0.2214,
"h": 0.2214,
"l": 0.2195,
"n": 10639,
"o": 0.22,
"t": 1602719999999,
"v": 10639,
"vw": 0.2202
}
],
"resultsCount": 3,
"status": "OK"
}Previous Close
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 false to get results that are NOT adjusted for splits.
The exchange symbol that this item is traded under.
Whether or not this response was adjusted for splits.
The number of aggregates (minute or day) used to generate the response.
A request id assigned by the server.
The total number of results for this request.
The status of this request's response.
The exchange symbol that this item is traded under.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
{
"adjusted": true,
"queryCount": 1,
"request_id": "08ec061fb85115678d68452c0a609cb7",
"results": [
{
"T": "C:EURUSD",
"c": 1.06206,
"h": 1.0631,
"l": 1.0505,
"n": 180300,
"o": 1.05252,
"t": 1651708799999,
"v": 180300,
"vw": 1.055
}
],
"resultsCount": 1,
"status": "OK",
"ticker": "C:EURUSD"
}Quotes (BBO)
Get BBO quotes for a ticker symbol in a given time range.
The ticker symbol to get quotes for.
Query by timestamp. Either a date with the format YYYY-MM-DD or a nanosecond timestamp.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 50000.
Sort field used for ordering.
If present, this value can be used to fetch the next page of data.
The ask exchange ID
The ask price.
The bid exchange ID
The bid price.
The nanosecond Exchange Unix Timestamp. This is the timestamp of when the quote was generated at the exchange.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v3/quotes/C:EUR-USD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": [
{
"ask_exchange": "48,",
"ask_price": "1.18565,",
"bid_exchange": "48,",
"bid_price": "1.18558,",
"participant_timestamp": 1625097600000000000
},
{
"ask_exchange": "48,",
"ask_price": "1.18565,",
"bid_exchange": "48,",
"bid_price": "1.18559,",
"participant_timestamp": 1625097600000000000
}
],
"status": "OK"
}Last Quote for a Currency Pair
Get the last quote tick for a forex currency pair.
The "from" symbol of the pair.
The "to" symbol of the pair.
The ask price.
The bid price.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The Unix millisecond timestamp.
A request id assigned by the server.
The status of this request's response.
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"
}Real-time Currency Conversion
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.
The result of the conversion.
The "from" currency symbol.
The amount to convert.
The ask price.
The bid price.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The Unix millisecond timestamp.
A request id assigned by the server.
The status of this request's response.
The symbol pair that was evaluated from the request.
The "to" currency symbol.
{
"converted": 73.14,
"from": "AUD",
"initialAmount": 100,
"last": {
"ask": 1.3673344,
"bid": 1.3672596,
"exchange": 48,
"timestamp": 1605555313000
},
"status": "success",
"to": "USD"
}All 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.
A comma separated list of tickers to get snapshots for.
The status of this request's response.
The most recent daily bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The most recent quote for this ticker.
The ask price.
The bid price.
The millisecond accuracy timestamp of the quote.
The exchange ID on which this quote happened.
The most recent minute bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The previous day's bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The 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
}
]
}Gainers/Losers
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.
The status of this request's response.
The most recent daily bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The most recent quote for this ticker.
The ask price.
The bid price.
The millisecond accuracy timestamp of the quote.
The exchange ID on which this quote happened.
The most recent minute bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The previous day's bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The 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
}
]
}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.
The forex ticker.
The status of this request's response.
A request id assigned by the server.
The most recent daily bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The most recent quote for this ticker.
The ask price.
The bid price.
The millisecond accuracy timestamp of the quote.
The exchange ID on which this quote happened.
The most recent minute bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The trading volume of the symbol in the given time period.
The previous day's bar for this ticker.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The open price for the symbol in the given time period.
The 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
}
}Simple Moving Average (SMA)
Get the simple moving average (SMA) for a ticker symbol over a given time range.
The ticker symbol for which to get simple moving average (SMA) data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
Whether or not the aggregates used to calculate the simple moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
The window size used to calculate the simple moving average (SMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.
The price in the aggregate which will be used to calculate the simple moving average. i.e. 'close' will result in using close prices to calculate the simple moving average (SMA).
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/sma/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"aggregates": [
{
"c": 75.0875,
"h": 75.15,
"l": 73.7975,
"n": 1,
"o": 74.06,
"t": 1577941200000,
"v": 135647456,
"vw": 74.6099
},
{
"c": 74.3575,
"h": 75.145,
"l": 74.125,
"n": 1,
"o": 74.2875,
"t": 1578027600000,
"v": 146535512,
"vw": 74.7026
}
],
"url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"timestamp": 1517562000016,
"value": 140.139
}
]
},
"status": "OK"
}Exponential Moving Average (EMA)
Get the exponential moving average (EMA) for a ticker symbol over a given time range.
The ticker symbol for which to get exponential moving average (EMA) data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
Whether or not the aggregates used to calculate the exponential moving average are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
The window size used to calculate the exponential moving average (EMA). i.e. a window size of 10 with daily aggregates would result in a 10 day moving average.
The price in the aggregate which will be used to calculate the exponential moving average. i.e. 'close' will result in using close prices to calculate the exponential moving average (EMA).
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/ema/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"timestamp": 1517562000016,
"value": 140.139
}
]
},
"status": "OK"
}Moving Average Convergence/Divergence (MACD)
Get moving average convergence/divergence (MACD) data for a ticker symbol over a given time range.
The ticker symbol for which to get MACD data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
Whether or not the aggregates used to calculate the MACD are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
The short window size used to calculate MACD data.
The long window size used to calculate MACD data.
The window size used to calculate the MACD signal line.
The price in the aggregate which will be used to calculate the MACD. i.e. 'close' will result in using close prices to calculate the MACD.
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The indicator value for this period.
The indicator value for this period.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/macd/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"histogram": 38.3801666667,
"signal": 106.9811666667,
"timestamp": 1517562000016,
"value": 145.3613333333
},
{
"histogram": 41.098859136,
"signal": 102.7386283473,
"timestamp": 1517562001016,
"value": 143.8374874833
}
]
},
"status": "OK"
}Relative Strength Index (RSI)
Get the relative strength index (RSI) for a ticker symbol over a given time range.
The ticker symbol for which to get relative strength index (RSI) data.
Query by timestamp. Either a date with the format YYYY-MM-DD or a millisecond timestamp.
The size of the aggregate time window.
Whether or not the aggregates used to calculate the relative strength index are adjusted for splits. By default, aggregates are adjusted. Set this to false to get results that are NOT adjusted for splits.
The window size used to calculate the relative strength index (RSI).
The price in the aggregate which will be used to calculate the relative strength index. i.e. 'close' will result in using close prices to calculate the relative strength index (RSI).
Whether or not to include the aggregates used to calculate this indicator in the response.
The order in which to return the results, ordered by timestamp.
Limit the number of results returned, default is 10 and max is 5000
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
The close price for the symbol in the given time period.
The highest price for the symbol in the given time period.
The lowest price for the symbol in the given time period.
The number of transactions in the aggregate window.
The open price for the symbol in the given time period.
Whether or not this aggregate is for an OTC ticker. This field will be left off if false.
The Unix Msec timestamp for the start of the aggregate window.
The trading volume of the symbol in the given time period.
The volume weighted average price.
The URL which can be used to request the underlying aggregates used in this request.
The Unix Msec timestamp from the last aggregate used in this calculation.
The indicator value for this period.
The status of this request's response.
{
"next_url": "https://api.polygon.io/v1/indicators/rsi/C:USDAUD?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
"results": {
"underlying": {
"url": "https://api.polygon.io/v2/aggs/ticker/C:USDAUD/range/1/day/2003-01-01/2022-07-25"
},
"values": [
{
"timestamp": 1517562000016,
"value": 140.139
}
]
},
"status": "OK"
}Tickers
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 the CIK of the asset you want to search for. Find more information about CIK codes at their website. Defaults to empty string which queries all CIKs.
Specify a point in time to retrieve tickers available on that date. Defaults to the most recent available date.
Search for terms within the ticker and/or company name.
Specify if the tickers returned should be actively traded on the queried date. Default is true.
Order results based on the sort field.
Limit the number of results returned, default is 100 and max is 1000.
Sort field used for ordering.
The total number of results for this request.
If present, this value can be used to fetch the next page of data.
A request id assigned by the server.
An array of tickers that match your query.
Note: Although you can query by CUSIP, due to legal reasons we do not return the CUSIP in the response.
Whether or not the asset is actively traded. False means the asset has been delisted.
The CIK number for this ticker. Find more information here.
The composite OpenFIGI number for this ticker. Find more information here
The name of the currency that this asset is traded with.
The last date that the asset was traded.
The information is accurate up to this time.
The locale of the asset.
The market type of the asset.
The name of the asset. For stocks/equities this will be the companies registered name. For crypto/fx this will be the name of the currency or coin pair.
The ISO code of the primary listing exchange for this asset.
The share Class OpenFIGI number for this ticker. Find more information here
The exchange symbol that this item is traded under.
The type of the asset. Find the types that we support via our Ticker Types API.
The status of this request's response.
{
"count": 1,
"next_url": "https://api.polygon.io/v3/reference/tickers?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
"request_id": "e70013d92930de90e089dc8fa098888e",
"results": [
{
"active": true,
"cik": "0001090872",
"composite_figi": "BBG000BWQYZ5",
"currency_name": "usd",
"last_updated_utc": "2021-04-25T00:00:00Z",
"locale": "us",
"market": "stocks",
"name": "Agilent Technologies Inc.",
"primary_exchange": "XNYS",
"share_class_figi": "BBG001SCTQY4",
"ticker": "A",
"type": "CS"
}
],
"status": "OK"
}The market close time on the holiday (if it's not closed).
The date of the holiday.
Which market the record is for.
The name of the holiday.
The market open time on the holiday (if it's not closed).
The status of the market on the holiday.
[
{
"date": "2020-11-26T00:00:00.000Z",
"exchange": "NYSE",
"name": "Thanksgiving",
"status": "closed"
},
{
"date": "2020-11-26T00:00:00.000Z",
"exchange": "NASDAQ",
"name": "Thanksgiving",
"status": "closed"
},
{
"date": "2020-11-26T00:00:00.000Z",
"exchange": "OTC",
"name": "Thanksgiving",
"status": "closed"
},
{
"close": "2020-11-27T18:00:00.000Z",
"date": "2020-11-27T00:00:00.000Z",
"exchange": "NASDAQ",
"name": "Thanksgiving",
"open": "2020-11-27T14:30:00.000Z",
"status": "early-close"
},
{
"close": "2020-11-27T18:00:00.000Z",
"date": "2020-11-27T00:00:00.000Z",
"exchange": "NYSE",
"name": "Thanksgiving",
"open": "2020-11-27T14:30:00.000Z",
"status": "early-close"
}
]Market Status
Get the current trading status of the exchanges and overall financial markets.
Whether or not the market is in post-market hours.
The status of the crypto market.
The status of the forex market.
Whether or not the market is in pre-market hours.
The status of the Nasdaq market.
The status of the NYSE market.
The status of the OTC market.
The status of the market as a whole.
The current time of the server.
{
"afterHours": true,
"currencies": {
"crypto": "open",
"fx": "open"
},
"earlyHours": false,
"exchanges": {
"nasdaq": "extended-hours",
"nyse": "extended-hours",
"otc": "closed"
},
"market": "extended-hours",
"serverTime": "2020-11-10T22:37:37.000Z"
}Filter for conditions within a given asset class.
Filter by data type.
Filter for conditions with a given ID.
Filter by SIP. If the condition contains a mapping for that SIP, the condition will be returned.
Order results based on the sort field.
Limit the number of results returned, default is 10 and max is 1000.
Sort field used for ordering.
The total number of results for this request.
If present, this value can be used to fetch the next page of data.
A request ID assigned by the server.
An array of conditions that match your query.
A commonly-used abbreviation for this condition.
An identifier for a group of similar financial instruments.
Data types that this condition applies to.
A short description of the semantics of this condition.
If present, mapping this condition from a Polygon.io code to a SIP symbol depends on this attribute. In other words, data with this condition attached comes exclusively from the given exchange.
An identifier used by Polygon.io for this condition. Unique per data type.
If true, this condition is from an old version of the SIPs' specs and no longer is used. Other conditions may or may not reuse the same symbol as this one.
The name of this condition.
A mapping to a symbol for each SIP that has this condition.
An identifier for a collection of related conditions.
A list of aggregation rules.
Describes aggregation rules on a consolidated (all exchanges) basis.
Whether or not trades with this condition update the high/low.
Whether or not trades with this condition update the open/close.
Whether or not trades with this condition update the volume.
Describes aggregation rules on a per-market-center basis.
Whether or not trades with this condition update the high/low.
Whether or not trades with this condition update the open/close.
Whether or not trades with this condition update the volume.
The status of this request's response.
{
"count": 1,
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"results": [
{
"asset_class": "stocks",
"data_types": [
"trade"
],
"id": 2,
"name": "Average Price Trade",
"sip_mapping": {
"CTA": "B",
"UTP": "W"
},
"type": "condition",
"update_rules": {
"consolidated": {
"updates_high_low": false,
"updates_open_close": false,
"updates_volume": true
},
"market_center": {
"updates_high_low": false,
"updates_open_close": false,
"updates_volume": true
}
}
}
],
"status": "OK"
}Filter by asset class.
Filter by locale.
The total number of results for this request.
A request ID assigned by the server.
A commonly used abbreviation for this exchange.
An identifier for a group of similar financial instruments.
A unique identifier used by Polygon.io for this exchange.
An identifier for a geographical location.
The Market Identifer Code of this exchange (see ISO 10383).
Name of this exchange.
The MIC of the entity that operates this exchange.
The ID used by SIP's to represent this exchange.
Represents the type of exchange.
A link to this exchange's website, if one exists.
The status of this request's response.
{
"count": 1,
"request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
"results": [
{
"acronym": "AMEX",
"asset_class": "stocks",
"id": 1,
"locale": "us",
"mic": "XASE",
"name": "NYSE American, LLC",
"operating_mic": "XNYS",
"participant_id": "A",
"type": "exchange",
"url": "https://www.nyse.com/markets/nyse-american"
}
],
"status": "OK"
}Forex WebSocket Documentation
The Polygon.io Forex WebSocket API provides streaming access to the latest financial market data for global currency pairs. You can specify which channels you want to consume by sending instructions in the form of actions. Our WebSockets emit events to notify you when an event has occurred in a channel you've subscribed to.
Our WebSocket APIs are based on entitlements that control which WebSocket Clusters you can connect to and which kinds of data you can access. You can login to see examples that include your API key and are personalized to your entitlements.
Step 1: Connect
With a premium Forex plan, you will be able to use a single connection to the Forex Cluster. If another connection attempts to connect to the Forex Cluster simultaneously, the current connection will be disconnected. If you need more simultaneous connections to this cluster, you can contact support.
Connecting to a cluster:
On connection you will receive the following message:
[{
"ev":"status",
"status":"connected",
"message": "Connected Successfully"
}]Step 2: Authenticate
You must authenticate before you can make any other requests.
On successful authentication you will receive the following message:
[{
"ev":"status",
"status":"auth_success",
"message": "authenticated"
}]Step 3: Subscribe
Once authenticated, you can request a stream. You can request multiple streams in the same request.
You can also request multiple streams from the same cluster.
Usage
Things happen very quickly in the world of finance, which means a Polygon.io WebSocket client must be able to handle many incoming messages per second. Due to the nature of the WebSocket protocol, if a client is slow to consume messages from the server, Polygon.io's server must buffer messages and send them only as fast as the client can consume them. To help prevent the message buffer from getting too long, Polygon.io may send more than one JSON object in a single WebSocket message. We accomplish this by wrapping all messages in a JSON array, and adding more objects to the array if the message buffer is getting longer. For example, consider a WebSocket message with a single trade event in it:
[
{"ev":"T","sym":"C.C:EUR-USD","i":"50578","x":4,"p":215.9721,"s":100,"t":1611082428813,"z":3}
]If your client is consuming a bit slow, or 2+ events happened in very short succession, you may receive a single WebSocket message with more than one event inside it, like this:
[
{"ev":"T","sym":"C.C:EUR-USD","i":"50578","x":4,"p":215.9721,"s":100,"t":1611082428813,"z":3},
{"ev":"T","sym":"C.C:JPY-USD","i":"12856","x":4,"p":215.989,"s":1,"c":[37],"t":1611082428814,"z":3}
]Note that if a client is consuming messages too slowly for too long, Polygon.io's server-side buffer may get too large. If that happens, Polygon.io will terminate the WebSocket connection. You can check your account dashboard to see if a connection was terminated as a slow consumer. If this happens to you consistently, consider subscribing to fewer symbols or channels.
Aggregates (Per Minute)
Stream real-time per-minute forex aggregates for a given forex pair.
Specify a forex pair in the format {from}/{to} or use * to subscribe to all forex pairs. You can also use a comma separated list to subscribe to multiple forex pairs. You can retrieve active forex tickers from our Forex Tickers API.
The event type.
The currency pair.
The open price for this aggregate window.
The close price for this aggregate window.
The high price for this aggregate window.
The low price for this aggregate window.
The volume of trades during this aggregate window.
The start time for this aggregate window in Unix Milliseconds.
The end time for this aggregate window in Unix Milliseconds.
{
"ev": "CA",
"pair": "USD/EUR",
"o": 0.8687,
"c": 0.86889,
"h": 0.86889,
"l": 0.8686,
"v": 20,
"s": 1539145740000
}Quotes
Stream real-time forex quotes for a given forex pair.
Specify a forex pair in the format {from}/{to} or use * to subscribe to all forex pairs. You can also use a comma separated list to subscribe to multiple forex pairs. You can retrieve active forex tickers from our Forex Tickers API.
The event type.
The current pair.
The exchange ID. See Exchanges for Polygon.io's mapping of exchange IDs.
The ask price.
The bid price.
The Timestamp in Unix MS.
{
"ev": "C",
"p": "USD/CNH",
"x": "44",
"a": 6.83366,
"b": 6.83363,
"t": 1536036818784
}