Giter VIP home page Giter VIP logo

secdata's Introduction

secdata : All Data reported to the Securities and Exchange Commission

About

A module to easily Download Financial Data reported to the Securities and Exchange Commision (SEC).

It deploys SEC's RESTful APIs, which delivers JSON-formatted data without requiring authentication or API keys.

Currently included in the APIs are the submissions history by filer and the XBRL data from financial statements (forms 10-Q, 10-K,8-K, 20-F, 40-F, 6-K, and their variants).

The JSON structures are updated throughout the day, in real time, as submissions are disseminated.

More info about the APIs can be found here

Installation

Binary installers are available at PyPI (Python Package Index) .

pip install secdata

For a manual installation, source code is hosted on Github.

Methods

  • fetch_companies_info(return_dataframe = False , file_if_info_already_downloaded = "companiesinfo.csv") :

    Sets the sec_companies_info property, Which is a table containing:

    • CIK (Central Index Key)
    • Ticker (AAPL, MSFT, TSLA, etc.) and
    • Name (Apple Inc., MICROSOFT CORP, Tesla, etc) .

    for each company reporting to the SEC

    From that table one can find CIKs of interest in order to use them in the fetch_facts() method

  • fetch_facts(ciks) : All Sec Facts (e.g. Assets, Depreciation, Net Income, Number of Shares) available for the companies of which the ciks are provided

Example

#Import Class
from secdata import SecFactsDownloader

#Initiate Downloader
my_downloader = SecFactsDownloader("my_email@my_domain.com")

#Download Central Index Key per company
#To find CIKs of interest
my_downloader.fetch_companies_info()


#320193 for Apple, 789019 for Microsoft, 1652044 for Google
df_1 = my_downloader.fetch_facts([320193, 789019, 1652044])

#1318605 for Tesla, 37996 for Ford
df_2 = my_downloader.fetch_facts([1318605, 37996])

secdata's People

Contributors

voulkon avatar natnaelab avatar

Stargazers

Balayogi M avatar Emerson Maurício de Oliveira avatar Lucas Rocha avatar

Watchers

 avatar

Forkers

skalarfeilds79

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.