mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-27 12:40:35 +00:00
[Bug fix] - explicit multiple items docstring (#6127)
* explicit multiple items docstring * rebuiild * rebuild again --------- Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com>
This commit is contained in:
@@ -219,13 +219,13 @@ class ProviderInterface(metaclass=SingletonMeta):
|
||||
|
||||
additional_description = ""
|
||||
if (extra := field.json_schema_extra) and (
|
||||
multiple := extra.get("multiple_items_allowed")
|
||||
multiple := extra.get("multiple_items_allowed") # type: ignore
|
||||
):
|
||||
if provider_name:
|
||||
additional_description += " Multiple items allowed."
|
||||
else:
|
||||
additional_description += (
|
||||
" Multiple items allowed: " + ", ".join(multiple) + "."
|
||||
" Multiple items allowed for provider(s): " + ", ".join(multiple) + "." # type: ignore
|
||||
)
|
||||
|
||||
provider_field = (
|
||||
|
||||
@@ -26,7 +26,7 @@ class ROUTER_crypto_price(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: fmp, polygon, yfinance."
|
||||
description="Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, yfinance."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -49,7 +49,7 @@ class ROUTER_crypto_price(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: fmp, polygon, yfinance.
|
||||
Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): fmp, polygon, yfinance.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
|
||||
@@ -26,7 +26,7 @@ class ROUTER_currency_price(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: polygon, yfinance."
|
||||
description="Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon, yfinance."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -56,7 +56,7 @@ class ROUTER_currency_price(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed: polygon, yfinance.
|
||||
Symbol to get data for. Can use CURR1-CURR2 or CURR1CURR2 format. Multiple items allowed for provider(s): polygon, yfinance.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
|
||||
@@ -127,7 +127,7 @@ class ROUTER_derivatives_options(Container):
|
||||
close_ask_time : Optional[datetime]
|
||||
The time of the ask closing price for the option that day.
|
||||
prev_close : Optional[float]
|
||||
|
||||
The previous close price.
|
||||
change : Optional[float]
|
||||
The change in the price of the option.
|
||||
change_percent : Optional[float]
|
||||
|
||||
@@ -238,7 +238,7 @@ class ROUTER_economy(Container):
|
||||
country: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="The country to get data. Multiple items allowed: fred."
|
||||
description="The country to get data. Multiple items allowed for provider(s): fred."
|
||||
),
|
||||
],
|
||||
units: Annotated[
|
||||
@@ -279,7 +279,7 @@ class ROUTER_economy(Container):
|
||||
Parameters
|
||||
----------
|
||||
country : Union[str, List[str]]
|
||||
The country to get data. Multiple items allowed: fred.
|
||||
The country to get data. Multiple items allowed for provider(s): fred.
|
||||
units : Literal['growth_previous', 'growth_same', 'index_2015']
|
||||
The unit of measurement for the data.
|
||||
Options:
|
||||
@@ -359,7 +359,7 @@ class ROUTER_economy(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fred."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fred."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -388,7 +388,7 @@ class ROUTER_economy(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fred.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fred.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
@@ -470,7 +470,7 @@ class ROUTER_economy(Container):
|
||||
The date of the data.
|
||||
region : Optional[str]
|
||||
The name of the region. (provider: fred)
|
||||
code : Optional[Union[str, int]]
|
||||
code : Optional[Union[int, str]]
|
||||
The code of the region. (provider: fred)
|
||||
value : Optional[Union[float, int]]
|
||||
The obersvation value. The units are defined in the search results by series ID. (provider: fred)
|
||||
@@ -636,7 +636,7 @@ class ROUTER_economy(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fred."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fred."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -663,7 +663,7 @@ class ROUTER_economy(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fred.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fred.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
|
||||
@@ -115,7 +115,7 @@ class ROUTER_equity(Container):
|
||||
close : Optional[float]
|
||||
The close price.
|
||||
prev_close : Optional[float]
|
||||
The previous closing price of the stock.
|
||||
The previous close price.
|
||||
change : Optional[float]
|
||||
The change in price.
|
||||
change_percent : Optional[float]
|
||||
@@ -229,7 +229,7 @@ class ROUTER_equity(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp, intrinio, yfinance."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp", "intrinio", "yfinance"]] = None,
|
||||
@@ -240,7 +240,7 @@ class ROUTER_equity(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp, intrinio, yfinance.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp, intrinio, yfinance.
|
||||
provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
|
||||
@@ -199,7 +199,7 @@ class ROUTER_equity_estimates(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: yfinance."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): yfinance."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp", "yfinance"]] = None,
|
||||
@@ -210,7 +210,7 @@ class ROUTER_equity_estimates(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: yfinance.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): yfinance.
|
||||
provider : Optional[Literal['fmp', 'yfinance']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -403,7 +403,7 @@ class ROUTER_equity_estimates(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, None, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: benzinga."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): benzinga."
|
||||
),
|
||||
] = None,
|
||||
limit: Annotated[
|
||||
@@ -418,7 +418,7 @@ class ROUTER_equity_estimates(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, None, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: benzinga.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): benzinga.
|
||||
limit : int
|
||||
The number of data entries to return.
|
||||
provider : Optional[Literal['benzinga', 'fmp']]
|
||||
|
||||
@@ -1177,7 +1177,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
End date of the data, in YYYY-MM-DD format. (provider: intrinio)
|
||||
thea_enabled : Optional[bool]
|
||||
Return filings that have been read by Intrinio's Thea NLP. (provider: intrinio)
|
||||
cik : Optional[Union[str, int]]
|
||||
cik : Optional[Union[int, str]]
|
||||
Lookup filings by Central Index Key (CIK) instead of by symbol. (provider: sec)
|
||||
type : Optional[Literal['1', '1-A', '1-A POS', '1-A-W', '1-E', '1-E AD', '1-K', '1-SA', '1-U', '1-Z', '1-Z-W', '10-12B', '10-12G', '10-D', '10-K', '10-KT', '10-Q', '10-QT', '11-K', '11-KT', '13F-HR', '13F-NT', '13FCONP', '144', '15-12B', '15-12G', '15-15D', '15F-12B', '15F-12G', '15F-15D', '18-12B', '18-K', '19B-4E', '2-A', '2-AF', '2-E', '20-F', '20FR12B', '20FR12G', '24F-2NT', '25', '25-NSE', '253G1', '253G2', '253G3', '253G4', '3', '305B2', '34-12H', '4', '40-17F1', '40-17F2', '40-17G', '40-17GCS', '40-202A', '40-203A', '40-206A', '40-24B2', '40-33', '40-6B', '40-8B25', '40-8F-2', '40-APP', '40-F', '40-OIP', '40FR12B', '40FR12G', '424A', '424B1', '424B2', '424B3', '424B4', '424B5', '424B7', '424B8', '424H', '425', '485APOS', '485BPOS', '485BXT', '486APOS', '486BPOS', '486BXT', '487', '497', '497AD', '497H2', '497J', '497K', '497VPI', '497VPU', '5', '6-K', '6B NTC', '6B ORDR', '8-A12B', '8-A12G', '8-K', '8-K12B', '8-K12G3', '8-K15D5', '8-M', '8F-2 NTC', '8F-2 ORDR', '9-M', 'ABS-15G', 'ABS-EE', 'ADN-MTL', 'ADV-E', 'ADV-H-C', 'ADV-H-T', 'ADV-NR', 'ANNLRPT', 'APP NTC', 'APP ORDR', 'APP WD', 'APP WDG', 'ARS', 'ATS-N', 'ATS-N-C', 'ATS-N/UA', 'AW', 'AW WD', 'C', 'C-AR', 'C-AR-W', 'C-TR', 'C-TR-W', 'C-U', 'C-U-W', 'C-W', 'CB', 'CERT', 'CERTARCA', 'CERTBATS', 'CERTCBO', 'CERTNAS', 'CERTNYS', 'CERTPAC', 'CFPORTAL', 'CFPORTAL-W', 'CORRESP', 'CT ORDER', 'D', 'DEF 14A', 'DEF 14C', 'DEFA14A', 'DEFA14C', 'DEFC14A', 'DEFC14C', 'DEFM14A', 'DEFM14C', 'DEFN14A', 'DEFR14A', 'DEFR14C', 'DEL AM', 'DFAN14A', 'DFRN14A', 'DOS', 'DOSLTR', 'DRS', 'DRSLTR', 'DSTRBRPT', 'EFFECT', 'F-1', 'F-10', 'F-10EF', 'F-10POS', 'F-1MEF', 'F-3', 'F-3ASR', 'F-3D', 'F-3DPOS', 'F-3MEF', 'F-4', 'F-4 POS', 'F-4MEF', 'F-6', 'F-6 POS', 'F-6EF', 'F-7', 'F-7 POS', 'F-8', 'F-8 POS', 'F-80', 'F-80POS', 'F-9', 'F-9 POS', 'F-N', 'F-X', 'FOCUSN', 'FWP', 'G-405', 'G-405N', 'G-FIN', 'G-FINW', 'IRANNOTICE', 'MA', 'MA-A', 'MA-I', 'MA-W', 'MSD', 'MSDCO', 'MSDW', 'N-1', 'N-14', 'N-14 8C', 'N-14MEF', 'N-18F1', 'N-1A', 'N-2', 'N-2 POSASR', 'N-23C-2', 'N-23C3A', 'N-23C3B', 'N-23C3C', 'N-2ASR', 'N-2MEF', 'N-30B-2', 'N-30D', 'N-4', 'N-5', 'N-54A', 'N-54C', 'N-6', 'N-6F', 'N-8A', 'N-8B-2', 'N-8F', 'N-8F NTC', 'N-8F ORDR', 'N-CEN', 'N-CR', 'N-CSR', 'N-CSRS', 'N-MFP', 'N-MFP1', 'N-MFP2', 'N-PX', 'N-Q', 'N-VP', 'N-VPFS', 'NO ACT', 'NPORT-EX', 'NPORT-NP', 'NPORT-P', 'NRSRO-CE', 'NRSRO-UPD', 'NSAR-A', 'NSAR-AT', 'NSAR-B', 'NSAR-BT', 'NSAR-U', 'NT 10-D', 'NT 10-K', 'NT 10-Q', 'NT 11-K', 'NT 20-F', 'NT N-CEN', 'NT N-MFP', 'NT N-MFP1', 'NT N-MFP2', 'NT NPORT-EX', 'NT NPORT-P', 'NT-NCEN', 'NT-NCSR', 'NT-NSAR', 'NTFNCEN', 'NTFNCSR', 'NTFNSAR', 'NTN 10D', 'NTN 10K', 'NTN 10Q', 'NTN 20F', 'OIP NTC', 'OIP ORDR', 'POS 8C', 'POS AM', 'POS AMI', 'POS EX', 'POS462B', 'POS462C', 'POSASR', 'PRE 14A', 'PRE 14C', 'PREC14A', 'PREC14C', 'PREM14A', 'PREM14C', 'PREN14A', 'PRER14A', 'PRER14C', 'PRRN14A', 'PX14A6G', 'PX14A6N', 'QRTLYRPT', 'QUALIF', 'REG-NR', 'REVOKED', 'RW', 'RW WD', 'S-1', 'S-11', 'S-11MEF', 'S-1MEF', 'S-20', 'S-3', 'S-3ASR', 'S-3D', 'S-3DPOS', 'S-3MEF', 'S-4', 'S-4 POS', 'S-4EF', 'S-4MEF', 'S-6', 'S-8', 'S-8 POS', 'S-B', 'S-BMEF', 'SBSE', 'SBSE-A', 'SBSE-BD', 'SBSE-C', 'SBSE-W', 'SC 13D', 'SC 13E1', 'SC 13E3', 'SC 13G', 'SC 14D9', 'SC 14F1', 'SC 14N', 'SC TO-C', 'SC TO-I', 'SC TO-T', 'SC13E4F', 'SC14D1F', 'SC14D9C', 'SC14D9F', 'SD', 'SDR', 'SE', 'SEC ACTION', 'SEC STAFF ACTION', 'SEC STAFF LETTER', 'SF-1', 'SF-3', 'SL', 'SP 15D2', 'STOP ORDER', 'SUPPL', 'T-3', 'TA-1', 'TA-2', 'TA-W', 'TACO', 'TH', 'TTW', 'UNDER', 'UPLOAD', 'WDL-REQ', 'X-17A-5']]
|
||||
Type of the SEC filing form. (provider: sec)
|
||||
@@ -1228,7 +1228,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
Industry category of the company. (provider: intrinio)
|
||||
report_date : Optional[date]
|
||||
The date of the filing. (provider: sec)
|
||||
act : Optional[Union[str, int]]
|
||||
act : Optional[Union[int, str]]
|
||||
The SEC Act number. (provider: sec)
|
||||
items : Optional[Union[str, float]]
|
||||
The SEC Item numbers. (provider: sec)
|
||||
@@ -1236,17 +1236,17 @@ class ROUTER_equity_fundamental(Container):
|
||||
The description of the primary document. (provider: sec)
|
||||
primary_doc : Optional[str]
|
||||
The filename of the primary document. (provider: sec)
|
||||
accession_number : Optional[Union[str, int]]
|
||||
accession_number : Optional[Union[int, str]]
|
||||
The accession number. (provider: sec)
|
||||
file_number : Optional[Union[str, int]]
|
||||
file_number : Optional[Union[int, str]]
|
||||
The file number. (provider: sec)
|
||||
film_number : Optional[Union[str, int]]
|
||||
film_number : Optional[Union[int, str]]
|
||||
The film number. (provider: sec)
|
||||
is_inline_xbrl : Optional[Union[str, int]]
|
||||
is_inline_xbrl : Optional[Union[int, str]]
|
||||
Whether the filing is an inline XBRL filing. (provider: sec)
|
||||
is_xbrl : Optional[Union[str, int]]
|
||||
is_xbrl : Optional[Union[int, str]]
|
||||
Whether the filing is an XBRL filing. (provider: sec)
|
||||
size : Optional[Union[str, int]]
|
||||
size : Optional[Union[int, str]]
|
||||
The size of the filing. (provider: sec)
|
||||
complete_submission_url : Optional[str]
|
||||
The URL to the complete filing submission. (provider: sec)
|
||||
@@ -1285,13 +1285,13 @@ class ROUTER_equity_fundamental(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: intrinio."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): intrinio."
|
||||
),
|
||||
],
|
||||
tag: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Intrinio data tag ID or code. Multiple items allowed: intrinio."
|
||||
description="Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -1330,9 +1330,9 @@ class ROUTER_equity_fundamental(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: intrinio.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): intrinio.
|
||||
tag : Union[str, List[str]]
|
||||
Intrinio data tag ID or code. Multiple items allowed: intrinio.
|
||||
Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
@@ -2059,13 +2059,13 @@ class ROUTER_equity_fundamental(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: intrinio."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): intrinio."
|
||||
),
|
||||
],
|
||||
tag: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Intrinio data tag ID or code. Multiple items allowed: intrinio."
|
||||
description="Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["intrinio"]] = None,
|
||||
@@ -2076,9 +2076,9 @@ class ROUTER_equity_fundamental(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: intrinio.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): intrinio.
|
||||
tag : Union[str, List[str]]
|
||||
Intrinio data tag ID or code. Multiple items allowed: intrinio.
|
||||
Intrinio data tag ID or code. Multiple items allowed for provider(s): intrinio.
|
||||
provider : Optional[Literal['intrinio']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'intrinio' if there is
|
||||
@@ -2221,7 +2221,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -2244,7 +2244,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
@@ -2330,7 +2330,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp, yfinance."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp, yfinance."
|
||||
),
|
||||
],
|
||||
period: Annotated[
|
||||
@@ -2349,7 +2349,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp, yfinance.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp, yfinance.
|
||||
period : Optional[Literal['annual', 'quarter']]
|
||||
Time period of the data to return.
|
||||
limit : Optional[int]
|
||||
@@ -2532,10 +2532,10 @@ class ROUTER_equity_fundamental(Container):
|
||||
Quick ratio. (provider: yfinance)
|
||||
gross_margin : Optional[float]
|
||||
Gross margin, as a normalized percent. (provider: yfinance)
|
||||
ebitda_margin : Optional[float]
|
||||
EBITDA margin, as a normalized percent. (provider: yfinance)
|
||||
operating_margin : Optional[float]
|
||||
Operating margin, as a normalized percent. (provider: yfinance)
|
||||
ebitda_margin : Optional[float]
|
||||
EBITDA margin, as a normalized percent. (provider: yfinance)
|
||||
profit_margin : Optional[float]
|
||||
Profit margin, as a normalized percent. (provider: yfinance)
|
||||
return_on_assets : Optional[float]
|
||||
@@ -2596,7 +2596,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp"]] = None,
|
||||
@@ -2607,7 +2607,7 @@ class ROUTER_equity_fundamental(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp.
|
||||
provider : Optional[Literal['fmp']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
|
||||
@@ -475,7 +475,7 @@ class ROUTER_equity_ownership(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: yfinance."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): yfinance."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp", "intrinio", "yfinance"]] = None,
|
||||
@@ -486,7 +486,7 @@ class ROUTER_equity_ownership(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: yfinance.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): yfinance.
|
||||
provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
|
||||
@@ -29,7 +29,7 @@ class ROUTER_equity_price(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp, polygon, tiingo, yfinance."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance."
|
||||
),
|
||||
],
|
||||
interval: Annotated[
|
||||
@@ -58,7 +58,7 @@ class ROUTER_equity_price(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp, polygon, tiingo, yfinance.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp, polygon, tiingo, yfinance.
|
||||
interval : Optional[str]
|
||||
Time interval of the data to return.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
@@ -155,7 +155,7 @@ class ROUTER_equity_price(Container):
|
||||
factor : Optional[float]
|
||||
factor by which to multiply equity prices before this date, in order to calculate historically-adjusted equity prices. (provider: intrinio)
|
||||
split_ratio : Optional[float]
|
||||
Ratio of the equity split, if a split occurred. (provider: intrinio, tiingo, yfinance)
|
||||
Ratio of the equity split, if a equity split occurred. (provider: intrinio, tiingo, yfinance)
|
||||
dividend : Optional[float]
|
||||
Dividend amount, if a dividend was paid. (provider: intrinio, tiingo, yfinance)
|
||||
percent_change : Optional[float]
|
||||
@@ -340,7 +340,7 @@ class ROUTER_equity_price(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp"]] = None,
|
||||
@@ -351,7 +351,7 @@ class ROUTER_equity_price(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp.
|
||||
provider : Optional[Literal['fmp']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -435,7 +435,7 @@ class ROUTER_equity_price(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed: fmp, intrinio, yfinance."
|
||||
description="Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio, yfinance."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp", "intrinio", "yfinance"]] = None,
|
||||
@@ -446,7 +446,7 @@ class ROUTER_equity_price(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed: fmp, intrinio, yfinance.
|
||||
Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): fmp, intrinio, yfinance.
|
||||
provider : Optional[Literal['fmp', 'intrinio', 'yfinance']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -527,7 +527,7 @@ class ROUTER_equity_price(Container):
|
||||
exchange_volume : Optional[Union[float, int]]
|
||||
Volume of shares exchanged during the trading day on the specific exchange.
|
||||
prev_close : Optional[float]
|
||||
|
||||
The previous close price.
|
||||
change : Optional[float]
|
||||
Change in price from previous close.
|
||||
change_percent : Optional[float]
|
||||
|
||||
@@ -35,7 +35,7 @@ class ROUTER_etf(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. (ETF) Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp"]] = None,
|
||||
@@ -46,7 +46,7 @@ class ROUTER_etf(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. (ETF) Multiple items allowed: fmp.
|
||||
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp.
|
||||
provider : Optional[Literal['fmp']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -102,7 +102,7 @@ class ROUTER_etf(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. (Stock) Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp"]] = None,
|
||||
@@ -113,7 +113,7 @@ class ROUTER_etf(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. (Stock) Multiple items allowed: fmp.
|
||||
Symbol to get data for. (Stock) Multiple items allowed for provider(s): fmp.
|
||||
provider : Optional[Literal['fmp']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -415,11 +415,11 @@ class ROUTER_etf(Container):
|
||||
The floating rate spread for reveivable portion of the swap. (provider: sec)
|
||||
rate_tenor_rec : Optional[str]
|
||||
The rate tenor for reveivable portion of the swap. (provider: sec)
|
||||
rate_tenor_unit_rec : Optional[Union[str, int]]
|
||||
rate_tenor_unit_rec : Optional[Union[int, str]]
|
||||
The rate tenor unit for reveivable portion of the swap. (provider: sec)
|
||||
reset_date_rec : Optional[str]
|
||||
The reset date for reveivable portion of the swap. (provider: sec)
|
||||
reset_date_unit_rec : Optional[Union[str, int]]
|
||||
reset_date_unit_rec : Optional[Union[int, str]]
|
||||
The reset date unit for reveivable portion of the swap. (provider: sec)
|
||||
rate_type_pmnt : Optional[str]
|
||||
The type of rate for payment portion of the swap. (provider: sec)
|
||||
@@ -433,11 +433,11 @@ class ROUTER_etf(Container):
|
||||
The floating rate spread for payment portion of the swap. (provider: sec)
|
||||
rate_tenor_pmnt : Optional[str]
|
||||
The rate tenor for payment portion of the swap. (provider: sec)
|
||||
rate_tenor_unit_pmnt : Optional[Union[str, int]]
|
||||
rate_tenor_unit_pmnt : Optional[Union[int, str]]
|
||||
The rate tenor unit for payment portion of the swap. (provider: sec)
|
||||
reset_date_pmnt : Optional[str]
|
||||
The reset date for payment portion of the swap. (provider: sec)
|
||||
reset_date_unit_pmnt : Optional[Union[str, int]]
|
||||
reset_date_unit_pmnt : Optional[Union[int, str]]
|
||||
The reset date unit for payment portion of the swap. (provider: sec)
|
||||
repo_type : Optional[str]
|
||||
The type of repo. (provider: sec)
|
||||
@@ -573,7 +573,7 @@ class ROUTER_etf(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp"]] = None,
|
||||
@@ -584,7 +584,7 @@ class ROUTER_etf(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp.
|
||||
provider : Optional[Literal['fmp']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -668,7 +668,7 @@ class ROUTER_etf(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. (ETF) Multiple items allowed: fmp, yfinance."
|
||||
description="Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, yfinance."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp", "yfinance"]] = None,
|
||||
@@ -679,7 +679,7 @@ class ROUTER_etf(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. (ETF) Multiple items allowed: fmp, yfinance.
|
||||
Symbol to get data for. (ETF) Multiple items allowed for provider(s): fmp, yfinance.
|
||||
provider : Optional[Literal['fmp', 'yfinance']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
@@ -829,7 +829,7 @@ class ROUTER_etf(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: fmp."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): fmp."
|
||||
),
|
||||
],
|
||||
provider: Optional[Literal["fmp"]] = None,
|
||||
@@ -840,7 +840,7 @@ class ROUTER_etf(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: fmp.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): fmp.
|
||||
provider : Optional[Literal['fmp']]
|
||||
The provider to use for the query, by default None.
|
||||
If None, the provider specified in defaults is selected or 'fmp' if there is
|
||||
|
||||
@@ -178,7 +178,7 @@ class ROUTER_index(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. Multiple items allowed: yfinance."
|
||||
description="Symbol to get data for. Multiple items allowed for provider(s): yfinance."
|
||||
),
|
||||
],
|
||||
start_date: Annotated[
|
||||
@@ -201,7 +201,7 @@ class ROUTER_index(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, List[str]]
|
||||
Symbol to get data for. Multiple items allowed: yfinance.
|
||||
Symbol to get data for. Multiple items allowed for provider(s): yfinance.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
|
||||
@@ -28,7 +28,7 @@ class ROUTER_news(Container):
|
||||
symbol: Annotated[
|
||||
Union[str, None, List[str]],
|
||||
OpenBBCustomParameter(
|
||||
description="Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed: benzinga, fmp, intrinio, polygon, tiingo, yfinance."
|
||||
description="Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance."
|
||||
),
|
||||
] = None,
|
||||
start_date: Annotated[
|
||||
@@ -57,7 +57,7 @@ class ROUTER_news(Container):
|
||||
Parameters
|
||||
----------
|
||||
symbol : Union[str, None, List[str]]
|
||||
Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed: benzinga, fmp, intrinio, polygon, tiingo, yfinance.
|
||||
Symbol to get data for. This endpoint will accept multiple symbols separated by commas. Multiple items allowed for provider(s): benzinga, fmp, intrinio, polygon, tiingo, yfinance.
|
||||
start_date : Union[datetime.date, None, str]
|
||||
Start date of the data, in YYYY-MM-DD format.
|
||||
end_date : Union[datetime.date, None, str]
|
||||
|
||||
@@ -61,7 +61,7 @@ class ROUTER_regulators_sec(Container):
|
||||
CikMap
|
||||
------
|
||||
cik : Optional[Union[int, str]]
|
||||
Central Index Key
|
||||
Central Index Key (CIK) for the requested entity.
|
||||
|
||||
Example
|
||||
-------
|
||||
|
||||
Reference in New Issue
Block a user