diff --git a/README.md b/README.md index 34ad92f..49c9a42 100644 --- a/README.md +++ b/README.md @@ -289,7 +289,7 @@ attachment = filing.attachments[0] You can download the attachment using `attachment.download()`. This will download the attachment to string or bytes in memory. -## Automatic parsing of filing data +## Data Objects Now the reason you may want to download attachments is to get information contained in data files. For example, **13F-HR** filings have attached infotable.xml files containing data from the holding report for that filing. @@ -384,6 +384,25 @@ Each of the financial statements - `BalanceSheet`, `IncomeStatement` and `CashFl balance_sheet_df = financials.get_balance_sheet().get_dataframe() ``` + +## TenK (10-K) Data Object + +For 10-K filngs the 10-K Data Object allows you to access almost any data related to the filing - both text and financial data. + +```python +c = Company("ORCL") +filing = c.get_filings(form="10-K").latest() +tenk = filing.obj() +``` + +You can also get it directly using the property `latest_tenk` on the `Company` object. + +```python +c = Company("ORCL") +c.latest_tenk +``` +![10K Data Object](docs/images/orcl-tenk.png) + ## Downloading Edgar Data The library is designed to make real time calls to EDGAR to get the latest data. However, you may want to download data for offline use or to build a dataset. diff --git a/docs/images/orcl-tenk.png b/docs/images/orcl-tenk.png new file mode 100644 index 0000000..86cef40 Binary files /dev/null and b/docs/images/orcl-tenk.png differ