summaryrefslogtreecommitdiffstats
path: root/openbb_platform/openbb/assets/reference.json
diff options
context:
space:
mode:
Diffstat (limited to 'openbb_platform/openbb/assets/reference.json')
-rw-r--r--openbb_platform/openbb/assets/reference.json747
1 files changed, 433 insertions, 314 deletions
diff --git a/openbb_platform/openbb/assets/reference.json b/openbb_platform/openbb/assets/reference.json
index 61835911e88..0c01282e9c1 100644
--- a/openbb_platform/openbb/assets/reference.json
+++ b/openbb_platform/openbb/assets/reference.json
@@ -10500,7 +10500,10 @@
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter"
+ ]
}
],
"intrinio": [
@@ -10510,7 +10513,10 @@
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter"
+ ]
},
{
"name": "fiscal_year",
@@ -10528,7 +10534,11 @@
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter",
+ "ttm"
+ ]
},
{
"name": "filing_date",
@@ -10642,7 +10652,10 @@
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter"
+ ]
}
]
},
@@ -11829,7 +11842,7 @@
"polygon": [
{
"name": "accounts_receivable",
- "type": "int",
+ "type": "float",
"description": "Accounts receivable",
"default": null,
"optional": true,
@@ -11837,7 +11850,7 @@
},
{
"name": "marketable_securities",
- "type": "int",
+ "type": "float",
"description": "Marketable securities",
"default": null,
"optional": true,
@@ -11845,7 +11858,7 @@
},
{
"name": "prepaid_expenses",
- "type": "int",
+ "type": "float",
"description": "Prepaid expenses",
"default": null,
"optional": true,
@@ -11853,7 +11866,7 @@
},
{
"name": "other_current_assets",
- "type": "int",
+ "type": "float",
"description": "Other current assets",
"default": null,
"optional": true,
@@ -11861,7 +11874,7 @@
},
{
"name": "total_current_assets",
- "type": "int",
+ "type": "float",
"description": "Total current assets",
"default": null,
"optional": true,
@@ -11869,7 +11882,7 @@
},
{
"name": "property_plant_equipment_net",
- "type": "int",
+ "type": "float",
"description": "Property plant and equipment net",
"default": null,
"optional": true,
@@ -11877,7 +11890,7 @@
},
{
"name": "inventory",
- "type": "int",
+ "type": "float",
"description": "Inventory",
"default": null,
"optional": true,
@@ -11885,7 +11898,7 @@
},
{
"name": "other_non_current_assets",
- "type": "int",
+ "type": "float",
"description": "Other non-current assets",
"default": null,
"optional": true,
@@ -11893,7 +11906,7 @@
},
{
"name": "total_non_current_assets",
- "type": "int",
+ "type": "float",
"description": "Total non-current assets",
"default": null,
"optional": true,
@@ -11901,7 +11914,7 @@
},
{
"name": "intangible_assets",
- "type": "int",
+ "type": "float",
"description": "Intangible assets",
"default": null,
"optional": true,
@@ -11909,7 +11922,7 @@
},
{
"name": "total_assets",
- "type": "int",
+ "type": "float",
"description": "Total assets",
"default": null,
"optional": true,
@@ -11917,7 +11930,7 @@
},
{
"name": "accounts_payable",
- "type": "int",
+ "type": "float",
"description": "Accounts payable",
"default": null,
"optional": true,
@@ -11925,7 +11938,7 @@
},
{
"name": "employee_wages",
- "type": "int",
+ "type": "float",
"description": "Employee wages",
"default": null,
"optional": true,
@@ -11933,7 +11946,7 @@
},
{
"name": "other_current_liabilities",
- "type": "int",
+ "type": "float",
"description": "Other current liabilities",
"default": null,
"optional": true,
@@ -11941,7 +11954,7 @@
},
{
"name": "total_current_liabilities",
- "type": "int",
+ "type": "float",
"description": "Total current liabilities",
"default": null,
"optional": true,
@@ -11949,7 +11962,7 @@
},
{
"name": "other_non_current_liabilities",
- "type": "int",
+ "type": "float",
"description": "Other non-current liabilities",
"default": null,
"optional": true,
@@ -11957,7 +11970,7 @@
},
{
"name": "total_non_current_liabilities",
- "type": "int",
+ "type": "float",
"description": "Total non-current liabilities",
"default": null,
"optional": true,
@@ -11965,7 +11978,7 @@
},
{
"name": "long_term_debt",
- "type": "int",
+ "type": "float",
"description": "Long term debt",
"default": null,
"optional": true,
@@ -11973,7 +11986,7 @@
},
{
"name": "total_liabilities",
- "type": "int",
+ "type": "float",
"description": "Total liabilities",
"default": null,
"optional": true,
@@ -11981,7 +11994,7 @@
},
{
"name": "minority_interest",
- "type": "int",
+ "type": "float",
"description": "Minority interest",
"default": null,
"optional": true,
@@ -11989,7 +12002,7 @@
},
{
"name": "temporary_equity_attributable_to_parent",
- "type": "int",
+ "type": "float",
"description": "Temporary equity attributable to parent",
"default": null,
"optional": true,
@@ -11997,7 +12010,7 @@
},
{
"name": "equity_attributable_to_parent",
- "type": "int",
+ "type": "float",
"description": "Equity attributable to parent",
"default": null,
"optional": true,
@@ -12005,7 +12018,7 @@
},
{
"name": "temporary_equity",
- "type": "int",
+ "type": "float",
"description": "Temporary equity",
"default": null,
"optional": true,
@@ -12013,7 +12026,7 @@
},
{
"name": "preferred_stock",
- "type": "int",
+ "type": "float",
"description": "Preferred stock",
"default": null,
"optional": true,
@@ -12021,7 +12034,7 @@
},
{
"name": "redeemable_non_controlling_interest",
- "type": "int",
+ "type": "float",
"description": "Redeemable non-controlling interest",
"default": null,
"optional": true,
@@ -12029,32 +12042,32 @@
},
{
"name": "redeemable_non_controlling_interest_other",
- "type": "int",
+ "type": "float",
"description": "Redeemable non-controlling interest other",
"default": null,
"optional": true,
"choices": null
},
{
- "name": "total_stock_holders_equity",
- "type": "int",
+ "name": "total_shareholders_equity",
+ "type": "float",
"description": "Total stock holders equity",
"default": null,
"optional": true,
"choices": null
},
{
- "name": "total_liabilities_and_stock_holders_equity",
- "type": "int",
- "description": "Total liabilities and stockholders equity",
+ "name": "total_equity",
+ "type": "float",
+ "description": "Total equity",
"default": null,
"optional": true,
"choices": null
},
{
- "name": "total_equity",
- "type": "int",
- "description": "Total equity",
+ "name": "total_liabilities_and_shareholders_equity",
+ "type": "float",
+ "description": "Total liabilities and stockholders equity",
"default": null,
"optional": true,
"choices": null
@@ -12082,6 +12095,14 @@
"choices": null
},
{
+ "name": "period",
+ "type": "str",
+ "description": "Time period of the data to return.",
+ "default": "annual",
+ "optional": true,
+ "choices": null
+ },
+ {
"name": "limit",
"type": "int",
"description": "The number of data entries to return.",
@@ -12097,7 +12118,19 @@
"optional": true
}
],
- "fmp": []
+ "fmp": [
+ {
+ "name": "period",
+ "type": "Literal['annual', 'quarter']",
+ "description": "None",
+ "default": "annual",
+ "optional": true,
+ "choices": [
+ "annual",
+ "quarter"
+ ]
+ }
+ ]
},
"returns": {
"OBBject": [
@@ -12131,25 +12164,35 @@
"data": {
"standard": [
{
- "name": "symbol",
+ "name": "period_ending",
+ "type": "date",
+ "description": "The end date of the reporting period.",
+ "default": "",
+ "optional": false,
+ "choices": null
+ },
+ {
+ "name": "fiscal_period",
"type": "str",
- "description": "Symbol representing the entity requested in the data.",
+ "description": "The fiscal period of the report.",
"default": null,
"optional": true,
"choices": null
},
{
- "name": "date",
- "type": "date",
- "description": "The date of the data.",
- "default": "",
- "optional": false,
+ "name": "fiscal_year",
+ "type": "int",
+ "description": "The fiscal year of the fiscal period.",
+ "default": null,
+ "optional": true,
"choices": null
- },
+ }
+ ],
+ "fmp": [
{
- "name": "period",
+ "name": "symbol",
"type": "str",
- "description": "Reporting period.",
+ "description": "Symbol representing the entity requested in the data.",
"default": "",
"optional": false,
"choices": null
@@ -12158,56 +12201,56 @@
"name": "growth_cash_and_cash_equivalents",
"type": "float",
"description": "Growth rate of cash and cash equivalents.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_short_term_investments",
"type": "float",
"description": "Growth rate of short-term investments.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_cash_and_short_term_investments",
"type": "float",
"description": "Growth rate of cash and short-term investments.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_net_receivables",
"type": "float",
"description": "Growth rate of net receivables.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_inventory",
"type": "float",
"description": "Growth rate of inventory.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_other_current_assets",
"type": "float",
"description": "Growth rate of other current assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_current_assets",
"type": "float",
"description": "Growth rate of total current assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
@@ -12246,136 +12289,136 @@
"name": "growth_long_term_investments",
"type": "float",
"description": "Growth rate of long-term investments.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_tax_assets",
"type": "float",
"description": "Growth rate of tax assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_other_non_current_assets",
"type": "float",
"description": "Growth rate of other non-current assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_non_current_assets",
"type": "float",
"description": "Growth rate of total non-current assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_other_assets",
"type": "float",
"description": "Growth rate of other assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_assets",
"type": "float",
"description": "Growth rate of total assets.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_account_payables",
"type": "float",
"description": "Growth rate of accounts payable.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_short_term_debt",
"type": "float",
"description": "Growth rate of short-term debt.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_tax_payables",
"type": "float",
"description": "Growth rate of tax payables.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_deferred_revenue",
"type": "float",
"description": "Growth rate of deferred revenue.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_other_current_liabilities",
"type": "float",
"description": "Growth rate of other current liabilities.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_current_liabilities",
"type": "float",
"description": "Growth rate of total current liabilities.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_long_term_debt",
"type": "float",
"description": "Growth rate of long-term debt.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_deferred_revenue_non_current",
"type": "float",
"description": "Growth rate of non-current deferred revenue.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_deferrred_tax_liabilities_non_current",
"type": "float",
"description": "Growth rate of non-current deferred tax liabilities.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_other_non_current_liabilities",
"type": "float",
"description": "Growth rate of other non-current liabilities.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_non_current_liabilities",
"type": "float",
"description": "Growth rate of total non-current liabilities.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
@@ -12411,7 +12454,7 @@
"choices": null
},
{
- "name": "growth_accumulated_other_comprehensive_income_loss",
+ "name": "growth_accumulated_other_comprehensive_income",
"type": "float",
"description": "Growth rate of accumulated other comprehensive income/loss.",
"default": "",
@@ -12419,55 +12462,54 @@
"choices": null
},
{
- "name": "growth_othertotal_stockholders_equity",
+ "name": "growth_other_total_shareholders_equity",
"type": "float",
"description": "Growth rate of other total stockholders' equity.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
- "name": "growth_total_stockholders_equity",
+ "name": "growth_total_shareholders_equity",
"type": "float",
"description": "Growth rate of total stockholders' equity.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
- "name": "growth_total_liabilities_and_stockholders_equity",
+ "name": "growth_total_liabilities_and_shareholders_equity",
"type": "float",
"description": "Growth rate of total liabilities and stockholders' equity.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_investments",
"type": "float",
"description": "Growth rate of total investments.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_total_debt",
"type": "float",
"description": "Growth rate of total debt.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
},
{
"name": "growth_net_debt",
"type": "float",
"description": "Growth rate of net debt.",
- "default": "",
- "optional": false,
+ "default": null,
+ "optional": true,
"choices": null
}
- ],
- "fmp": []
+ ]
},
"model": "BalanceSheetGrowth"
},
@@ -12519,7 +12561,10 @@
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter"
+ ]
}
],
"intrinio": [
@@ -12529,7 +12574,12 @@
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter",
+ "ttm",
+ "ytd"
+ ]
},
{
"name": "fiscal_year",
@@ -12543,11 +12593,15 @@
"polygon": [
{
"name": "period",
- "type": "Literal['annual', 'quarter']",
+ "type": "Literal['annual', 'quarter', 'ttm']",
"description": "None",
"default": "annual",
"optional": true,
- "choices": null
+ "choices": [
+ "annual",
+ "quarter",
+ "ttm"
+ ]
},
{
"name": "filing_date",
@@ -13376,7 +13430,7 @