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
@@ -875,7 +875,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -890,14 +890,14 @@
},
"s": {
"description": "The size (volume) of the trade.",
- "type": "integer"
+ "type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.",
"type": "integer"
},
"x": {
- "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": "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",
"type": "integer"
}
},
@@ -910,14 +905,6 @@
"x"
],
"type": "object"
- },
- {
- "properties": {
- "x": {
- "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",
- "type": "integer"
- }
- }
}
]
},
@@ -1186,7 +1173,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -1201,14 +1188,14 @@
},
"s": {
"description": "The size (volume) of the trade.",
- "type": "integer"
+ "type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.",
"type": "integer"
},
"x": {
- "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": "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",
"type": "integer"
}
},
@@ -1221,14 +1203,6 @@
"x"
],
"type": "object"
- },
- {
- "properties": {
- "x": {
- "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",
- "type": "integer"
- }
- }
}
]
},
@@ -2242,7 +2216,7 @@
"type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp of the quote.",
"type": "integer"
},
"x": {
@@ -2357,7 +2331,7 @@
"type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp of the quote.",
"type": "integer"
},
"x": {
@@ -2546,7 +2520,7 @@
"type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp of the quote.",
"type": "integer"
},
"x": {
@@ -3064,47 +3038,6 @@
"format": "double",
"type": "number"
},
- "SnapshotLastTrade": {
- "properties": {
- "c": {
- "description": "The trade conditions.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
- "i": {
- "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",
- "type": "string"
- },
- "p": {
- "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",
- "format": "double",
- "type": "number"
- },
- "s": {
- "description": "The size (volume) of the trade.",
- "type": "integer"
- },
- "t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
- "type": "integer"
- },
- "x": {
- "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.",
- "type": "integer"
- }
- },
- "required": [
- "c",
- "i",
- "p",
- "s",
- "t",
- "x"
- ],
- "type": "object"
- },
"SnapshotOHLCV": {
"properties": {
"c": {
@@ -3661,7 +3594,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -3916,7 +3849,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -16454,7 +16387,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -16469,14 +16402,14 @@
},
"s": {
"description": "The size (volume) of the trade.",
- "type": "integer"
+ "type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.",
"type": "integer"
},
"x": {
- "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": "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",
"type": "integer"
}
},
@@ -16489,14 +16417,6 @@
"x"
],
"type": "object"
- },
- {
- "properties": {
- "x": {
- "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",
- "type": "integer"
- }
- }
}
]
},
@@ -16811,7 +16731,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -16826,14 +16746,14 @@
},
"s": {
"description": "The size (volume) of the trade.",
- "type": "integer"
+ "type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.",
"type": "integer"
},
"x": {
- "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": "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",
"type": "integer"
}
},
@@ -16846,14 +16761,6 @@
"x"
],
"type": "object"
- },
- {
- "properties": {
- "x": {
- "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",
- "type": "integer"
- }
- }
}
]
},
@@ -17340,7 +17247,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -17355,14 +17262,14 @@
},
"s": {
"description": "The size (volume) of the trade.",
- "type": "integer"
+ "type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp. This is the timestamp of when the trade was generated at the exchange.",
"type": "integer"
},
"x": {
- "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": "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",
"type": "integer"
}
},
@@ -17375,14 +17277,6 @@
"x"
],
"type": "object"
- },
- {
- "properties": {
- "x": {
- "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",
- "type": "integer"
- }
- }
}
]
},
@@ -17680,7 +17574,7 @@
"type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp of the quote.",
"type": "integer"
},
"x": {
@@ -17994,7 +17888,7 @@
"type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp of the quote.",
"type": "integer"
},
"x": {
@@ -18299,7 +18193,7 @@
"type": "number"
},
"t": {
- "description": "The nanosecond accuracy SIP Unix Timestamp. This is the timestamp of when the SIP received this message from the exchange which produced it.",
+ "description": "The millisecond accuracy timestamp of the quote.",
"type": "integer"
},
"x": {
@@ -18670,7 +18564,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -19064,7 +18958,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -19457,7 +19351,7 @@
"c": {
"description": "The trade conditions.",
"items": {
- "type": "string"
+ "type": "integer"
},
"type": "array"
},
@@ -22365,6 +22259,7 @@
"in": "query",
"name": "skip_overlay_trigger",
"schema": {
+ "default": false,
"type": "boolean"
}
}
@@ -23801,7 +23696,8 @@
"stocks",
"crypto",
"fx",
- "otc"
+ "otc",
+ "indices"
],
"type": "string"
}
@@ -24025,7 +23921,8 @@
"stocks",
"crypto",
"fx",
- "otc"
+ "otc",
+ "indices"
],
"type": "string"
},
@@ -24136,7 +24033,8 @@
"stocks",
"options",
"crypto",
- "fx"
+ "fx",
+ "indices"
],
"example": "stocks",
"type": "string"
@@ -24183,7 +24081,8 @@
"stocks",
"options",
"crypto",
- "fx"
+ "fx",
+ "indices"
],
"example": "stocks",
"type": "string"
@@ -24474,7 +24373,8 @@
"stocks",
"crypto",
"fx",
- "otc"
+ "otc",
+ "indices"
],
"type": "string"
},
@@ -24583,6 +24483,191 @@
}
}
},
+ "/v3/snapshot/indices": {
+ "get": {
+ "description": "Get a Snapshot of indices data for said tickers",
+ "operationId": "IndicesSnapshot",
+ "parameters": [
+ {
+ "description": "Comma separated list of tickers",
+ "example": "I:SPX",
+ "in": "query",
+ "name": "ticker.any_of",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "example": {
+ "request_id": "6a7e466379af0a71039d60cc78e72282",
+ "results": [
+ {
+ "market_status": "closed",
+ "name": "S&P 500",
+ "session": {
+ "change": -50.01,
+ "change_percent": -1.45,
+ "close": 3822.39,
+ "high": 3834.41,
+ "low": 38217.11,
+ "open": 3827.38,
+ "previous_close": 3812.19
+ },
+ "ticker": "I:SPX",
+ "type": "indices",
+ "value": 3822.39
+ },
+ {
+ "error": "NOT_FOUND",
+ "message": "Ticker not found.",
+ "ticker": "APx"
+ },
+ {
+ "error": "NOT_ENTITLED",
+ "message": "Not entitled to this ticker.",
+ "ticker": "APy"
+ }
+ ],
+ "status": "OK"
+ },
+ "schema": {
+ "properties": {
+ "request_id": {
+ "type": "string"
+ },
+ "results": {
+ "items": {
+ "properties": {
+ "error": {
+ "description": "The error while looking for this ticker.",
+ "type": "string"
+ },
+ "market_status": {
+ "description": "The market status for the market that trades this ticker.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The error message while looking for this ticker.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of Index.",
+ "type": "string"
+ },
+ "session": {
+ "properties": {
+ "change": {
+ "description": "The value of the change for the index from the previous trading day.",
+ "format": "double",
+ "type": "number"
+ },
+ "change_percent": {
+ "description": "The percent of the change for the index from the previous trading day.",
+ "format": "double",
+ "type": "number"
+ },
+ "close": {
+ "description": "The closing value for the index of the day.",
+ "format": "double",
+ "type": "number"
+ },
+ "high": {
+ "description": "The highest value for the index of the day.",
+ "format": "double",
+ "type": "number"
+ },
+ "low": {
+ "description": "The lowest value for the index of the day.",
+ "format": "double",
+ "type": "number"
+ },
+ "open": {
+ "description": "The open value for the index of the day.",
+ "format": "double",
+ "type": "number"
+ },
+ "previous_close": {
+ "description": "The closing value for the index of previous trading day.",
+ "format": "double",
+ "type": "number"
+ }
+ },
+ "type": "object",
+ "x-polygon-go-type": {
+ "name": "IndicesSession"
+ }
+ },
+ "ticker": {
+ "description": "Ticker of asset queried.",
+ "type": "string"
+ },
+ "type": {
+ "description": "The indices market.",
+ "enum": [
+ "indices"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of Index.",
+ "type": "number"
+ }
+ },
+ "required": [
+ "ticker"
+ ],
+ "type": "object",
+ "x-polygon-go-type": {
+ "name": "IndicesResult"
+ }
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "The status of this request's response.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "request_id"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "description": "Snapshots for indices data of the underlying ticker"
+ }
+ },
+ "summary": "Indices Snapshot",
+ "tags": [
+ "indices:snapshot"
+ ],
+ "x-polygon-entitlement-allowed-timeframes": [
+ {
+ "description": "Real Time Data",
+ "name": "realtime"
+ },
+ {
+ "description": "15 minute delayed data",
+ "name": "delayed"
+ }
+ ],
+ "x-polygon-entitlement-data-type": {
+ "description": "Aggregate data",
+ "name": "aggregates"
+ },
+ "x-polygon-entitlement-market-type": {
+ "description": "Indices data",
+ "name": "indices"
+ }
+ }
+ },
"/v3/snapshot/options/{underlyingAsset}": {
"get": {
"description": "Get the snapshot of all options contracts for an underlying ticker.",
@@ -25137,13 +25222,17 @@
"REAL-TIME"
],
"type": "string"
+ },
+ "value": {
+ "description": "The value of the underlying index.",
+ "format": "double",
+ "type": "number"
}
},
"required": [
"last_updated",
"timeframe",
"ticker",
- "price",
"change_to_break_even"
],
"type": "object",
@@ -25645,13 +25728,17 @@
"REAL-TIME"
],
"type": "string"
+ },
+ "value": {
+ "description": "The value of the underlying index.",
+ "format": "double",
+ "type": "number"
}
},
"required": [
"last_updated",
"timeframe",
"ticker",
- "price",
"change_to_break_even"
],
"type": "object",
@@ -26472,6 +26553,676 @@
}
}
},
+ "/vX/reference/financials": {
+ "get": {
+ "description": "Get historical financial data for a stock ticker.\nThe financials data is extracted from XBRL from company SEC filings using the methodology outlined <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://xbrl.squarespace.com/understanding-sec-xbrl-financi/\">here</a>.",
+ "operationId": "ListFinancials",
+ "parameters": [
+ {
+ "description": "Query by company ticker.",
+ "in": "query",
+ "name": "ticker",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Query by central index key (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/edgar/searchedgar/cik.htm\">CIK</a>) Number",
+ "in": "query",
+ "name": "cik",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Query by company name.",
+ "in": "query",
+ "name": "company_name",
+ "schema": {
+ "type": "string"
+ },
+ "x-polygon-filter-field": {
+ "search": true
+ }
+ },
+ {
+ "description": "Query by standard industrial classification (<a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://www.sec.gov/corpfin/division-of-corporation-finance-standard-industrial-classification-sic-code-list\">SIC</a>)",
+ "in": "query",
+ "name": "sic",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Query by the date when the filing with financials data was filed in YYYY-MM-DD format.\n\nBest used when querying over date ranges to find financials based on filings that happen in a time period.\n\nExamples:\n\nTo get financials based on filings that have happened after January 1, 2009 use the query param filing_date.gte=2009-01-01\n\nTo get financials based on filings that happened in the year 2009 use the query params filing_date.gte=2009-01-01&filing_date.lt=2010-01-01",
+ "in": "query",
+ "name": "filing_date",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ },
+ "x-polygon-filter-field": {
+ "range": true
+ }
+ },
+ {
+ "description": "The period of report for the filing with financials data in YYYY-MM-DD format.",
+ "in": "query",
+ "name": "period_of_report_date",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ },
+ "x-polygon-filter-field": {
+ "range": true
+ }
+ },
+ {
+ "description": "Query by timeframe. Annual financials originate from 10-K filings, and quarterly financials originate from 10-Q filings. Note: Most companies do not file quarterly reports for Q4 and instead include those financials in their annual report, so some companies my not return quarterly financials for Q4",
+ "in": "query",
+ "name": "timeframe",
+ "schema": {
+ "enum": [
+ "annual",
+ "quarterly"
+ ],
+ "type": "string"
+ }
+ },
+ {
+ "description": "Whether or not to include the `xpath` and `formula` attributes for each financial data point.\nSee the `xpath` and `formula` response attributes for more info. False by default.",
+ "in": "query",
+ "name": "include_sources",
+ "schema": {
+ "default": false,
+ "type": "boolean"
+ }
+ },
+ {
+ "description": "Search by company_name.",
+ "in": "query",
+ "name": "company_name.search",
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by filing_date.",
+ "in": "query",
+ "name": "filing_date.gte",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by filing_date.",
+ "in": "query",
+ "name": "filing_date.gt",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by filing_date.",
+ "in": "query",
+ "name": "filing_date.lte",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by filing_date.",
+ "in": "query",
+ "name": "filing_date.lt",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by period_of_report_date.",
+ "in": "query",
+ "name": "period_of_report_date.gte",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by period_of_report_date.",
+ "in": "query",
+ "name": "period_of_report_date.gt",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by period_of_report_date.",
+ "in": "query",
+ "name": "period_of_report_date.lte",
+ "schema": {
+ "format": "date",
+ "type": "string"
+ }
+ },
+ {
+ "description": "Search by period_of_report_date.",
+ "in": "query",
+ "name": "period_of_report_date.lt",
+ "schema": {
+ "format": "date",
+ "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 100.",
+ "in": "query",
+ "name": "limit",
+ "schema": {
+ "default": 10,
+ "example": 10,
+ "maximum": 100,
+ "minimum": 1,
+ "type": "integer"
+ }
+ },
+ {
+ "description": "Sort field used for ordering.",
+ "in": "query",
+ "name": "sort",
+ "schema": {
+ "default": "period_of_report_date",
+ "enum": [
+ "filing_date",
+ "period_of_report_date"
+ ],
+ "example": "filing_date",
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "description": "FIXME",
+ "example": {
+ "count": 1,
+ "next_url": "https://api.polygon.io/vX/reference/financials?",
+ "request_id": "55eb92ed43b25568ab0cce159830ea34",
+ "results": [
+ {
+ "cik": "0001650729",
+ "company_name": "SiteOne Landscape Supply, Inc.",
+ "end_date": "2022-04-03",
+ "filing_date": "2022-05-04",
+ "financials": {
+ "balance_sheet": {
+ "assets": {
+ "label": "Assets",
+ "order": 100,
+ "unit": "USD",
+ "value": 2407400000
+ },
+ "current_assets": {
+ "label": "Current Assets",
+ "order": 200,
+ "unit": "USD",
+ "value": 1385900000
+ },
+ "current_liabilities": {
+ "label": "Current Liabilities",
+ "order": 700,
+ "unit": "USD",
+ "value": 597500000
+ },
+ "equity": {
+ "label": "Equity",
+ "order": 1400,
+ "unit": "USD",
+ "value": 1099200000
+ },
+ "equity_attributable_to_noncontrolling_interest": {
+ "label": "Equity Attributable To Noncontrolling Interest",
+ "order": 1500,
+ "unit": "USD",
+ "value": 0
+ },
+ "equity_attributable_to_parent": {
+ "label": "Equity Attributable To Parent",
+ "order": 1600,
+ "unit": "USD",
+ "value": 1099200000
+ },
+ "liabilities": {
+ "label": "Liabilities",
+ "order": 600,
+ "unit": "USD",
+ "value": 1308200000
+ },
+ "liabilities_and_equity": {
+ "label": "Liabilities And Equity",
+ "order": 1900,
+ "unit": "USD",
+ "value": 2407400000
+ },
+ "noncurrent_assets": {
+ "label": "Noncurrent Assets",
+ "order": 300,
+ "unit": "USD",
+ "value": 1021500000
+ },
+ "noncurrent_liabilities": {
+ "label": "Noncurrent Liabilities",
+ "order": 800,
+ "unit": "USD",
+ "value": 710700000
+ }
+ },
+ "cash_flow_statement": {
+ "exchange_gains_losses": {
+ "label": "Exchange Gains/Losses",
+ "order": 1000,
+ "unit": "USD",
+ "value": 100000
+ },
+ "net_cash_flow": {
+ "label": "Net Cash Flow",
+ "order": 1100,
+ "unit": "USD",
+ "value": -8600000
+ },
+ "net_cash_flow_continuing": {
+ "label": "Net Cash Flow, Continuing",
+ "order": 1200,
+ "unit": "USD",
+ "value": -8700000
+ },
+ "net_cash_flow_from_financing_activities": {
+ "label": "Net Cash Flow From Financing Activities",
+ "order": 700,
+ "unit": "USD",
+ "value": 150600000
+ },
+ "net_cash_flow_from_financing_activities_continuing": {
+ "label": "Net Cash Flow From Financing Activities, Continuing",
+ "order": 800,
+ "unit": "USD",
+ "value": 150600000
+ },
+ "net_cash_flow_from_investing_activities": {
+ "label": "Net Cash Flow From Investing Activities",
+ "order": 400,
+ "unit": "USD",
+ "value": -41000000
+ },
+ "net_cash_flow_from_investing_activities_continuing": {
+ "label": "Net Cash Flow From Investing Activities, Continuing",
+ "order": 500,
+ "unit": "USD",
+ "value": -41000000
+ },
+ "net_cash_flow_from_operating_activities": {
+ "label": "Net Cash Flow From Operating Activities",
+ "order": 100,
+ "unit": "USD",
+ "value": -118300000
+ },
+ "net_cash_flow_from_operating_activities_continuing": {
+ "label": "Net Cash Flow From Operating Activities, Continuing",
+ "order": 200,
+ "unit": "USD",
+ "value": -118300000
+ }
+ },
+ "comprehensive_income": {
+ "comprehensive_income_loss": {
+ "label": "Comprehensive Income/Loss",
+ "order": 100,
+ "unit": "USD",
+ "value": 40500000
+ },
+ "comprehensive_income_loss_attributable_to_noncontrolling_interest": {
+ "label": "Comprehensive Income/Loss Attributable To Noncontrolling Interest",
+ "order": 200,
+ "unit": "USD",
+ "value": 0
+ },
+ "comprehensive_income_loss_attributable_to_parent": {
+ "label": "Comprehensive Income/Loss Attributable To Parent",
+ "order": 300,
+ "unit": "USD",
+ "value": 40500000
+ },
+ "other_comprehensive_income_loss": {
+ "label": "Other Comprehensive Income/Loss",
+ "order": 400,
+ "unit": "USD",
+ "value": 40500000
+ },
+ "other_comprehensive_income_loss_attributable_to_parent": {
+ "label": "Other Comprehensive Income/Loss Attributable To Parent",
+ "order": 600,
+ "unit": "USD",
+ "value": 8200000
+ }
+ },
+ "income_statement": {
+ "basic_earnings_per_share": {
+ "label": "Basic Earnings Per Share",
+ "order": 4200,
+ "unit": "USD / shares",
+ "value": 0.72
+ },
+ "benefits_costs_expenses": {
+ "label": "Benefits Costs and Expenses",
+ "order": 200,
+ "unit": "USD",
+ "value": 768400000
+ },
+ "cost_of_revenue": {
+ "label": "Cost Of Revenue",
+ "order": 300,
+ "unit": "USD",
+ "value": 536100000
+ },
+ "costs_and_expenses": {
+ "label": "Costs And Expenses",
+ "order": 600,
+ "unit": "USD",
+ "value": 768400000
+ },
+ "diluted_earnings_per_share": {
+ "label": "Diluted Earnings Per Share",
+ "order": 4300,
+ "unit": "USD / shares",
+ "value": 0.7
+ },
+ "gross_profit": {
+ "label": "Gross Profit",
+ "order": 800,
+ "unit": "USD",
+ "value": 269200000
+ },
+ "income_loss_from_continuing_operations_after_tax": {
+ "label": "Income/Loss From Continuing Operations After Tax",
+ "order": 1400,
+ "unit": "USD",
+ "value": 32300000
+ },
+ "income_loss_from_continuing_operations_before_tax": {
+ "label": "Income/Loss From Continuing Operations Before Tax",
+ "order": 1500,
+ "unit": "USD",
+ "value": 36900000
+ },
+ "income_tax_expense_benefit": {
+ "label": "Income Tax Expense/Benefit",
+ "order": 2200,
+ "unit": "USD",
+ "value": 4600000
+ },
+ "interest_expense_operating": {
+ "label": "Interest Expense, Operating",
+ "order": 2700,
+ "unit": "USD",
+ "value": 4300000
+ },
+ "net_income_loss": {
+ "label": "Net Income/Loss",
+ "order": 3200,
+ "unit": "USD",
+ "value": 32300000
+ },
+ "net_income_loss_attributable_to_noncontrolling_interest": {
+ "label": "Net Income/Loss Attributable To Noncontrolling Interest",
+ "order": 3300,
+ "unit": "USD",
+ "value": 0
+ },
+ "net_income_loss_attributable_to_parent": {
+ "label": "Net Income/Loss Attributable To Parent",
+ "order": 3500,
+ "unit": "USD",
+ "value": 32300000
+ },
+ "net_income_loss_available_to_common_stockholders_basic": {
+ "label": "Net Income/Loss Available To Common Stockholders, Basic",
+ "order": 3700,
+ "unit": "USD",
+ "value": 32300000
+ },
+ "operating_expenses": {
+ "label": "Operating Expenses",
+ "order": 1000,
+ "unit": "USD",
+ "value": 228000000
+ },
+ "operating_income_loss": {
+ "label": "Operating Income/Loss",
+ "order": 1100,
+ "unit": "USD",
+ "value": 41200000
+ },
+ "participating_securities_distributed_and_undistributed_earnings_loss_basic": {
+ "label": "Participating Securities, Distributed And Undistributed Earnings/Loss, Basic",
+ "order": 3800,
+ "unit": "USD",
+ "value": 0
+ },
+ "preferred_stock_dividends_and_other_adjustments": {
+ "label": "Preferred Stock Dividends And Other Adjustments",
+ "order": 3900,
+ "unit": "USD",
+ "value": 0
+ },
+ "revenues": {
+ "label": "Revenues",
+ "order": 100,
+ "unit": "USD",
+ "value": 805300000
+ }
+ }
+ },
+ "fiscal_period": "Q1",
+ "fiscal_year": "2022",
+ "source_filing_file_url": "https://api.polygon.io/v1/reference/sec/filings/0001650729-22-000010/files/site-20220403_htm.xml",
+ "source_filing_url": "https://api.polygon.io/v1/reference/sec/filings/0001650729-22-000010",
+ "start_date": "2022-01-03"
+ }
+ ],
+ "status": "OK"
+ },
+ "schema": {
+ "properties": {
+ "count": {
+ "description": "The total number of results for this request.",
+ "type": "integer"
+ },
+ "next_url": {
+ "description": "If present, this value can be used to fetch the next page of data.",
+ "type": "string"
+ },
+ "request_id": {
+ "description": "A request id assigned by the server.",
+ "type": "string"
+ },
+ "results": {
+ "items": {
+ "properties": {
+ "acceptance_datetime": {
+ "description": "The datetime (EST timezone) the filing was accepted by EDGAR in YYYYMMDDHHMMSS format."
+ },
+ "cik": {
+ "description": "The CIK number for the company.",
+ "type": "string"
+ },
+ "company_name": {
+ "description": "The company name.",
+ "type": "string"
+ },
+ "end_date": {
+ "description": "The end date of the period that these financials cover in YYYYMMDD format.",
+ "type": "string"
+ },
+ "filing_date": {
+ "description": "The date that the SEC filing which these financials were derived from was made available. Note that this is not necessarily the date when this information became public, as some companies may publish a press release before filing with the SEC."
+ },
+ "financials": {
+ "properties": {
+ "balance_sheet": {
+ "description": "Balance sheet.\nNote that the keys in this object can be any of the balance sheet concepts defined in <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://www.xbrlsite.com/2016/fac/v3/Documentation/FundamentalAccountingConceptsList.html\">this table of fundamental accounting concepts</a> but converted to `snake_case`.",
+ "properties": {
+ "*": {
+ "description": "An individual financial data point.",
+ "properties": {
+ "formula": {
+ "description": "The name of the formula used to derive this data point from other financial data points.\nInformation about the formulas can be found <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://xbrlsite.azurewebsites.net/2020/reporting-scheme/us-gaap/fac/documentation/ImputeRulesList.html\">here</a>.\nThis value is only returned for data points that are not explicitly expressed within the XBRL source file when the `include_sources` query parameter is `true`."
+ },
+ "label": {
+ "description": "A human readable label for the financial data point.",
+ "type": "string"
+ },
+ "order": {
+ "description": "An indicator of what order within the statement that you would find this data point.",
+ "type": "integer"
+ },
+ "unit": {
+ "description": "The unit of the financial data point.",
+ "type": "string"
+ },
+ "value": {
+ "description": "The value of the financial data point.",
+ "type": "number"
+ },
+ "xpath": {
+ "description": "The <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"https://en.wikipedia.org/wiki/XPath\">XPath 1.0</a> query that identifies the fact from within the XBRL source file.\nThis value is only returned for data points taken directly from XBRL when the `include_sources` query parameter is `true`."
+ }
+ },
+ "required": [
+ "label",
+ "order",
+ "value",
+ "unit"
+ ],
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "cash_flow_statement": {
+ "description": "Cash flow statement.\nNote that the keys in this object can be any of the cash flow statement concepts defined in <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://www.xbrlsite.com/2016/fac/v3/Documentation/FundamentalAccountingConceptsList.html\">this table of fundamental accounting concepts</a> but converted to `snake_case`.\nSee the attributes of the objects within `balance_sheet` for more details.",
+ "type": "object"
+ },
+ "comprehensive_income": {
+ "description": "Comprehensive income.\nNote that the keys in this object can be any of the comprehensive income statement concepts defined in <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://www.xbrlsite.com/2016/fac/v3/Documentation/FundamentalAccountingConceptsList.html\">this table of fundamental accounting concepts</a> but converted to `snake_case`.\nSee the attributes of the objects within `balance_sheet` for more details.",
+ "type": "object"
+ },
+ "income_statement": {
+ "description": "Income statement.\nNote that the keys in this object can be any of the income statement concepts defined in <a rel=\"noopener noreferrer nofollow\" target=\"_blank\" href=\"http://www.xbrlsite.com/2016/fac/v3/Documentation/FundamentalAccountingConceptsList.html\">this table of fundamental accounting concepts</a> but converted to `snake_case`.\nSee the attributes of the objects within `balance_sheet` for more details.",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ },
+ "fiscal_period": {
+ "description": "Fiscal period of the report according to the company (Q1, Q2, Q3, Q4, or FY).",
+ "type": "string"
+ },
+ "fiscal_year": {
+ "description": "Fiscal year of the report according to the company.",
+ "type": "string"
+ },
+ "source_filing_file_url": {
+ "description": "The URL of the specific XBRL instance document within the SEC filing that these financials were derived from."
+ },
+ "source_filing_url": {
+ "description": "The URL of the SEC filing that these financials were derived from.",
+ "type": "string"
+ },
+ "start_date": {
+ "description": "The start date of the period that these financials cover in YYYYMMDD format.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "reporting_period",
+ "cik",
+ "company_name",
+ "financials",
+ "fiscal_period",
+ "fiscal_year",
+ "filing_type",
+ "source_filing_url",
+ "source_filing_file_url"
+ ],
+ "type": "object",
+ "x-polygon-go-type": {
+ "name": "ResolvedFinancials",
+ "path": "github.com/polygon-io/go-app-api-financials/extract"
+ }
+ },
+ "type": "array"
+ },
+ "status": {
+ "description": "The status of this request's response.",
+ "type": "string"
+ }
+ },
+ "required": [
+ "status",
+ "request_id",
+ "count",
+ "results"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "description": "FIXME"
+ }
+ },
+ "summary": "Stock Financials vX",
+ "tags": [
+ "reference:stocks"
+ ],
+ "x-polygon-entitlement-data-type": {
+ "description": "Reference data",
+ "name": "reference"
+ },
+ "x-polygon-experimental": {},
+ "x-polygon-paginate": {
+ "limit": {
+ "default": 10,
+ "max": 100
+ },
+ "sort": {
+ "default": "period_of_report_date",
+ "enum": [
+ "filing_date",
+ "period_of_report_date"
+ ]
+ }
+ }
+ }
+ },
"/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
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: