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-python/master/.polygon/rest.json
+++ https://api.polygon.io/specs/rest.json
@@ -2207,363 +2207,6 @@
}
}
},
- "/v2/last/trade/{stocksTicker}": {
- "get": {
- "summary": "Last Trade",
- "description": "Get the most recent trade for a given stock.\n",
- "tags": [
- "stocks:last:trade"
- ],
- "parameters": [
- {
- "name": "stocksTicker",
- "in": "path",
- "description": "The ticker symbol of the stock/equity.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "AAPL"
- }
- ],
- "responses": {
- "200": {
- "description": "The last trade for this stock.",
- "content": {
- "application/json": {
- "schema": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "description": "The status of this request's response."
- },
- "request_id": {
- "type": "string",
- "description": "A request id assigned by the server."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "results": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "T": {
- "type": "string",
- "description": "The exchange symbol that this item is traded under."
- },
- "t": {
- "type": "integer",
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it."
- },
- "y": {
- "type": "integer",
- "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange."
- },
- "f": {
- "type": "integer",
- "description": "The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message."
- },
- "q": {
- "type": "integer",
- "format": "int64",
- "description": "The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n"
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "c": {
- "type": "array",
- "description": "A list of condition codes.\n",
- "items": {
- "type": "integer",
- "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n"
- }
- },
- "i": {
- "type": "string",
- "description": "The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n"
- },
- "p": {
- "type": "number",
- "format": "double",
- "description": "The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n"
- },
- "s": {
- "type": "number",
- "format": "double",
- "description": "The size of a trade (also known as volume).\n"
- },
- "e": {
- "type": "integer",
- "description": "The trade correction indicator.\n"
- },
- "x": {
- "type": "integer",
- "description": "The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs."
- },
- "r": {
- "type": "integer",
- "description": "The ID for the Trade Reporting Facility where the trade took place.\n"
- },
- "z": {
- "type": "integer",
- "description": "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.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "example": {
- "request_id": "f05562305bd26ced64b98ed68b3c5d96",
- "status": "OK",
- "results": {
- "T": "AAPL",
- "c": [
- 37
- ],
- "f": 1617901342969796400,
- "i": "118749",
- "p": 129.8473,
- "q": 3135876,
- "r": 202,
- "s": 25,
- "t": 1617901342969834000,
- "x": 4,
- "y": 1617901342968000000,
- "z": 3
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized - Check our API Key and account status"
- },
- "404": {
- "description": "The specified resource was not found"
- }
- },
- "x-polygon-entitlement-data-type": {
- "name": "trades",
- "description": "Trade data"
- },
- "x-polygon-entitlement-market-type": {
- "name": "stocks",
- "description": "Stocks data"
- },
- "x-polygon-entitlement-allowed-timeframes": [
- {
- "name": "realtime",
- "description": "Real Time Data"
- },
- {
- "name": "delayed",
- "description": "15 minute delayed data"
- }
- ]
- }
- },
- "/v2/last/nbbo/{stocksTicker}": {
- "get": {
- "summary": "Last Quote",
- "description": "Get the most recent NBBO (Quote) tick for a given stock.\n",
- "tags": [
- "stocks:last:quote"
- ],
- "parameters": [
- {
- "name": "stocksTicker",
- "in": "path",
- "description": "The ticker symbol of the stock/equity.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "AAPL"
- }
- ],
- "responses": {
- "200": {
- "description": "The last NBBO tick for this stock.",
- "content": {
- "application/json": {
- "schema": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "description": "The status of this request's response."
- },
- "request_id": {
- "type": "string",
- "description": "A request id assigned by the server."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "results": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "T": {
- "type": "string",
- "description": "The exchange symbol that this item is traded under."
- },
- "t": {
- "type": "integer",
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it."
- },
- "y": {
- "type": "integer",
- "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange."
- },
- "f": {
- "type": "integer",
- "description": "The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message."
- },
- "q": {
- "type": "integer",
- "format": "int64",
- "description": "The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n"
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "c": {
- "type": "array",
- "description": "A list of condition codes.\n",
- "items": {
- "type": "integer",
- "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n"
- }
- },
- "i": {
- "type": "array",
- "description": "The indicators. For more information, see our glossary of [Conditions and\nIndicators](https://polygon.io/glossary/us/stocks/conditions-indicators).\n",
- "items": {
- "type": "integer",
- "description": "The indicator code.\n"
- }
- },
- "p": {
- "type": "number",
- "format": "double",
- "description": "The bid price."
- },
- "s": {
- "type": "integer",
- "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."
- },
- "x": {
- "allOf": [
- {
- "type": "integer",
- "description": "The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs."
- },
- {
- "description": "Bid Exchange Id"
- }
- ]
- },
- "P": {
- "type": "number",
- "format": "double",
- "description": "The ask price."
- },
- "S": {
- "type": "integer",
- "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."
- },
- "X": {
- "allOf": [
- {
- "type": "integer",
- "description": "The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs."
- },
- {
- "description": "Ask Exchange Id"
- }
- ]
- },
- "z": {
- "type": "integer",
- "description": "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.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "example": {
- "request_id": "b84e24636301f19f88e0dfbf9a45ed5c",
- "status": "OK",
- "results": {
- "P": 127.98,
- "S": 7,
- "T": "AAPL",
- "X": 19,
- "p": 127.96,
- "q": 83480742,
- "s": 1,
- "t": 1617827221349730300,
- "x": 11,
- "y": 1617827221349366000,
- "z": 3
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized - Check our API Key and account status"
- },
- "404": {
- "description": "The specified resource was not found"
- }
- },
- "x-polygon-entitlement-data-type": {
- "name": "nbbo",
- "description": "NBBO data"
- },
- "x-polygon-entitlement-market-type": {
- "name": "stocks",
- "description": "Stocks data"
- },
- "x-polygon-entitlement-allowed-timeframes": [
- {
- "name": "realtime",
- "description": "Real Time Data"
- },
- {
- "name": "delayed",
- "description": "15 minute delayed data"
- }
- ]
- }
- },
"/v1/open-close/{stocksTicker}/{date}": {
"get": {
"summary": "Daily Open/Close",
@@ -3291,7 +2934,7 @@
"/v2/snapshot/locale/us/markets/stocks/tickers": {
"get": {
"summary": "All Tickers",
- "description": "Get the most up-to-date market data for all traded stock 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",
+ "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",
"tags": [
"stocks:snapshot"
],
@@ -3641,7 +3284,7 @@
"/v2/snapshot/locale/us/markets/stocks/tickers/{stocksTicker}": {
"get": {
"summary": "Ticker",
- "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 12am EST and gets populated as data is received from the exchanges. This can happen as early as 4am EST.\n",
+ "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",
"tags": [
"stocks:snapshot"
],
@@ -3981,7 +3624,7 @@
"/v2/snapshot/locale/us/markets/stocks/{direction}": {
"get": {
"summary": "Gainers/Losers",
- "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 12am EST and gets populated as data is received from the exchanges.\n",
+ "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",
"tags": [
"stocks:snapshot"
],
@@ -4325,173 +3968,6 @@
]
}
},
- "/v2/last/trade/{optionsTicker}": {
- "get": {
- "summary": "Last Trade",
- "description": "Get the most recent trade for a given options contract.\n",
- "tags": [
- "options:last:trade"
- ],
- "parameters": [
- {
- "name": "optionsTicker",
- "in": "path",
- "description": "The ticker symbol of the options contract.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "O:TSLA210903C00700000"
- }
- ],
- "responses": {
- "200": {
- "description": "The last trade for this options contract.",
- "content": {
- "application/json": {
- "schema": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "description": "The status of this request's response."
- },
- "request_id": {
- "type": "string",
- "description": "A request id assigned by the server."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "results": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "T": {
- "type": "string",
- "description": "The exchange symbol that this item is traded under."
- },
- "t": {
- "type": "integer",
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it."
- },
- "y": {
- "type": "integer",
- "description": "The nanosecond accuracy Participant/Exchange Unix Timestamp. This is the timestamp of when the quote was actually generated at the exchange."
- },
- "f": {
- "type": "integer",
- "description": "The nanosecond accuracy TRF(Trade Reporting Facility) Unix Timestamp. This is the timestamp of when the trade reporting facility received this message."
- },
- "q": {
- "type": "integer",
- "format": "int64",
- "description": "The sequence number represents the sequence in which message events happened.\nThese are increasing and unique per ticker symbol, but will not always be\nsequential (e.g., 1, 2, 6, 9, 10, 11).\n"
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "c": {
- "type": "array",
- "description": "A list of condition codes.\n",
- "items": {
- "type": "integer",
- "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n"
- }
- },
- "i": {
- "type": "string",
- "description": "The Trade ID which uniquely identifies a trade. These are unique per\ncombination of ticker, exchange, and TRF. For example: A trade for AAPL\nexecuted on NYSE and a trade for AAPL executed on NASDAQ could potentially\nhave the same Trade ID.\n"
- },
- "p": {
- "type": "number",
- "format": "double",
- "description": "The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n"
- },
- "s": {
- "type": "number",
- "format": "double",
- "description": "The size of a trade (also known as volume).\n"
- },
- "e": {
- "type": "integer",
- "description": "The trade correction indicator.\n"
- },
- "x": {
- "type": "integer",
- "description": "The exchange ID. See <a href=\"https://polygon.io/docs/stocks/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs."
- },
- "r": {
- "type": "integer",
- "description": "The ID for the Trade Reporting Facility where the trade took place.\n"
- },
- "z": {
- "type": "integer",
- "description": "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.\n* Tape A is NYSE listed securities\n* Tape B is NYSE ARCA / NYSE American\n* Tape C is NASDAQ\n"
- }
- }
- }
- ]
- }
- }
- }
- ]
- },
- "example": {
- "request_id": "f05562305bd26ced64b98ed68b3c5d96",
- "status": "OK",
- "results": {
- "T": "O:TSLA210903C00700000",
- "c": [
- 227
- ],
- "f": 1617901342969796400,
- "i": "",
- "p": 115.55,
- "q": 1325541950,
- "r": 202,
- "s": 25,
- "t": 1617901342969834000,
- "x": 312
- }
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized - Check our API Key and account status"
- },
- "404": {
- "description": "The specified resource was not found"
- }
- },
- "x-polygon-entitlement-data-type": {
- "name": "trades",
- "description": "Trade data"
- },
- "x-polygon-entitlement-market-type": {
- "name": "options",
- "description": "Options data"
- },
- "x-polygon-entitlement-allowed-timeframes": [
- {
- "name": "realtime",
- "description": "Real Time Data"
- },
- {
- "name": "delayed",
- "description": "15 minute delayed data"
- }
- ]
- }
- },
"/v1/open-close/{optionsTicker}/{date}": {
"get": {
"summary": "Daily Open/Close",
@@ -5206,272 +4682,6 @@
}
}
},
- "/v1/conversion/{from}/{to}": {
- "get": {
- "summary": "Real-time Currency Conversion",
- "description": "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.\n",
- "tags": [
- "fx:conversion"
- ],
- "parameters": [
- {
- "name": "from",
- "in": "path",
- "description": "The \"from\" symbol of the pair.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "AUD"
- },
- {
- "name": "to",
- "in": "path",
- "description": "The \"to\" symbol of the pair.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "USD"
- },
- {
- "name": "amount",
- "in": "query",
- "description": "The amount to convert, with a decimal.",
- "required": false,
- "schema": {
- "type": "integer"
- },
- "example": 100
- },
- {
- "name": "precision",
- "in": "query",
- "description": "The decimal precision of the conversion. Defaults to 2 which is 2 decimal places accuracy.",
- "required": false,
- "schema": {
- "type": "integer",
- "enum": [
- 0,
- 1,
- 2,
- 3,
- 4
- ]
- },
- "example": 2
- }
- ],
- "responses": {
- "200": {
- "description": "The last tick for this currency pair, plus the converted amount for the requested amount.",
- "content": {
- "application/json": {
- "schema": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "description": "The status of this request's response."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "last": {
- "type": "object",
- "properties": {
- "ask": {
- "type": "number",
- "format": "double",
- "description": "The ask price."
- },
- "bid": {
- "type": "number",
- "format": "double",
- "description": "The bid price."
- },
- "exchange": {
- "type": "integer",
- "description": "The exchange ID. See <a href=\"https://polygon.io/docs/forex/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs."
- },
- "timestamp": {
- "type": "integer",
- "description": "The Unix Msec timestamp for the start of the aggregate window."
- }
- }
- },
- "from": {
- "type": "string",
- "description": "The \"from\" currency symbol."
- },
- "to": {
- "type": "string",
- "description": "The \"to\" currency symbol."
- },
- "initialAmount": {
- "type": "number",
- "format": "double",
- "description": "The amount to convert."
- },
- "converted": {
- "type": "number",
- "format": "double",
- "description": "The result of the conversion."
- }
- }
- }
- ]
- },
- "example": {
- "status": "success",
- "last": {
- "bid": 1.3672596,
- "ask": 1.3673344,
- "exchange": 48,
- "timestamp": 1605555313000
- },
- "from": "AUD",
- "to": "USD",
- "initialAmount": 100,
- "converted": 73.14
- }
- }
- }
- },
- "default": {
- "description": "Unexpected error"
- }
- },
- "x-polygon-entitlement-data-type": {
- "name": "nbbo",
- "description": "NBBO data"
- },
- "x-polygon-entitlement-market-type": {
- "name": "fx",
- "description": "Forex data"
- }
- }
- },
- "/v1/last_quote/currencies/{from}/{to}": {
- "get": {
- "summary": "Last Quote for a Currency Pair",
- "description": "Get the last quote tick for a forex currency pair.\n",
- "tags": [
- "fx:last:quote"
- ],
- "parameters": [
- {
- "name": "from",
- "in": "path",
- "description": "The \"from\" symbol of the pair.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "AUD"
- },
- {
- "name": "to",
- "in": "path",
- "description": "The \"to\" symbol of the pair.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "USD"
- }
- ],
- "responses": {
- "200": {
- "description": "The last quote tick for this currency pair.",
- "content": {
- "application/json": {
- "schema": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "description": "The status of this request's response."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "request_id": {
- "type": "string",
- "description": "A request id assigned by the server."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "last": {
- "type": "object",
- "properties": {
- "ask": {
- "type": "number",
- "format": "double",
- "description": "The ask price."
- },
- "bid": {
- "type": "number",
- "format": "double",
- "description": "The bid price."
- },
- "exchange": {
- "type": "integer",
- "description": "The exchange ID. See <a href=\"https://polygon.io/docs/forex/get_v3_reference_exchanges\" alt=\"Exchanges\">Exchanges</a> for Polygon.io's mapping of exchange IDs."
- },
- "timestamp": {
- "type": "integer",
- "description": "The Unix Msec timestamp for the start of the aggregate window."
- }
- }
- },
- "symbol": {
- "type": "string",
- "description": "The symbol pair that was evaluated from the request."
- }
- }
- }
- ]
- },
- "example": {
- "last": {
- "ask": 0.73124,
- "bid": 0.73122,
- "exchange": 48,
- "timestamp": 1605557756000
- },
- "request_id": "a73a29dbcab4613eeaf48583d3baacf0",
- "status": "success",
- "symbol": "AUD/USD"
- }
- }
- }
- },
- "default": {
- "description": "Unexpected error"
- }
- },
- "x-polygon-entitlement-data-type": {
- "name": "nbbo",
- "description": "NBBO data"
- },
- "x-polygon-entitlement-market-type": {
- "name": "fx",
- "description": "Forex data"
- }
- }
- },
"/v2/aggs/grouped/locale/global/market/fx/{date}": {
"get": {
"summary": "Grouped Daily (Bars)",
@@ -6823,133 +6033,6 @@
]
}
},
- "/v1/last/crypto/{from}/{to}": {
- "get": {
- "summary": "Last Trade for a Crypto Pair",
- "description": "Get the last trade tick for a cryptocurrency pair.\n",
- "tags": [
- "crypto:last:trade"
- ],
- "parameters": [
- {
- "name": "from",
- "in": "path",
- "description": "The \"from\" symbol of the pair.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "BTC"
- },
- {
- "name": "to",
- "in": "path",
- "description": "The \"to\" symbol of the pair.",
- "required": true,
- "schema": {
- "type": "string"
- },
- "example": "USD"
- }
- ],
- "responses": {
- "200": {
- "description": "The last tick for this currency pair.",
- "content": {
- "application/json": {
- "schema": {
- "allOf": [
- {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "description": "The status of this request's response."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "request_id": {
- "type": "string",
- "description": "A request id assigned by the server."
- }
- }
- },
- {
- "type": "object",
- "properties": {
- "last": {
- "type": "object",
- "properties": {
- "conditions": {
- "type": "array",
- "description": "A list of condition codes.\n",
- "items": {
- "type": "integer",
- "description": "The condition code. These are the conditions of this message. See\n[Condition Mappings](https://polygon.io/docs/get_v3_reference_conditions)\nfor a mapping to exchange conditions.\n"
- }
- },
- "exchange": {
- "type": "integer",
- "description": "The exchange that this crypto trade happened on. \nSee <a href=\"https://polygon.io/docs/crypto/get_v3_reference_exchanges\">Exchanges</a> for a mapping of exchanges to IDs.\n"
- },
- "price": {
- "type": "number",
- "format": "double",
- "description": "The price of the trade. This is the actual dollar value per whole share of\nthis trade. A trade of 100 shares with a price of $2.00 would be worth a\ntotal dollar value of $200.00.\n"
- },
- "size": {
- "type": "number",
- "format": "double",
- "description": "The size of a trade (also known as volume).\n"
- },
- "timestamp": {
- "type": "integer",
- "description": "The Unix Msec timestamp for the start of the aggregate window."
- }
- }
- },
- "symbol": {
- "type": "string",
- "description": "The symbol pair that was evaluated from the request."
- }
- }
- }
- ]
- },
- "example": {
- "last": {
- "conditions": [
- 1
- ],
- "exchange": 4,
- "price": 16835.42,
- "size": 0.006909,
- "timestamp": 1605560885027
- },
- "request_id": "d2d779df015fe2b7fbb8e58366610ef7",
- "status": "success",
- "symbol": "BTC-USD"
- }
- }
- }
- },
- "default": {
- "description": "Unexpected error"
- }
- },
- "x-polygon-entitlement-data-type": {
- "name": "trades",
- "description": "Trade data"
- },
- "x-polygon-entitlement-market-type": {
- "name": "crypto",
- "description": "Crypto data"
- }
- }
- },
"/v1/open-close/crypto/{from}/{to}/{date}": {
"get": {
"summary": "Daily Open/Close",
morningvera
commented
2 years 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: