Skip to content

Commit

Permalink
Add section on TenK in the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dgunning committed Nov 12, 2024
1 parent 0a5e0ea commit cf5c704
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Binary file added docs/images/orcl-tenk.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit cf5c704

Please sign in to comment.