Skip to content

FindingThings

Jump to bottom
Dwight Gunning edited this page Jul 30, 2024 · 4 revisions

Finding Things with edgartools

This guide provides examples of how to use the find function to locate filings, entities, companies, funds, and other types of SEC data.

The find Function

The find function is a versatile search tool that can handle various types of input and return appropriate objects. It's designed to be a one-stop solution for finding different types of SEC data.

Function Signature

def find(search_id: Union[str, int]) -> Union[Filing, EntityData, CompanySearchResults, Fund, FundClass, FundSeries]:

Description

This function can take a variety of search identifiers and return the appropriate object based on the input:

  • Accession number: Returns a Filing object
  • CIK: Returns an Entity object
  • Class/Contract ID: Returns a FundClass object
  • Series ID: Returns a FundSeries object
  • Ticker: Returns a Company or a Fund object if the ticker is a fund ticker
  • Company name: Returns CompanySearchResults object

Code Examples

Finding by Accession Number

If you know the accession number of the filing you're looking for, you can use the find function to retrieve the filing object. This works for any filing going back to 1993.

# Find by accession number
filing = find("0000123456-22-123456")

Find a company or person by CIK

If you know the CIK (Central Index Key) of a company or person, you can use the find function to retrieve the entity object. This takes the cik as a number or a string representation of the number.

0000320193, "320193", 320193 works equally well for Apple Inc.

apple = find(320193)

Apple by CIK

Find a company by ticker

You can also find a company by its ticker symbol. This works by using the ticker to do a cik lookup, then it finds the company by cik.

company = find("AAPL")

Find by company name

You can search for a company by its name. This returns a list of companies that match the search term. The search term is case-insensitive and can be a partial match on the ticker or company name.

search_results = find("Biomedical")

Biomedical

After you get the results you can get the company by the index of the search results.

company = search_results[0]

Finding Filings

Related Filings

Explanation Code example (to be added)

Filtering Filings

By Date

Filtering before a specific date

Filtering after a specific date

Filtering between two dates

Code examples (to be added)

By Company

Filtering by ticker Filtering by CIK Code examples (to be added)

By Form Type

Explanation (e.g., filtering 8-K forms) Code example (to be added)

By Company Name

Explanation (e.g., filtering companies with 'Medical' in the name) Code example (to be added)

Advanced Usage

Combining multiple filters

Best practices

Tips and tricks

Conclusion

Recap of key features Encouragement to explore and use the library

Clone this wiki locally