Skip to content

Commit e5ab49d

Browse files
Update ws and rest spec with latest updates (#667)
1 parent 563300e commit e5ab49d

File tree

2 files changed

+39
-11
lines changed

2 files changed

+39
-11
lines changed

.polygon/rest.json

Lines changed: 31 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,17 @@
101101
"type": "string"
102102
}
103103
},
104+
"CryptoTickersQueryParam": {
105+
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers.",
106+
"in": "query",
107+
"name": "tickers",
108+
"schema": {
109+
"items": {
110+
"type": "string"
111+
},
112+
"type": "array"
113+
}
114+
},
104115
"ForexTickerPathParam": {
105116
"description": "The ticker symbol of the currency pair.",
106117
"example": "C:EURUSD",
@@ -111,6 +122,17 @@
111122
"type": "string"
112123
}
113124
},
125+
"ForexTickersQueryParam": {
126+
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers.",
127+
"in": "query",
128+
"name": "tickers",
129+
"schema": {
130+
"items": {
131+
"type": "string"
132+
},
133+
"type": "array"
134+
}
135+
},
114136
"GeneralTickerPathParam": {
115137
"description": "The ticker symbol of the asset.",
116138
"example": "AAPL",
@@ -6039,7 +6061,7 @@
60396061
},
60406062
"summary": "Exponential Moving Average (EMA)",
60416063
"tags": [
6042-
"crpyto:aggregates"
6064+
"crypto:aggregates"
60436065
],
60446066
"x-polygon-entitlement-data-type": {
60456067
"description": "Aggregate data",
@@ -9407,7 +9429,7 @@
94079429
},
94089430
"summary": "Relative Strength Index (RSI)",
94099431
"tags": [
9410-
"crpyto:aggregates"
9432+
"crypto:aggregates"
94119433
],
94129434
"x-polygon-entitlement-data-type": {
94139435
"description": "Aggregate data",
@@ -11003,7 +11025,7 @@
1100311025
},
1100411026
"summary": "Simple Moving Average (SMA)",
1100511027
"tags": [
11006-
"crpyto:aggregates"
11028+
"crypto:aggregates"
1100711029
],
1100811030
"x-polygon-entitlement-data-type": {
1100911031
"description": "Aggregate data",
@@ -18577,7 +18599,7 @@
1857718599
"description": "Get the current minute, day, and previous day\u2019s aggregate, as well as the last trade and quote for all traded cryptocurrency symbols.\n<br />\n<br />\nNote: 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.\n",
1857818600
"parameters": [
1857918601
{
18580-
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers.",
18602+
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, X:BTCUSD, X:ETHBTC, and X:BOBAUSD. Empty string defaults to querying all tickers.",
1858118603
"in": "query",
1858218604
"name": "tickers",
1858318605
"schema": {
@@ -19461,6 +19483,9 @@
1946119483
"tags": [
1946219484
"crypto:snapshot"
1946319485
],
19486+
"x-polygon-deprecation": {
19487+
"date": 1719838800000
19488+
},
1946419489
"x-polygon-entitlement-allowed-timeframes": [
1946519490
{
1946619491
"description": "Real Time Data",
@@ -19838,7 +19863,7 @@
1983819863
"description": "Get the current minute, day, and previous day\u2019s aggregate, as well as the last trade and quote for all traded forex symbols.\n<br />\n<br />\nNote: 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.\n",
1983919864
"parameters": [
1984019865
{
19841-
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, AAPL,TSLA,GOOG. Empty string defaults to querying all tickers.",
19866+
"description": "A case-sensitive comma separated list of tickers to get snapshots for. For example, C:EURUSD, C:GBPCAD, and C:AUDINR. Empty string defaults to querying all tickers.",
1984219867
"in": "query",
1984319868
"name": "tickers",
1984419869
"schema": {
@@ -21608,7 +21633,7 @@
2160821633
},
2160921634
"/v2/snapshot/locale/us/markets/stocks/{direction}": {
2161021635
"get": {
21611-
"description": "Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.\n<br />\n<br />\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\n<br />\n<br />\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges.\n",
21636+
"description": "Get the most up-to-date market data for the current top 20 gainers or losers of the day in the stocks/equities markets.\n<br />\n<br />\nTop gainers are those tickers whose price has increased by the highest percentage since the previous day's close.\nTop losers are those tickers whose price has decreased by the highest percentage since the previous day's close.\nThis output will only include tickers with a trading volume of 10,000 or more.\n<br />\n<br />\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges.\n",
2161221637
"parameters": [
2161321638
{
2161421639
"description": "The direction of the snapshot results to return.\n",

.polygon/websocket.json

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -995,7 +995,7 @@
995995
},
996996
"example": {
997997
"ev": "FMV",
998-
"val": 189.22,
998+
"fmv": 189.22,
999999
"sym": "AAPL",
10001000
"t": 1678220098130
10011001
}
@@ -1761,7 +1761,7 @@
17611761
},
17621762
"example": {
17631763
"ev": "FMV",
1764-
"val": 7.2,
1764+
"fmv": 7.2,
17651765
"sym": "O:TSLA210903C00700000",
17661766
"t": 1401715883806000000
17671767
}
@@ -2331,7 +2331,7 @@
23312331
},
23322332
"example": {
23332333
"ev": "FMV",
2334-
"val": 1.0631,
2334+
"fmv": 1.0631,
23352335
"sym": "C:EURUSD",
23362336
"t": 1678220098130
23372337
}
@@ -2885,7 +2885,10 @@
28852885
"name": "realtime",
28862886
"description": "Real Time Data"
28872887
}
2888-
]
2888+
],
2889+
"x-polygon-deprecation": {
2890+
"date": 1719838800000
2891+
}
28892892
}
28902893
},
28912894
"/crypto/XA": {
@@ -3157,7 +3160,7 @@
31573160
},
31583161
"example": {
31593162
"ev": "FMV",
3160-
"val": 33021.9,
3163+
"fmv": 33021.9,
31613164
"sym": "X:BTC-USD",
31623165
"t": 1610462007425
31633166
}

0 commit comments

Comments
 (0)