Skip to content

Commit c9d1335

Browse files
justinpolygonjustinpolygon
authored
Update rest and ws spec (#149)
1 parent dd191e8 commit c9d1335

File tree

2 files changed

+520
-13
lines changed

2 files changed

+520
-13
lines changed

‎.polygon/rest.json

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@
220220
}
221221
},
222222
"StocksTickerPathParam": {
223-
"description": "The ticker symbol of the stock/equity.",
223+
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
224224
"example": "AAPL",
225225
"in": "path",
226226
"name": "stocksTicker",
@@ -230,7 +230,7 @@
230230
}
231231
},
232232
"TickersQueryParam": {
233-
"description": "A comma separated list of tickers to get snapshots for.",
233+
"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.",
234234
"in": "query",
235235
"name": "tickers",
236236
"schema": {
@@ -3602,7 +3602,7 @@
36023602
"type": "boolean"
36033603
},
36043604
"t": {
3605-
"description": "The Unix Msec timestamp for the start of the aggregate window.",
3605+
"description": "The Unix Msec timestamp for the end of the aggregate window.",
36063606
"type": "integer"
36073607
},
36083608
"v": {
@@ -13387,7 +13387,7 @@
1338713387
"description": "Get the open, close and afterhours prices of a stock symbol on a certain date.\n",
1338813388
"parameters": [
1338913389
{
13390-
"description": "The ticker symbol of the stock/equity.",
13390+
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
1339113391
"example": "AAPL",
1339213392
"in": "path",
1339313393
"name": "stocksTicker",
@@ -15387,7 +15387,7 @@
1538715387
"type": "boolean"
1538815388
},
1538915389
"t": {
15390-
"description": "The Unix Msec timestamp for the start of the aggregate window.",
15390+
"description": "The Unix Msec timestamp for the end of the aggregate window.",
1539115391
"type": "integer"
1539215392
},
1539315393
"v": {
@@ -17177,7 +17177,7 @@
1717717177
"description": "Get the previous day's open, high, low, and close (OHLC) for the specified stock ticker.\n",
1717817178
"parameters": [
1717917179
{
17180-
"description": "The ticker symbol of the stock/equity.",
17180+
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
1718117181
"example": "AAPL",
1718217182
"in": "path",
1718317183
"name": "stocksTicker",
@@ -17360,7 +17360,7 @@
1736017360
"description": "Get aggregate bars for a stock over a given date range in custom time window sizes.\n<br />\n<br />\nFor example, if timespan = \u2018minute\u2019 and multiplier = \u20185\u2019 then 5-minute bars will be returned.\n",
1736117361
"parameters": [
1736217362
{
17363-
"description": "The ticker symbol of the stock/equity.",
17363+
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
1736417364
"example": "AAPL",
1736517365
"in": "path",
1736617366
"name": "stocksTicker",
@@ -18579,7 +18579,7 @@
1857918579
"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",
1858018580
"parameters": [
1858118581
{
18582-
"description": "A comma separated list of tickers to get snapshots for.",
18582+
"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.",
1858318583
"in": "query",
1858418584
"name": "tickers",
1858518585
"schema": {
@@ -19840,7 +19840,7 @@
1984019840
"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",
1984119841
"parameters": [
1984219842
{
19843-
"description": "A comma separated list of tickers to get snapshots for.",
19843+
"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.",
1984419844
"in": "query",
1984519845
"name": "tickers",
1984619846
"schema": {
@@ -20789,7 +20789,7 @@
2078920789
"description": "Get the most up-to-date market data for all traded stock symbols.\n<br />\n<br />\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n",
2079020790
"parameters": [
2079120791
{
20792-
"description": "A comma separated list of tickers to get snapshots for.",
20792+
"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.",
2079320793
"in": "query",
2079420794
"name": "tickers",
2079520795
"schema": {
@@ -21204,7 +21204,7 @@
2120421204
"description": "Get the most up-to-date market data for a single traded stock ticker.\n<br />\n<br />\nNote: Snapshot data is cleared at 3:30am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n",
2120521205
"parameters": [
2120621206
{
21207-
"description": "The ticker symbol of the stock/equity.",
21207+
"description": "Specify a case-sensitive ticker symbol. For example, AAPL represents Apple Inc.",
2120821208
"example": "AAPL",
2120921209
"in": "path",
2121021210
"name": "stocksTicker",

0 commit comments

Comments
 (0)