Skip to main content

Scrape data from SEC's EDGAR

Project description

A small library to access files from SEC’s edgar.

Installation

pip install edgar

Example

To get a company’s latest 5 10-Ks, run

from edgar import Company
company = Company("Oracle Corp", "0001341439")
tree = company.get_all_filings(filing_type = "10-K")
docs = edgar.get_documents(tree, no_of_documents=5)

or

from edgar import Company, TXTML

company = Company("INTERNATIONAL BUSINESS MACHINES CORP", "0000051143")
doc = company.get_10K()
text = TXTML.parse_full_10K(doc)

To get all companies and find a specific one, run

from edgar import Edgar
edgar = Edgar()
possible_companies = edgar.find_company_name("Cisco System")

API

Company

The Company class has two fields:

  • name (company name)

  • cik (company CIK number)

get_filings_url

Returns a url to fetch filings data

  • Input

    • filing_type: The type of document you want. i.e. 10-K, S-8, 8-K. If not specified, it’ll return all documents

    • prior_to: Time prior which documents are to be retrieved. If not specified, it’ll return all documents

    • ownership: defaults to include. Options are include, exclude, only.

    • no_of_entries: defaults to 100. Returns the number of entries to be returned. Maximum is 100.

get_all_filings

Returns the HTML in the form of lxml.html

  • Input

    • filing_type: The type of document you want. i.e. 10-K, S-8, 8-K. If not specified, it’ll return all documents

    • prior_to: Time prior which documents are to be retrieved. If not specified, it’ll return all documents

    • ownership: defaults to include. Options are include, exclude, only.

    • no_of_entries: defaults to 100. Returns the number of entries to be returned. Maximum is 100.

Edgar

Gets all companies from EDGAR

get_cik_by_company_name

  • Input

    • name: name of the company

get_company_name_by_cik

  • Input

    • cik: cik of the company

find_company_name

  • Input

    • words: input words to search the company

get_documents

Returns a list of strings, each string contains the body of the specified document from input

  • Input

    • tree: lxml.html form that is returned from Company.getAllFilings

    • no_of_documents: number of document returned. If it is 1, the returned result is just one string, instead of a list of strings. Defaults to 1.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

edgar-4.0.0.tar.gz (4.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

edgar-4.0.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

Details for the file edgar-4.0.0.tar.gz.

File metadata

  • Download URL: edgar-4.0.0.tar.gz
  • Upload date:
  • Size: 4.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for edgar-4.0.0.tar.gz
Algorithm Hash digest
SHA256 dd4a65410113ce5870811058513d79230f02e632844b936b9ed1ae3d5bd60c34
MD5 db9433cd378fe7e1730b170669e06a55
BLAKE2b-256 e2498bee2dd764738522b7a6dcc41c6226a4b5229d8ed220db36be359189c724

See more details on using hashes here.

File details

Details for the file edgar-4.0.0-py3-none-any.whl.

File metadata

  • Download URL: edgar-4.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.40.0 CPython/3.6.8

File hashes

Hashes for edgar-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2b0ea63bc89d9cf6ffd2ae39d71e5edcaa3631ee2f9b3167a6751a7695e8fdaa
MD5 c48d17a2513e93147ddd05462c61e26e
BLAKE2b-256 a8ab2df76867296dd408e3bf1538e03ecb6d3d333db629dd3d81feeecfade176

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page