jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-28 21:12:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
b9b79a205c81dcb3d0e9bb64dabebe1ec0a339bc
OpenBB/openbb_platform/openbb/package/regulators_sec.py
Danglewood b9b79a205c static assets
2025-03-31 15:32:16 -07:00

614 lines
20 KiB
Python
Raw Blame History

### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ###
from typing import Literal, Optional
from openbb_core.app.model.field import OpenBBField
from openbb_core.app.model.obbject import OBBject
from openbb_core.app.static.container import Container
from openbb_core.app.static.utils.decorators import exception_handler, validate
from openbb_core.app.static.utils.filters import filter_inputs
from typing_extensions import Annotated
class ROUTER_regulators_sec(Container):
"""/regulators/sec
cik_map
filing_headers
htm_file
institutions_search
rss_litigation
schema_files
sic_search
symbol_map
"""
def __repr__(self) -> str:
return self.__doc__ or ""
@exception_handler
@validate
def cik_map(
self,
symbol: Annotated[str, OpenBBField(description="Symbol to get data for.")],
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Map a ticker symbol to a CIK number.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
symbol : str
Symbol to get data for.
use_cache : Optional[bool]
Whether or not to use cache for the request, default is True. (provider: sec)
Returns
-------
OBBject
results : CikMap
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
CikMap
------
cik : Optional[Union[int, str]]
Central Index Key (CIK) for the requested entity.
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.cik_map(symbol='MSFT', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/cik_map",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.cik_map",
("sec",),
)
},
standard_params={
"symbol": symbol,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def filing_headers(
self,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Download the index headers, and cover page if available, for any SEC filing.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
url : str
URL for the SEC filing. The specific URL is not directly used or downloaded, but is used to generate the base URL for the filing. e.g. https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/coke-20240731.htm and https://www.sec.gov/Archives/edgar/data/317540/000031754024000045/ are both valid URLs for the same filing. (provider: sec)
use_cache : bool
Use cache for the index headers and cover page. Default is True. (provider: sec)
Returns
-------
OBBject
results : SecFiling
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SecFiling
---------
base_url : Optional[str]
Base URL of the filing. (provider: sec)
name : Optional[str]
Name of the entity filing. (provider: sec)
cik : Optional[str]
Central Index Key. (provider: sec)
trading_symbols : Optional[list]
Trading symbols, if available. (provider: sec)
sic : Optional[str]
Standard Industrial Classification. (provider: sec)
sic_organization_name : Optional[str]
SIC Organization Name. (provider: sec)
filing_date : Optional[date]
Filing date. (provider: sec)
period_ending : Optional[date]
Date of the ending period for the filing, if available. (provider: sec)
fiscal_year_end : Optional[str]
Fiscal year end of the entity, if available. Format: MM-DD (provider: sec)
document_type : Optional[str]
Specific SEC filing type. (provider: sec)
has_cover_page : Optional[bool]
True if the filing has a cover page. (provider: sec)
description : Optional[str]
Description of attached content, mostly applicable to 8-K filings. (provider: sec)
cover_page : Optional[dict]
Cover page information, if available. (provider: sec)
document_urls : Optional[list]
list of files associated with the filing. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.filing_headers(url='https://www.sec.gov/Archives/edgar/data/317540/000119312524076556/d645509ddef14a.htm', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/filing_headers",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.filing_headers",
("sec",),
)
},
standard_params={},
extra_params=kwargs,
info={"url": {"sec": {"x-widget_config": {"label": "Filing URL"}}}},
)
)
@exception_handler
@validate
def htm_file(
self,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Download a raw HTML object from the SEC website.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
url : str
URL for the SEC filing. (provider: sec)
use_cache : bool
Cache the file for use later. Default is True. (provider: sec)
Returns
-------
OBBject
results : SecHtmFile
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SecHtmFile
----------
url : Optional[str]
URL of the downloaded file. (provider: sec)
content : Optional[str]
Raw content of the HTM/HTML file. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.htm_file(url='https://www.sec.gov/Archives/edgar/data/1723690/000119312525030074/d866336dex991.htm', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/htm_file",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.htm_file",
("sec",),
)
},
standard_params={},
extra_params=kwargs,
)
)
@exception_handler
@validate
def institutions_search(
self,
query: Annotated[str, OpenBBField(description="Search query.")] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Search SEC-regulated institutions by name and return a list of results with CIK numbers.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
use_cache : Optional[bool]
Whether or not to use cache. (provider: sec)
Returns
-------
OBBject
results : list[InstitutionsSearch]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
InstitutionsSearch
------------------
name : Optional[str]
The name of the institution. (provider: sec)
cik : Optional[Union[int, str]]
Central Index Key (CIK) (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.institutions_search(provider='sec')
>>> obb.regulators.sec.institutions_search(query='blackstone real estate', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/institutions_search",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.institutions_search",
("sec",),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def rss_litigation(
self,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Get the RSS feed that provides links to litigation releases concerning civil lawsuits brought by the Commission in federal court.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
Returns
-------
OBBject
results : list[RssLitigation]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
RssLitigation
-------------
published : Optional[datetime]
The date of publication. (provider: sec)
title : Optional[str]
The title of the release. (provider: sec)
summary : Optional[str]
Short summary of the release. (provider: sec)
id : Optional[str]
The identifier associated with the release. (provider: sec)
link : Optional[str]
URL to the release. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.rss_litigation(provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/rss_litigation",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.rss_litigation",
("sec",),
)
},
standard_params={},
extra_params=kwargs,
)
)
@exception_handler
@validate
def schema_files(
self,
query: Annotated[str, OpenBBField(description="Search query.")] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Use tool for navigating the directory of SEC XML schema files by year.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
url : Optional[str]
Enter an optional URL path to fetch the next level. (provider: sec)
use_cache : Optional[bool]
Whether or not to use cache. (provider: sec)
Returns
-------
OBBject
results : SchemaFiles
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SchemaFiles
-----------
files : Optional[list[str]]
Dictionary of URLs to SEC Schema Files (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.schema_files(provider='sec')
>>> # Get a list of schema files.
>>> data = obb.regulators.sec.schema_files().results
>>> data.files[0]
>>> 'https://xbrl.fasb.org/us-gaap/'
>>> # The directory structure can be navigated by constructing a URL from the 'results' list.
>>> url = data.files[0]+data.files[-1]
>>> # The URL base will always be the 0 position in the list, feed the URL back in as a parameter.
>>> obb.regulators.sec.schema_files(url=url).results.files
>>> ['https://xbrl.fasb.org/us-gaap/2024/'
>>> 'USGAAP2024Filelist.xml'
>>> 'dis/'
>>> 'dqcrules/'
>>> 'ebp/'
>>> 'elts/'
>>> 'entire/'
>>> 'meta/'
>>> 'stm/'
>>> 'us-gaap-2024.zip']
""" # noqa: E501
return self._run(
"/regulators/sec/schema_files",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.schema_files",
("sec",),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def sic_search(
self,
query: Annotated[str, OpenBBField(description="Search query.")] = "",
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Search for Industry Titles, Reporting Office, and SIC Codes. An empty query string returns all results.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
use_cache : Optional[bool]
Whether or not to use cache. (provider: sec)
Returns
-------
OBBject
results : list[SicSearch]
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SicSearch
---------
sic : Optional[int]
Sector Industrial Code (SIC) (provider: sec)
industry : Optional[str]
Industry title. (provider: sec)
office : Optional[str]
Reporting office within the Corporate Finance Office (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.sic_search(provider='sec')
>>> obb.regulators.sec.sic_search(query='real estate investment trusts', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/sic_search",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.sic_search",
("sec",),
)
},
standard_params={
"query": query,
},
extra_params=kwargs,
)
)
@exception_handler
@validate
def symbol_map(
self,
query: Annotated[str, OpenBBField(description="Search query.")],
use_cache: Annotated[
Optional[bool],
OpenBBField(
description="Whether or not to use cache. If True, cache will store for seven days."
),
] = True,
provider: Annotated[
Optional[Literal["sec"]],
OpenBBField(
description="The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec."
),
] = None,
**kwargs
) -> OBBject:
"""Map a CIK number to a ticker symbol, leading 0s can be omitted or included.
Parameters
----------
provider : str
The provider to use, by default None. If None, the priority list configured in the settings is used. Default priority: sec.
query : str
Search query.
use_cache : Optional[bool]
Whether or not to use cache. If True, cache will store for seven days.
Returns
-------
OBBject
results : SymbolMap
Serializable results.
provider : Optional[str]
Provider name.
warnings : Optional[list[Warning_]]
list of warnings.
chart : Optional[Chart]
Chart object.
extra : Dict[str, Any]
Extra info.
SymbolMap
---------
symbol : Optional[str]
Symbol representing the entity requested in the data. (provider: sec)
Examples
--------
>>> from openbb import obb
>>> obb.regulators.sec.symbol_map(query='0000789019', provider='sec')
""" # noqa: E501
return self._run(
"/regulators/sec/symbol_map",
**filter_inputs(
provider_choices={
"provider": self._get_provider(
provider,
"regulators.sec.symbol_map",
("sec",),
)
},
standard_params={
"query": query,
"use_cache": use_cache,
},
extra_params=kwargs,
)
)
Reference in New Issue View Git Blame Copy Permalink