full_text_search
Search the full text of all SEC EDGAR filings since 2001.
Examples
from openbb import obb
obb.sec.full_text_search(query='climate change', provider='sec')
obb.sec.full_text_search(entity='AAPL', form_type='10-K', provider='sec')
Parameters
- standard
- sec
query: str | None
Words or phrases to find in filing documents. Use quotes for an exact phrase, OR / NOT (or -) for boolean logic, and * for a trailing wildcard.
entity: str | None
Company name, ticker, CIK number, or individual's name.
category: str | None
Filing category to filter by - a preset group of form types.
form_type: str | None | list[str | None]
Specific form type(s) to filter by, comma-separated. Prefix a form type with a hyphen to exclude it - e.g., -4 excludes Form 4. Multiple items allowed.
location: str | None
Location code of the principal executive offices to filter by.
start_date: date | None | str
Start date of the data, in YYYY-MM-DD format. The earliest available date is 2001-01-01.
end_date: date | None | str
End date of the data, in YYYY-MM-DD format.
limit: int | None
Default: 100
The number of data entries to return.
Returns
results: SecFullTextSearch
Serializable results.
provider: str | None
Provider name.
warnings: Optional[list[Warning_]]
List of warnings.
chart: Optional[Chart]
Chart object.
extra: dict[str, Any]
Extra info.
Data
- standard
- sec
filing_date: date | None
Date the filing was submitted.
form: str | None
The SEC form type.
name: str | None
Name of the filer(s).
symbol: str | None
Ticker symbol(s) of the filer.
cik: str | None
Central Index Key(s) of the filer.
description: str | None
Filing or document description.
url: str
URL of the matched document on SEC EDGAR.