Skip to main content

A client library for collecting and scraping SEC filings.

Project description

Python SEC

Table of Contents

Overview

Current Version: 0.1.1

The Securities & Exchange Commission (SEC) has a treasure trove of business data available to indviduals for free. However, the biggest obstacle to getting this free data boils down to two challenges:

  1. Figuring out where it is
  2. Figuring out how to extract it

The Python SEC library (pysec) is designed to make the collection and the extraction of SEC data quick and effortless. The library was designed around some of the following goals:

  1. Making the usage of the EDGAR search system, in a prgorammatic fashion, more intuitive.
  2. Making the definition of queries more customizeable while still maintaining the overall clearity of the library.
  3. Standardize the returning content so that content is organized consistently and ensuring gaps in data are filled in or extended that way navigating to other directories or files can be done dynamically.
  4. Simplify the parsing of XBRL files so that data can be more easily manipulated.

Setup

Setup - PyPi Install:

To install the library, run the following command from the terminal.

pip install python-sec

Setup - PyPi Upgrade:

To upgrade the library, run the following command from the terminal.

pip install --upgrade python-sec

Setup - Local Install:

If you are planning to make modifications to this project or you would like to access it before it has been indexed on PyPi. I would recommend you either install this project in editable mode or do a local install. For those of you, who want to make modifications to this project. I would recommend you install the library in editable mode.

If you want to install the library in editable mode, make sure to run the setup.py file, so you can install any dependencies you may need. To run the setup.py file, run the following command in your terminal.

pip install -e .

If you don't plan to make any modifications to the project but still want to use it across your different projects, then do a local install.

pip install .

This will install all the dependencies listed in the setup.py file. Once done you can use the library wherever you want.

Usage

Here is a simple example of using the pysec library to grab the index files for specific quarter.

import pprint
from pysec.edgar import EDGARQuery

# Initialize the client.
edgar_client = EDGARQuery()

# Grab a specific Quarterly Archive Indexes.
quarterly_archives = edgar_client.get_quarterly_index(year=2000, quarter=4)
pprint.pprint(quarterly_archives)

You will note the output of the above code would look like the following:

[
  {
    "href": "company.gz",
    "last_modified": "09/06/2014 01:08:55 AM",
    "name": "company.gz",
    "size": "1287 KB",
    "type": "file",
    "url": "https://www.sec.gov/Archives/edgar/full-index/2000/QTR4/company.gz"
  },
  {
    "href": "company.idx",
    "last_modified": "09/06/2014 01:08:53 AM",
    "name": "company.idx",
    "size": "10625 KB",
    "type": "file",
    "url": "https://www.sec.gov/Archives/edgar/full-index/2000/QTR4/company.idx"
  }
]

Support these Projects

Patreon: Help support this project and future projects by donating to my Patreon Page. I"m always looking to add more content for individuals like yourself, unfortuantely some of the APIs I would require me to pay monthly fees.

YouTube: If you"d like to watch more of my content, feel free to visit my YouTube channel Sigma Coding.

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

python-sec-0.1.1.tar.gz (24.8 kB view hashes)

Uploaded source

Built Distribution

python_sec-0.1.1-py3-none-any.whl (29.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page