A diff between this client library's spec and our hosted spec was found. The client may need an update to match any changes in our API. See the diff below:
--- https://raw.githubusercontent.com/polygon-io/client-jvm/master/.polygon/rest.json
+++ https://api.polygon.io/openapi
@@ -79,6 +79,7 @@
"required": true,
"schema": {
"enum": [
+ "second",
"minute",
"hour",
"day",
@@ -150,7 +151,7 @@
},
"IndicesTickerPathParam": {
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -6339,7 +6340,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get exponential moving average (EMA) data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -6485,16 +6486,16 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/ema/I:DJI?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTQwNDcuNDEwMDAwMDAwMDAwMyUyQyUyMmglMjIlM0EwJTJDJTIybCUyMiUzQTAlMkMlMjJ0JTIyJTNBMTY3ODA4MjQwMDAwMCU3RCZhcz0mZXhwYW5kX3VuZGVybHlpbmc9ZmFsc2UmbGltaXQ9MTAmb3JkZXI9ZGVzYyZzZXJpZXNfdHlwZT1jbG9zZSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2NzgxNjUyMDAwMDAmd2luZG93PTU",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/ema/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01MA",
+ "request_id": "b9201816341441eed663a90443c0623a",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678726291180?limit=35&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366449650?limit=226&sort=desc"
},
"values": [
{
- "timestamp": 1681966800000,
- "value": 33355.64416487007
+ "timestamp": 1687237200000,
+ "value": 14452.002555459003
}
]
},
@@ -8001,7 +7997,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get MACD data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -8167,24 +8163,24 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/macd/I:DJI?cursor=YWN0aXZlPXRydWUmZGF0ZT0yMDIxLTA0LTI1JmxpbWl0PTEmb3JkZXI9YXNjJnBhZ2VfbWFya2VyPUElN0M5YWRjMjY0ZTgyM2E1ZjBiOGUyNDc5YmZiOGE1YmYwNDVkYzU0YjgwMDcyMWE2YmI1ZjBjMjQwMjU4MjFmNGZiJnNvcnQ9dGlja2Vy",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/macd/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MTUwODAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0yJmxvbmdfd2luZG93PTI2Jm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2Umc2hvcnRfd2luZG93PTEyJnNpZ25hbF93aW5kb3c9OSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2ODcyMTkyMDAwMDA",
+ "request_id": "2eeda0be57e83cbc64cc8d1a74e84dbd",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678726155743?limit=129&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366537196?limit=121&sort=desc"
},
"values": [
{
- "histogram": -48.29157370302107,
- "signal": 225.60959338746886,
- "timestamp": 1681966800000,
- "value": 177.3180196844478
+ "histogram": -4.7646219788108795,
+ "signal": 220.7596784587801,
+ "timestamp": 1687237200000,
+ "value": 215.9950564799692
},
{
- "histogram": -37.55634001543484,
- "signal": 237.6824868132241,
- "timestamp": 1681963200000,
- "value": 200.12614679778926
+ "histogram": 3.4518937661882205,
+ "signal": 221.9508339534828,
+ "timestamp": 1687219200000,
+ "value": 225.40272771967102
}
]
},
@@ -9707,7 +9696,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get relative strength index (RSI) data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -9853,16 +9842,16 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/rsi/I:DJI?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTQwNDcuNDEwMDAwMDAwMDAwMyUyQyUyMmglMjIlM0EwJTJDJTIybCUyMiUzQTAlMkMlMjJ0JTIyJTNBMTY3ODA4MjQwMDAwMCU3RCZhcz0mZXhwYW5kX3VuZGVybHlpbmc9ZmFsc2UmbGltaXQ9MTAmb3JkZXI9ZGVzYyZzZXJpZXNfdHlwZT1jbG9zZSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2NzgxNjUyMDAwMDAmd2luZG93PTU",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/rsi/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz0xNA",
+ "request_id": "28a8417f521f98e1d08f6ed7d1fbcad3",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678725829099?limit=35&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366658253?limit=66&sort=desc"
},
"values": [
{
- "timestamp": 1681966800000,
- "value": 55.89394103205648
+ "timestamp": 1687237200000,
+ "value": 73.98019439047955
}
]
},
@@ -11325,7 +11309,7 @@
"parameters": [
{
"description": "The ticker symbol for which to get simple moving average (SMA) data.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -11471,16 +11455,16 @@
"content": {
"application/json": {
"example": {
- "next_url": "https://api.polygon.io/v1/indicators/sma/I:DJI?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTQwNDcuNDEwMDAwMDAwMDAwMyUyQyUyMmglMjIlM0EwJTJDJTIybCUyMiUzQTAlMkMlMjJ0JTIyJTNBMTY3ODA4MjQwMDAwMCU3RCZhcz0mZXhwYW5kX3VuZGVybHlpbmc9ZmFsc2UmbGltaXQ9MTAmb3JkZXI9ZGVzYyZzZXJpZXNfdHlwZT1jbG9zZSZ0aW1lc3Bhbj1kYXkmdGltZXN0YW1wLmx0PTE2NzgxNjUyMDAwMDAmd2luZG93PTU",
- "request_id": "a47d1beb8c11b6ae897ab76cdbbf35a3",
+ "next_url": "https://api.polygon.io/v1/indicators/sma/I:NDX?cursor=YWRqdXN0ZWQ9dHJ1ZSZhcD0lN0IlMjJ2JTIyJTNBMCUyQyUyMm8lMjIlM0EwJTJDJTIyYyUyMiUzQTE1MDg0Ljk5OTM4OTgyMDAzJTJDJTIyaCUyMiUzQTAlMkMlMjJsJTIyJTNBMCUyQyUyMnQlMjIlM0ExNjg3MjE5MjAwMDAwJTdEJmFzPSZleHBhbmRfdW5kZXJseWluZz1mYWxzZSZsaW1pdD0xJm9yZGVyPWRlc2Mmc2VyaWVzX3R5cGU9Y2xvc2UmdGltZXNwYW49ZGF5JnRpbWVzdGFtcC5sdD0xNjg3MjM3MjAwMDAwJndpbmRvdz01Mw",
+ "request_id": "4cae270008cb3f947e3f92c206e3888a",
"results": {
"underlying": {
- "url": "https://api.polygon.io/v2/aggs/ticker/I:DJI/range/1/day/1063281600000/1678725829099?limit=35&sort=desc"
+ "url": "https://api.polygon.io/v2/aggs/ticker/I:NDX/range/1/day/1678338000000/1687366378997?limit=240&sort=desc"
},
"values": [
{
- "timestamp": 1681966800000,
- "value": 33236.3424
+ "timestamp": 1687237200000,
+ "value": 14362.676417589264
}
]
},
@@ -13042,7 +13021,7 @@
"parameters": [
{
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -13057,7 +13036,6 @@
"name": "date",
"required": true,
"schema": {
- "format": "date",
"type": "string"
}
}
@@ -13067,15 +13045,15 @@
"content": {
"application/json": {
"example": {
- "afterHours": 31909.64,
- "close": 32245.14,
- "from": "2023-03-10",
- "high": 32988.26,
- "low": 32200.66,
- "open": 32922.75,
- "preMarket": 32338.23,
+ "afterHours": 11830.43006295237,
+ "close": 11830.28178808306,
+ "from": "2023-03-10T00:00:00.000Z",
+ "high": 12069.62262033557,
+ "low": 11789.85923449393,
+ "open": 12001.69552583921,
+ "preMarket": 12001.69552583921,
"status": "OK",
- "symbol": "I:DJI"
+ "symbol": "I:NDX"
},
"schema": {
"properties": {
@@ -13133,6 +13110,12 @@
],
"type": "object"
}
+ },
+ "text/csv": {
+ "example": "from,open,high,low,close,afterHours,preMarket\n2023-01-10,12001.69552583921,12069.62262033557,11789.85923449393,11830.28178808306,26122646,11830.43006295237,12001.69552583921\n",
+ "schema": {
+ "type": "string"
+ }
}
},
"description": "The open/close of this stock symbol."
@@ -13145,6 +13128,7 @@
"tags": [
"stocks:open-close"
],
+ "x-polygon-entitlement-allowed-limited-tickers": true,
"x-polygon-entitlement-data-type": {
"description": "Aggregate data",
"name": "aggregates"
@@ -15579,6 +15563,7 @@
"required": true,
"schema": {
"enum": [
+ "second",
"minute",
"hour",
"day",
@@ -16031,6 +16016,7 @@
"required": true,
"schema": {
"enum": [
+ "second",
"minute",
"hour",
"day",
@@ -16258,7 +16244,7 @@
"parameters": [
{
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -16276,17 +16262,17 @@
"request_id": "b2170df985474b6d21a6eeccfb6bee67",
"results": [
{
- "T": "I:DJI",
- "c": 33786.62,
- "h": 33786.62,
- "l": 33677.74,
- "o": 33677.74,
- "t": 1682020800000
+ "T": "I:NDX",
+ "c": 15070.14948566977,
+ "h": 15127.4195807999,
+ "l": 14946.7243781848,
+ "o": 15036.48391066877,
+ "t": 1687291200000
}
],
"resultsCount": 1,
"status": "OK",
- "ticker": "I:DJI"
+ "ticker": "I:NDX"
},
"schema": {
"allOf": [
@@ -16375,6 +16357,12 @@
}
]
}
+ },
+ "text/csv": {
+ "example": "T,c,h,l,o,t,v,vw\nI:NDX,15036.48391066877,15070.14948566977,15127.4195807999,14946.7243781848,1687291200000\n",
+ "schema": {
+ "type": "string"
+ }
}
},
"description": "The previous day OHLC for a index."
@@ -16387,6 +16375,7 @@
"tags": [
"indices:aggregates"
],
+ "x-polygon-entitlement-allowed-limited-tickers": true,
"x-polygon-entitlement-data-type": {
"description": "Aggregate data",
"name": "aggregates"
@@ -16403,7 +16392,7 @@
"parameters": [
{
"description": "The ticker symbol of Index.",
- "example": "I:DJI",
+ "example": "I:NDX",
"in": "path",
"name": "indicesTicker",
"required": true,
@@ -16429,6 +16418,7 @@
"required": true,
"schema": {
"enum": [
+ "second",
"minute",
"hour",
"day",
@@ -16492,22 +16482,22 @@
"request_id": "0cf72b6da685bcd386548ffe2895904a",
"results": [
{
- "c": 32245.14,
- "h": 32988.26,
- "l": 32200.66,
- "o": 32922.75,
+ "c": 11995.88235998666,
+ "h": 12340.44936267155,
+ "l": 11970.34221717375,
+ "o": 12230.83658266843,
"t": 1678341600000
},
{
- "c": 31787.7,
- "h": 32422.100000000002,
- "l": 31786.06,
- "o": 32198.9,
+ "c": 11830.28178808306,
+ "h": 12069.62262033557,
+ "l": 11789.85923449393,
+ "o": 12001.69552583921,
"t": 1678428000000
}
],
"status": "OK",
- "ticker": "I:DJI"
+ "ticker": "I:NDX"
},
"schema": {
"allOf": [
@@ -16596,6 +16579,12 @@
}
]
}
+ },
+ "text/csv": {
+ "example": "c,h,l,n,o,t\n11995.88235998666,12340.44936267155,11970.34221717375,12230.83658266843,1678341600000\n11830.28178808306,12069.62262033557,11789.85923449393,12001.69552583921,1678341600000\n",
+ "schema": {
+ "type": "string"
+ }
}
},
"description": "Index Aggregates."
@@ -16608,6 +16597,7 @@
"tags": [
"indices:aggregates"
],
+ "x-polygon-entitlement-allowed-limited-tickers": true,
"x-polygon-entitlement-data-type": {
"description": "Aggregate data",
"name": "aggregates"
@@ -16834,6 +16824,7 @@
"required": true,
"schema": {
"enum": [
+ "second",
"minute",
"hour",
"day",
@@ -17281,6 +17272,7 @@
"required": true,
"schema": {
"enum": [
+ "second",
"minute",
"hour",
"day",
@@ -18512,7 +18504,9 @@
"c": 0.296,
"h": 0.296,
"l": 0.294,
+ "n": 2,
"o": 0.296,
+ "t": 1684427880000,
"v": 123.4866,
"vw": 0
},
@@ -18861,7 +18854,9 @@
"c": 16235.1,
"h": 16264.29,
"l": 16129.3,
+ "n": 558,
"o": 16257.51,
+ "t": 1684428960000,
"v": 19.30791925,
"vw": 0
},
@@ -19410,7 +19404,9 @@
"c": 0.062377,
"h": 0.062377,
"l": 0.062377,
+ "n": 2,
"o": 0.062377,
+ "t": 1684426740000,
"v": 35420,
"vw": 0
},
@@ -19747,7 +19742,9 @@
"c": 0.117769,
"h": 0.11779633,
"l": 0.11773698,
+ "n": 1,
"o": 0.11778,
+ "t": 1684422000000,
"v": 202
},
"prevDay": {
@@ -20052,7 +20048,9 @@
"c": 1.18396,
"h": 1.18423,
"l": 1.1838,
+ "n": 85,
"o": 1.18404,
+ "t": 1684422000000,
"v": 41
},
"prevDay": {
@@ -20368,7 +20365,9 @@
"c": 0.886156,
"h": 0.886156,
"l": 0.886156,
+ "n": 1,
"o": 0.886156,
+ "t": 1684422000000,
"v": 1
},
"prevDay": {
@@ -20698,7 +20696,9 @@
"c": 20.506,
"h": 20.506,
"l": 20.506,
+ "n": 1,
"o": 20.506,
+ "t": 1684428600000,
"v": 5000,
"vw": 20.5105
},
@@ -21096,7 +21095,9 @@
"c": 120.4201,
"h": 120.468,
"l": 120.37,
+ "n": 762,
"o": 120.435,
+ "t": 1684428720000,
"v": 270796,
"vw": 120.4129
},
@@ -21509,7 +21509,9 @@
"c": 14.2284,
"h": 14.325,
"l": 14.2,
+ "n": 5,
"o": 14.28,
+ "t": 1684428600000,
"v": 6108,
"vw": 14.2426
},
@@ -22513,7 +22514,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -22521,7 +22522,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -22529,7 +22530,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -22537,7 +22538,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -22738,7 +22739,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -22746,7 +22747,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -22754,7 +22755,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -22762,7 +22763,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -22978,7 +22979,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -22986,7 +22987,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -22994,7 +22995,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -23002,7 +23003,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -24122,7 +24123,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gte",
"schema": {
@@ -24130,7 +24131,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gt",
"schema": {
@@ -24138,7 +24139,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lte",
"schema": {
@@ -24146,7 +24147,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lt",
"schema": {
@@ -24154,7 +24155,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.gte",
"schema": {
@@ -24163,7 +24164,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.gt",
"schema": {
@@ -24172,7 +24173,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.lte",
"schema": {
@@ -24181,7 +24182,7 @@
}
},
{
- "description": "Search by ex_dividend_date.",
+ "description": "Range by ex_dividend_date.",
"in": "query",
"name": "ex_dividend_date.lt",
"schema": {
@@ -24190,7 +24191,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.gte",
"schema": {
@@ -24199,7 +24200,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.gt",
"schema": {
@@ -24208,7 +24209,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.lte",
"schema": {
@@ -24217,7 +24218,7 @@
}
},
{
- "description": "Search by record_date.",
+ "description": "Range by record_date.",
"in": "query",
"name": "record_date.lt",
"schema": {
@@ -24226,7 +24227,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.gte",
"schema": {
@@ -24235,7 +24236,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.gt",
"schema": {
@@ -24244,7 +24245,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.lte",
"schema": {
@@ -24253,7 +24254,7 @@
}
},
{
- "description": "Search by declaration_date.",
+ "description": "Range by declaration_date.",
"in": "query",
"name": "declaration_date.lt",
"schema": {
@@ -24262,7 +24263,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.gte",
"schema": {
@@ -24271,7 +24272,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.gt",
"schema": {
@@ -24280,7 +24281,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.lte",
"schema": {
@@ -24289,7 +24290,7 @@
}
},
{
- "description": "Search by pay_date.",
+ "description": "Range by pay_date.",
"in": "query",
"name": "pay_date.lt",
"schema": {
@@ -24298,7 +24299,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.gte",
"schema": {
@@ -24306,7 +24307,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.gt",
"schema": {
@@ -24314,7 +24315,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.lte",
"schema": {
@@ -24322,7 +24323,7 @@
}
},
{
- "description": "Search by cash_amount.",
+ "description": "Range by cash_amount.",
"in": "query",
"name": "cash_amount.lt",
"schema": {
@@ -24568,349 +24569,6 @@
]
}
}
- },
- "post": {
- "description": "Manually add Polygon a dividend.",
- "operationId": "CreateDividend",
- "parameters": [
- {
- "description": "If true don't trigger overlay",
- "in": "query",
- "name": "skip_overlay_trigger",
- "schema": {
- "default": false,
- "type": "boolean"
- }
- }
- ],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "cash_amount": {
- "description": "The cash amount of the dividend per share owned.",
- "type": "number",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "currency": {
- "description": "The currency in which the dividend is paid.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "declaration_date": {
- "description": "The date that the dividend was announced.",
- "type": "string"
- },
- "dividend_type": {
- "description": "The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\nLong-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.",
- "enum": [
- "CD",
- "SC",
- "LT",
- "ST"
- ],
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "ex_dividend_date": {
- "description": "The date that the stock first trades without the dividend, determined by the exchange.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "frequency": {
- "description": "The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), and 12 (monthly).",
- "type": "integer",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "pay_date": {
- "description": "The date that the dividend is paid out.",
- "type": "string"
- },
- "record_date": {
- "description": "The date that the stock must be held to receive the dividend, set by the company.",
- "type": "string"
- },
- "ticker": {
- "description": "The ticker symbol of the dividend.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- }
- },
- "required": [
- "ticker",
- "ex_dividend_date",
- "frequency",
- "cash_amount",
- "dividend_type"
- ],
- "type": "object",
- "x-polygon-go-struct-tags": {
- "tags": [
- "db"
- ]
- }
- }
- }
- },
- "description": "Pass the desired dividend in the request body.",
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "request_id": {
- "type": "string"
- },
- "results": {
- "properties": {
- "cash_amount": {
- "description": "The cash amount of the dividend per share owned.",
- "type": "number",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "currency": {
- "description": "The currency in which the dividend is paid.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "declaration_date": {
- "description": "The date that the dividend was announced.",
- "type": "string"
- },
- "dividend_type": {
- "description": "The type of dividend. Dividends that have been paid and/or are expected to be paid on consistent schedules are denoted as CD.\nSpecial Cash dividends that have been paid that are infrequent or unusual, and/or can not be expected to occur in the future are denoted as SC.\nLong-Term and Short-Term capital gain distributions are denoted as LT and ST, respectively.",
- "enum": [
- "CD",
- "SC",
- "LT",
- "ST"
- ],
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "ex_dividend_date": {
- "description": "The date that the stock first trades without the dividend, determined by the exchange.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "frequency": {
- "description": "The number of times per year the dividend is paid out. Possible values are 0 (one-time), 1 (annually), 2 (bi-annually), 4 (quarterly), and 12 (monthly).",
- "type": "integer",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- },
- "pay_date": {
- "description": "The date that the dividend is paid out.",
- "type": "string"
- },
- "record_date": {
- "description": "The date that the stock must be held to receive the dividend, set by the company.",
- "type": "string"
- },
- "ticker": {
- "description": "The ticker symbol of the dividend.",
- "type": "string",
- "x-polygon-go-field-tags": {
- "tags": [
- {
- "key": "binding",
- "value": "required"
- }
- ]
- }
- }
- },
- "required": [
- "ticker",
- "ex_dividend_date",
- "frequency",
- "cash_amount",
- "dividend_type"
- ],
- "type": "object",
- "x-polygon-go-struct-tags": {
- "tags": [
- "db"
- ]
- }
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id"
- ],
- "type": "object"
- }
- }
- },
- "description": "OK"
- },
- "400": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "error": {
- "type": "string"
- },
- "request_id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id",
- "error"
- ],
- "type": "object"
- }
- }
- },
- "description": "the requested update was unable to be performed due to an invalid request body"
- },
- "409": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "error": {
- "type": "string"
- },
- "request_id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id",
- "error"
- ],
- "type": "object"
- }
- }
- },
- "description": "a dividend already exists for this date and ticker"
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {
- "error": {
- "type": "string"
- },
- "request_id": {
- "type": "string"
- },
- "status": {
- "type": "string"
- }
- },
- "required": [
- "request_id",
- "error"
- ],
- "type": "object"
- }
- }
- },
- "description": "unknown error"
- }
- },
- "summary": "Dividends v3",
- "tags": [
- "reference:stocks"
- ],
- "x-polygon-entitlement-data-type": {
- "description": "Reference data",
- "name": "reference"
- }
}
},
"/v3/reference/exchanges": {
@@ -25218,7 +24876,7 @@
}
},
{
- "description": "Search by underlying_ticker.",
+ "description": "Range by underlying_ticker.",
"in": "query",
"name": "underlying_ticker.gte",
"schema": {
@@ -25226,7 +24884,7 @@
}
},
{
- "description": "Search by underlying_ticker.",
+ "description": "Range by underlying_ticker.",
"in": "query",
"name": "underlying_ticker.gt",
"schema": {
@@ -25234,7 +24892,7 @@
}
},
{
- "description": "Search by underlying_ticker.",
+ "description": "Range by underlying_ticker.",
"in": "query",
"name": "underlying_ticker.lte",
"schema": {
@@ -25242,7 +24900,7 @@
}
},
{
- "description": "Search by underlying_ticker.",
+ "description": "Range by underlying_ticker.",
"in": "query",
"name": "underlying_ticker.lt",
"schema": {
@@ -25250,7 +24908,7 @@
}
},
{
- "description": "Search by expiration_date.",
+ "description": "Range by expiration_date.",
"in": "query",
"name": "expiration_date.gte",
"schema": {
@@ -25258,7 +24916,7 @@
}
},
{
- "description": "Search by expiration_date.",
+ "description": "Range by expiration_date.",
"in": "query",
"name": "expiration_date.gt",
"schema": {
@@ -25266,7 +24924,7 @@
}
},
{
- "description": "Search by expiration_date.",
+ "description": "Range by expiration_date.",
"in": "query",
"name": "expiration_date.lte",
"schema": {
@@ -25274,7 +24932,7 @@
}
},
{
- "description": "Search by expiration_date.",
+ "description": "Range by expiration_date.",
"in": "query",
"name": "expiration_date.lt",
"schema": {
@@ -25282,7 +24940,7 @@
}
},
{
- "description": "Search by strike_price.",
+ "description": "Range by strike_price.",
"in": "query",
"name": "strike_price.gte",
"schema": {
@@ -25290,7 +24948,7 @@
}
},
{
- "description": "Search by strike_price.",
+ "description": "Range by strike_price.",
"in": "query",
"name": "strike_price.gt",
"schema": {
@@ -25298,7 +24956,7 @@
}
},
{
- "description": "Search by strike_price.",
+ "description": "Range by strike_price.",
"in": "query",
"name": "strike_price.lte",
"schema": {
@@ -25306,7 +24964,7 @@
}
},
{
- "description": "Search by strike_price.",
+ "description": "Range by strike_price.",
"in": "query",
"name": "strike_price.lt",
"schema": {
@@ -26072,7 +25730,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gte",
"schema": {
@@ -26080,7 +25738,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.gt",
"schema": {
@@ -26088,7 +25746,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lte",
"schema": {
@@ -26096,7 +25754,7 @@
}
},
{
- "description": "Search by ticker.",
+ "description": "Range by ticker.",
"in": "query",
"name": "ticker.lt",
"schema": {
@@ -27112,7 +26770,7 @@
"type": "string"
},
"greeks": {
- "description": "The greeks for this contract. This is only returned if your current plan includes greeks.",
+ "description": "The greeks for this contract. This is only returned if your current plan includes greeks. \nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this <a href=\"https://polygon.io/blog/greeks-and-implied-volatility/#testing\"\nalt=\"link\">article</a> for more information.",
"properties": {
"delta": {
"description": "The change in the option's price per $0.01 increment in the price of the underlying asset.",
@@ -27160,7 +26818,7 @@
"type": "number"
},
"ask_size": {
- "description": "The ask size.",
+ "description": "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.",
"format": "double",
"type": "number"
},
@@ -27170,12 +26828,12 @@
"type": "number"
},
"bid_size": {
- "description": "The bid size.",
+ "description": "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.",
"format": "double",
"type": "number"
},
"exchange": {
- "description": "Exchange of last quote",
+ "description": "The exchange ID. See <a href=\"https://polygon.io/docs/options/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs.",
"format": "int32",
"type": "integer"
},
@@ -27500,8 +27154,8 @@
"name": "snapshots"
},
"x-polygon-entitlement-market-type": {
- "description": "Stocks data",
- "name": "stocks"
+ "description": "All asset classes",
+ "name": "universal"
},
"x-polygon-paginate": {
"limit": {
@@ -27516,8 +27170,7 @@
]
}
}
- },
- "x-polygon-draft": true
+ }
},
"/v3/snapshot/indices": {
"get": {
@@ -27535,7 +27188,6 @@
},
{
"description": "Search a range of tickers lexicographically.",
- "example": "I:DJI",
"in": "query",
"name": "ticker",
"schema": {
@@ -27830,7 +27482,7 @@
"parameters": [
{
"description": "The underlying ticker symbol of the option contract.",
- "example": "AAPL",
+ "example": "EVRI",
"in": "path",
"name": "underlyingAsset",
"required": true,
@@ -28195,7 +27847,7 @@
}
},
"greeks": {
- "description": "The greeks for this contract. This is only returned if your current plan includes greeks.",
+ "description": "The greeks for this contract. This is only returned if your current plan includes greeks. \nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this <a href=\"https://polygon.io/blog/greeks-and-implied-volatility/#testing\"\nalt=\"link\">article</a> for more information.",
"properties": {
"delta": {
"description": "The change in the option's price per $0.01 increment in the price of the underlying asset.",
@@ -28480,7 +28132,7 @@
"parameters": [
{
"description": "The underlying ticker symbol of the option contract.",
- "example": "AAPL",
+ "example": "EVRI",
"in": "path",
"name": "underlyingAsset",
"required": true,
@@ -28490,7 +28142,7 @@
},
{
"description": "The option contract identifier.",
- "example": "O:AAPL230616C00150000",
+ "example": "O:EVRI240119C00002500",
"in": "path",
"name": "optionContract",
"required": true,
@@ -28714,7 +28366,7 @@
}
},
"greeks": {
- "description": "The greeks for this contract. This is only returned if your current plan includes greeks.",
+ "description": "The greeks for this contract. This is only returned if your current plan includes greeks. \nThere are certain circumstances where greeks will not be returned, such as options contracts that are deep in the money.\nSee this <a href=\"https://polygon.io/blog/greeks-and-implied-volatility/#testing\"\nalt=\"link\">article</a> for more information.",
"properties": {
"delta": {
"description": "The change in the option's price per $0.01 increment in the price of the underlying asset.",
@@ -29009,7 +28661,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -29017,7 +28669,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -29025,7 +28677,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -29033,7 +28685,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -29255,7 +28907,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -29263,7 +28915,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -29271,7 +28923,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -29279,7 +28931,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -29500,7 +29152,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gte",
"schema": {
@@ -29508,7 +29160,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.gt",
"schema": {
@@ -29516,7 +29168,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lte",
"schema": {
@@ -29524,7 +29176,7 @@
}
},
{
- "description": "Search by timestamp.",
+ "description": "Range by timestamp.",
"in": "query",
"name": "timestamp.lt",
"schema": {
@@ -30734,7 +30386,8 @@
"/v2/snapshot/locale/global/markets/crypto/tickers",
"/v2/snapshot/locale/global/markets/crypto/{direction}",
"/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}",
- "/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book"
+ "/v2/snapshot/locale/global/markets/crypto/tickers/{ticker}/book",
+ "/v3/snapshot"
]
},
{
@@ -30824,7 +30477,8 @@
"paths": [
"/v2/snapshot/locale/global/markets/forex/tickers",
"/v2/snapshot/locale/global/markets/forex/{direction}",
- "/v2/snapshot/locale/global/markets/forex/tickers/{ticker}"
+ "/v2/snapshot/locale/global/markets/forex/tickers/{ticker}",
+ "/v3/snapshot"
]
},
{
@@ -30895,7 +30549,8 @@
{
"group": "Snapshots",
"paths": [
- "/v3/snapshot/indices"
+ "/v3/snapshot/indices",
+ "/v3/snapshot"
]
}
],
@@ -30966,7 +30621,7 @@
"paths": [
"/v3/snapshot/options/{underlyingAsset}/{optionContract}",
"/v3/snapshot/options/{underlyingAsset}",
- "/v3/snapshot/options"
+ "/v3/snapshot"
]
},
{
@@ -31102,7 +30757,7 @@
"/v2/snapshot/locale/us/markets/stocks/tickers",
"/v2/snapshot/locale/us/markets/stocks/{direction}",
"/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}",
- "/v3/snapshot/stocks"
+ "/v3/snapshot"
]
},
{
justinpolygon
commented
1 year ago
A diff between this client library's spec and our hosted spec was found. The client may need an update to match any changes in our API. See the diff below: