Parsing Filing Data
An SEC filing represents information a company wishes to make public. The information is sometimes contained in data files attached to the filing, such as XBRL, XML or JSON.
In edgartools each Filing has a .obj() function that converts the filing to a parsed version of the data file.
For example, the following code converts the filing for the 10-K for Apple Inc. to a TenK object containing the data from the filing:
from edgar import get_filings
filings = get_filings(form="10-K")
filing = filings[0]
tenk = filing.obj()
Under the hood, the .obj() function gets the data file for the filing, which is usually the filing's XML, parses it, and converts it to the approaptate data object.
If a filing has no corresponding data object, the .obj() function returns None
Filing types with data objects
The following table lists the filing types that have data objects:
| Filing type | Data object | Description |
|---|---|---|
| 10-K | TenK |
Annual report |
| 10-Q | TenQ |
Quarterly report |
| 8-K | EightK |
Current report |
| 144 | Form144 |
Insider trading report |
| 3,4,5 | Ownership |
Insider trading report |
| D | Effect |
Effect filing for the Form D |
| NPORT | NPORT |
Investment company report |
| 13F-HR | ThirteenF |
Institutional investment manager's report |
| Any other filing with XBRL | XbrlFiling |
XBRL filing object with the data |
Ownership Documents
Ownership documents are SEC forms that contain information about ownership of securities.
Ownership Forms
| Form | Description |
|---|---|
| 3 | Initial statement of beneficial ownership of securities |
| 4 | Statement of changes of beneficial ownership of securities |
| 5 | Annual statement of changes in beneficial ownership of securities |
The module edgar.ownership module parses XML into an OwnershipDocument instance,
containing data about transactions and holdings.
Getting Ownership Documents
- get a form 3, 4, or 5 filing
- get the xml document
- call
OwnershipDocument.from_xml()
from edgar import CompanyData
from edgar.ownership import Ownership
# Get Snowflake
company = CompanyData.for_ticker("SNOW")
# Get Form 4 filings for Snowflake
filings = company.get_filings(form="4")
# Get the first filing
filing = filings[0]
# Get the filing xml
xml = filing.xml()
# Now get the OwnershipDocument
ownership = Ownership.from_xml(xml)
Derivative Table
This contains data on derivative holdings and transactions. To access it call
ownership_document.derivatives.
Derivative Holdings
To access derivative transactions use ownership.derivatives.holdings
Derivative Transactions
To access derivative transactions use ownership.derivatives.transactions
You can access individual transaction using the [] notation.
ownership.derivative_table.transactions[0]
Non Derivative Table
This contains data on non-derivative holdings and transactions. To access it call
ownership_document.non_
derivatives.
Non Derivative Holdings
To access derivative holdings use ownership.non_derivatives.holdings
You can access individual holdings using the [] notation.
holding = ownership.non_derivative_table.holdings[0]
holding
Non Derivative Transactions
To access derivative transactions use ownership.non_derivatives.transactions
You can access individual transactions using the [] notation.
transaction = ownership.non_derivative_table.transactions[0]
transaction