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-go/master/.polygon/rest.json
+++ https://api.polygon.io/openapi
@@ -27013,7 +27013,7 @@
}
},
"last_trade": {
- "description": "The most recent quote for this contract. This is only returned if your current plan includes quotes.",
+ "description": "The most recent quote for this contract. This is only returned if your current plan includes trades.",
"properties": {
"conditions": {
"description": "A list of condition codes.",
@@ -27195,7 +27195,8 @@
"stocks",
"options",
"fx",
- "crypto"
+ "crypto",
+ "indices"
],
"type": "string"
},
@@ -30282,6 +30283,233 @@
}
}
},
+ "/vX/reference/tickers/taxonomies": {
+ "get": {
+ "description": "Retrieve taxonomy classifications for one or more tickers.",
+ "operationId": "ListTickerTaxonomyClassifications",
+ "parameters": [
+ {
+ "in": "query",
+ "name": "ticker",
+ "schema": {
+ "type": "string"
+ },
+ "x-polygon-filter-field": {
+ "anyOf": {
+ "description": "Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.\n",
+ "enabled": true,
+ "example": "NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD,I:SPX"
+ },
+ "range": true,
+ "type": "string"
+ }
+ },
+ {
+ "description": "Filter by taxonomy category.",
+ "in": "query",
+ "name": "category",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Filter by taxonomy tag. Each category has a set of associated tags.",
+ "in": "query",
+ "name": "tag",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Range by ticker.",
+ "in": "query",
+ "name": "ticker.gte",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Range by ticker.",
+ "in": "query",
+ "name": "ticker.gt",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Range by ticker.",
+ "in": "query",
+ "name": "ticker.lte",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Range by ticker.",
+ "in": "query",
+ "name": "ticker.lt",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Comma separated list of tickers, up to a maximum of 250. If no tickers are passed then all results will be returned in a paginated manner.\n\nWarning: The maximum number of characters allowed in a URL are subject to your technology stack.\n",
+ "example": "NCLH,O:SPY250321C00380000,C:EURUSD,X:BTCUSD,I:SPX",
+ "in": "query",
+ "name": "ticker.any_of",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Order results based on the `sort` field.",
+ "in": "query",
+ "name": "order",
+ "schema": {
+ "enum": [
+ "asc",
+ "desc"
+ ],
+ "example": "asc",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Limit the number of results returned, default is 10 and max is 250.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 10,
+ "example": 10,
+ "maximum": 250,
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "Sort field used for ordering.",
+ "in": "query",
+ "name": "sort",
+ "schema": {
+ "default": "ticker",
+ "enum": [
+ "ticker"
+ ],
+ "example": "ticker",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "example": {
+ "request_id": "31d59dda-80e5-4721-8496-d0d32a654afe",
+ "results": [
+ {
+ "category": "revenue_streams",
+ "reason": "Company recognizes revenue from the sales of consumer electronics such as the iPhone and iPad.",
+ "relevance": 0.99,
+ "tag": "physical_product_sales_electronics",
+ "ticker": "AAPL"
+ },
+ {
+ "category": "revenue_streams",
+ "reason": "Company recognizes revenue from the sales of digital products such as digital storage and app store fees.",
+ "relevance": 0.99,
+ "tag": "digital_product_sales_software",
+ "ticker": "AAPL"
+ },
+ {
+ "category": "cost_structure",
+ "relevance": 0.86,
+ "tag": "economies_of_scale",
+ "ticker": "AAPL"
+ }
+ ]
+ },
+ "schema": {
+ "properties": {
+ "next_url": {
+ "description": "If present, this value can be used to fetch the next page of data.",
+ "type": "string"
+ },
+ "request_id": {
+ "type": "string"
+ },
+ "results": {
+ "items": {
+ "properties": {
+ "category": {
+ "description": "The classification category.",
+ "type": "string"
+ },
+ "reason": {
+ "description": "The reason why the classification was given.",
+ "type": "string"
+ },
+ "relevance": {
+ "description": "The relevance score for the tag. This is a measure of confidence in the tag classification.",
+ "format": "double",
+ "type": "number"
+ },
+ "tag": {
+ "description": "The classification tag. Each category has a set of associated tags.",
+ "type": "string"
+ },
+ "ticker": {
+ "description": "The ticker symbol for the asset.",
+ "type": "string"
+ }
+ },
+ "x-polygon-go-type": {
+ "name": "TaxonomyClassificationResult"
+ }
+ },
+ "type": "array"
+ },
+ "status": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "request_id"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "description": "Taxonomy classification data."
+ }
+ },
+ "summary": "Ticker Taxonomies",
+ "tags": [
+ "Internal",
+ "Public"
+ ],
+ "x-polygon-entitlement-data-type": {
+ "description": "Reference data",
+ "name": "reference"
+ },
+ "x-polygon-experimental": {},
+ "x-polygon-paginate": {
+ "limit": {
+ "default": 10,
+ "max": 250,
+ "min": 1
+ },
+ "sort": {
+ "default": "ticker",
+ "enum": [
+ "ticker"
+ ]
+ }
+ }
+ },
+ "x-polygon-draft": true
+ },
"/vX/reference/tickers/{id}/events": {
"get": {
"description": "Get a timeline of events for the entity associated with the given ticker, CUSIP, or Composite FIGI.",
justinpolygon
commented
9 months 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: