mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 06:51:38 +00:00
bcb1f50b05
* breakdown builder + remove black * rebuild * rebuild * rebuild * rename method * format built code without black * we still lint if it's available * fix existing tests * add linter tests * add black to dev deps * auto_build as instance method * reorder methods * typing --------- Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
119 lines
3.8 KiB
Python
119 lines
3.8 KiB
Python
### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
|
|
|
|
import datetime
|
|
from typing import Literal, Optional, Union
|
|
|
|
from openbb_core.app.model.custom_parameter import OpenBBCustomParameter
|
|
from openbb_core.app.model.obbject import OBBject
|
|
from openbb_core.app.static.container import Container
|
|
from openbb_core.app.static.utils.decorators import validate
|
|
from openbb_core.app.static.utils.filters import filter_inputs
|
|
from typing_extensions import Annotated
|
|
|
|
|
|
class ROUTER_equity_discovery(Container):
|
|
"""/equity/discovery
|
|
filings
|
|
"""
|
|
|
|
def __repr__(self) -> str:
|
|
return self.__doc__ or ""
|
|
|
|
@validate
|
|
def filings(
|
|
self,
|
|
start_date: Annotated[
|
|
Union[datetime.date, None, str],
|
|
OpenBBCustomParameter(
|
|
description="Start date of the data, in YYYY-MM-DD format."
|
|
),
|
|
] = None,
|
|
end_date: Annotated[
|
|
Union[datetime.date, None, str],
|
|
OpenBBCustomParameter(
|
|
description="End date of the data, in YYYY-MM-DD format."
|
|
),
|
|
] = None,
|
|
form_type: Annotated[
|
|
Optional[str],
|
|
OpenBBCustomParameter(
|
|
description="Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types."
|
|
),
|
|
] = None,
|
|
limit: Annotated[
|
|
int,
|
|
OpenBBCustomParameter(description="The number of data entries to return."),
|
|
] = 100,
|
|
provider: Optional[Literal["fmp"]] = None,
|
|
**kwargs
|
|
) -> OBBject:
|
|
"""Get the most-recent filings submitted to the SEC.
|
|
|
|
Parameters
|
|
----------
|
|
start_date : Optional[datetime.date]
|
|
Start date of the data, in YYYY-MM-DD format.
|
|
end_date : Optional[datetime.date]
|
|
End date of the data, in YYYY-MM-DD format.
|
|
form_type : Optional[str]
|
|
Filter by form type. Visit https://www.sec.gov/forms for a list of supported form types.
|
|
limit : int
|
|
The number of data entries to return.
|
|
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
|
|
no default.
|
|
is_done : Optional[bool]
|
|
Flag for whether or not the filing is done. (provider: fmp)
|
|
|
|
Returns
|
|
-------
|
|
OBBject
|
|
results : List[DiscoveryFilings]
|
|
Serializable results.
|
|
provider : Optional[Literal['fmp']]
|
|
Provider name.
|
|
warnings : Optional[List[Warning_]]
|
|
List of warnings.
|
|
chart : Optional[Chart]
|
|
Chart object.
|
|
extra: Dict[str, Any]
|
|
Extra info.
|
|
|
|
DiscoveryFilings
|
|
----------------
|
|
symbol : str
|
|
Symbol representing the entity requested in the data.
|
|
cik : str
|
|
Central Index Key (CIK) for the requested entity.
|
|
title : str
|
|
Title of the filing.
|
|
date : datetime
|
|
The date of the data.
|
|
form_type : str
|
|
The form type of the filing
|
|
link : str
|
|
URL to the filing page on the SEC site.
|
|
|
|
Example
|
|
-------
|
|
>>> from openbb import obb
|
|
>>> obb.equity.discovery.filings(limit=100)
|
|
""" # noqa: E501
|
|
|
|
return self._run(
|
|
"/equity/discovery/filings",
|
|
**filter_inputs(
|
|
provider_choices={
|
|
"provider": provider,
|
|
},
|
|
standard_params={
|
|
"start_date": start_date,
|
|
"end_date": end_date,
|
|
"form_type": form_type,
|
|
"limit": limit,
|
|
},
|
|
extra_params=kwargs,
|
|
)
|
|
)
|