filing_headers
Download the index headers, and cover page if available, for any SEC filing.
Examples
from openbb import obb
obb.regulators.sec.filing_headers(url=https://www.sec.gov/Archives/edgar/data/317540/000119312524076556/d645509ddef14a.htm, provider='sec')
Parameters
- standard
- 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.
• Optional: True
use_cache: bool
Use cache for the index headers and cover page. Default is True.
• Default: True
• Optional: True
Returns
results: list[SecFiling]
Serializable results.
provider: Optional[Literal['sec']]
Provider name.
warnings: Optional[list[Warning_]]
list of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- sec
base_url: str
Base URL of the filing.
name: str
Name of the entity filing.
cik: str
Central Index Key.
trading_symbols: list
Trading symbols, if available.
sic: str
Standard Industrial Classification.
sic_organization_name: str
SIC Organization Name.
filing_date: date
Filing date.
period_ending: date
Date of the ending period for the filing, if available.
fiscal_year_end: str
Fiscal year end of the entity, if available. Format: MM-DD
document_type: str
Specific SEC filing type.
has_cover_page: bool
True if the filing has a cover page.
description: str
Description of attached content, mostly applicable to 8-K filings.
cover_page: dict
Cover page information, if available.
document_urls: list
list of files associated with the filing.