addedOutput schema / properties / financials
Added value: +{
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "description": "Reporting currency of the latest period; amounts are in it, not USD.",
+ "type": "string"
+ },
+ "latest_annual": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "type": "string"
+ },
+ "filed_date": {
+ "type": "string"
+ },
+ "fiscal_period": {
+ "enum": [
+ "FY",
+ "Q1",
+ "Q2",
+ "Q3",
+ "Q4"
+ ],
+ "type": "string"
+ },
+ "fiscal_year": {
+ "type": "number"
+ },
+ "form": {
+ "type": "string"
+ },
+ "free_cash_flow": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "net_income": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "period_end": {
+ "type": "string"
+ },
+ "reported_date": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "revenue": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "usd_rate": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "average": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "period_end": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "average",
+ "period_end"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "US dollars per 1 unit of the reporting currency (FRED H.10): average over the period (for income statement and cash flow amounts) and on the period-end date (for balance sheet amounts). null for companies reporting in USD."
+ },
+ "yoy_pct": {
+ "additionalProperties": false,
+ "properties": {
+ "free_cash_flow": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "net_income": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "revenue": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "revenue",
+ "net_income",
+ "free_cash_flow"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "fiscal_year",
+ "fiscal_period",
+ "period_end",
+ "currency",
+ "revenue",
+ "net_income",
+ "free_cash_flow",
+ "yoy_pct",
+ "form",
+ "filed_date",
+ "reported_date",
+ "usd_rate"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "latest_quarter": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "currency": {
+ "type": "string"
+ },
+ "filed_date": {
+ "type": "string"
+ },
+ "fiscal_period": {
+ "enum": [
+ "FY",
+ "Q1",
+ "Q2",
+ "Q3",
+ "Q4"
+ ],
+ "type": "string"
+ },
+ "fiscal_year": {
+ "type": "number"
+ },
+ "form": {
+ "type": "string"
+ },
+ "free_cash_flow": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "net_income": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "period_end": {
+ "type": "string"
+ },
+ "reported_date": {
+ "type": [
+ "string",
+ "null"
+ ]
+ },
+ "revenue": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "usd_rate": {
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "average": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "period_end": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "average",
+ "period_end"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "US dollars per 1 unit of the reporting currency (FRED H.10): average over the period (for income statement and cash flow amounts) and on the period-end date (for balance sheet amounts). null for companies reporting in USD."
+ },
+ "yoy_pct": {
+ "additionalProperties": false,
+ "properties": {
+ "free_cash_flow": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "net_income": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "revenue": {
+ "type": [
+ "number",
+ "null"
+ ]
+ }
+ },
+ "required": [
+ "revenue",
+ "net_income",
+ "free_cash_flow"
+ ],
+ "type": "object"
+ }
+ },
+ "required": [
+ "fiscal_year",
+ "fiscal_period",
+ "period_end",
+ "currency",
+ "revenue",
+ "net_income",
+ "free_cash_flow",
+ "yoy_pct",
+ "form",
+ "filed_date",
+ "reported_date",
+ "usd_rate"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ]
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "currency",
+ "latest_annual",
+ "latest_quarter",
+ "url"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Latest fiscal year and latest quarter from the XBRL financial statements, in the reporting currency; null when there are none. get_financials has the full statements."
+}
addedOutput schema / properties / short_interest
Added value: +{
+ "anyOf": [
+ {
+ "additionalProperties": false,
+ "properties": {
+ "avg_daily_volume": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "change_pct": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "change_shares": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "days_to_cover": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "dtc_capped": {
+ "type": "boolean"
+ },
+ "settlement_date": {
+ "type": "string"
+ },
+ "short_shares": {
+ "type": [
+ "number",
+ "null"
+ ]
+ },
+ "url": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "settlement_date",
+ "short_shares",
+ "change_shares",
+ "change_pct",
+ "avg_daily_volume",
+ "days_to_cover",
+ "dtc_capped",
+ "url"
+ ],
+ "type": "object"
+ },
+ {
+ "type": "null"
+ }
+ ],
+ "description": "Latest FINRA short interest (within the last year); null when there is none. get_short_interest has the history, short volume, fails-to-deliver and ATS volume."
+}
changedOutput schema / required
Previous value: -[
- "ticker",
- "name",
- "cik",
- "exchange",
- "active",
- "delisted",
- "delisted_on",
- "sic",
- "industry",
- "other_share_classes",
- "url",
- "insiders_url",
- "holders_url",
- "sec_filings_url",
- "insider_activity",
- "f13",
- "superinvestors"
-]New value: +[
+ "ticker",
+ "name",
+ "cik",
+ "exchange",
+ "active",
+ "delisted",
+ "delisted_on",
+ "sic",
+ "industry",
+ "other_share_classes",
+ "url",
+ "insiders_url",
+ "holders_url",
+ "sec_filings_url",
+ "insider_activity",
+ "f13",
+ "superinvestors",
+ "financials",
+ "short_interest"
+]