Skip to content

Latest commit

 

History

History
187 lines (116 loc) · 8.89 KB

README.MD

File metadata and controls

187 lines (116 loc) · 8.89 KB
Raw

Project-Three

SEC Finance Data ( Data Engineering )

Overview

For this project we researched financial records provided by the SEC. The records detail a variety of elements: revenue, gross profit, operating and net income loss, research and development expense, selling and marketing expense, share based and allocated share based expense depreciation, cost and expenses, general and administrative expense interest expense, lease and rental expense, marketing and advertising expense, accrued liabilities, entity common stock shares, and entity public float. We looked at records for a numerous companies and decided to present our findings using the data engineering route. We conducted an analysis of the records provided by the SEC in Jupyter Notebook and were able to extract data to import onto MongoDB.

Key Terms

  • S&P 500 - The Standard and Poor's 500, or simply the S&P 500, is a stock market index tracking the stock performance of 500 of the largest companies listed on stock exchanges in the United States.

  • SEC - The U.S. Securities and Exchange Commission is an independent agency of the United States federal government, created in the aftermath of the Wall Street Crash of 1929. The primary purpose of the SEC is to enforce the law against market manipulation.

  • EDGAR - Electronic Data Gathering, Analysis, and Retrieval is an internal database system that performs automated collection, validation, indexing, accepted forwarding of submissions by companies and others who are required by law to file forms with the U.S. Securities and Exchange Commission.

  • CIK - Central Index Key - Unique key that identifies a company in SEC Database

  • SEC Form 8K - Current Report - It is the report that companies must file with the SEC to announce major events that shareholders should know about.

  • SEC Form 10Q - Quarterly Report - It is a comprehensive quarterly report of financial performance submitted by all public companies to the SEC.

  • SEC Form 10K - Annual Report - It is a comprehensive report filed annually by a publicly-traded company about its financial performance.

  • SEC Form 10Q A - Quarterly Report Amendment.

  • SEC Form 10K A - Annual Report Amendment.

Ethical Consideration

  • SEC is making data available to the public and anyone is free to use it. The limitations for accessing the data in an automated way are the restriction of making 10 requests in 1 second and the HTTP request header should provide a valid email ID and host info.

  • The trasformation done to the data as part of this project doesn't alter finance details of a company in any way. There are no ethical concerns to be addressed.

Source Data

  1. Details of compaines included in the S&P 500 index - https://en.wikipedia.org/wiki/List_of_S%26P_500_companies
  • Screenshot of S&P 500 companies listed in the Wikipedia page
  • Image Info
  1. Finance data of companies as reported to SEC - https://data.sec.gov/api/xbrl/companyfacts/CIK0001701605.json
  • Sample data format of finance data as recevied from SEC Data API
  • Image Info

Database Design

  • MongoDB was selected for loading the final dataset. The primary reasons for selecting MongoDB database are
    • Schema changes can be acomplished easily in the future
    • End user is going to be served with JSON documents, the same format in which the data is saved in the database.

Image Info

ETL

Extract

headers = { 'User-Agent' : email_id, 'Host' : 'data.sec.gov' }

Transform

  • The data for the following forms are considered for transformation:

    • 8K, 10Q, 10K, 10Q/A, 10K/A

  • There are multiple filings found in the data for the same reporting period. The latest filings are only kept to reflect the most recently updated information.\

  • The reporting period is extracted based on 'start' and 'end' period provided in each filing. The annual filings are identified as quarter 0 (zero) and quartetly filings are identified as 1 thru 4 depending on the reporting quarter.

Load

  • The JSON data is constructed based on the database design. The data is loaded into MongoDB database using 'mongoimport' command

API

Company API

Company API provides endpoint to query company collection. Following routes are available:

  • /api/v1.0/company/all - Retrieve data on all the companies present in the collection
  • /api/v1.0/company/ticker/ - Look up company data by ticker symbol
  • /api/v1.0/company/name/ - Look up company data by name
  • /api/v1.0/company/sector/ - Look up companies by sector
  • /api/v1.0/company/subindustry/ - Look up companies by sub industry
  • /api/v1.0/company/hqlocation/ - Look up companies by Headquarters Location
  • /api/v1.0/company/cik/ - Look up company data by CIK ID

Finance API

Finance API provides endpoint to query finance collection. Following route is available:

  • api/v1.0/finance/query - Retrieve finance data based on the query input

    • Here is a sample finance query that pulls 'NetIncomeLoss' data for year 2023 for CIKs 1551152 & 4977

    • sample_finance_query = { "finance_data_query" : { "dataType" : ["NetIncomeLoss"], "qtr" : 0, "year" : 2023, "cik" : [1551152, 4977] } }

  • Queries on following DataTypes are currently supported - 'Revenues', 'SalesRevenueGoodsNet', 'SalesRevenueServicesNet', 'RevenueFromContractWithCustomerIncludingAssessedTax', 'RevenueFromContractWithCustomerExcludingAssessedTax', 'GrossProfit', 'OperatingIncomeLoss', 'NetIncomeLoss', 'ResearchAndDevelopmentExpense', 'SellingAndMarketingExpense', 'ShareBasedCompensation', 'Depreciation', 'AllocatedShareBasedCompensationExpense', 'CostsAndExpenses', 'GeneralAndAdministrativeExpense', 'InterestExpense', 'LeaseAndRentalExpense', 'MarketingAndAdvertisingExpense', 'OtherAccruedLiabilitiesCurrent', 'EntityCommonStockSharesOutstanding', 'EntityPublicFloat'.

MongoDB Atlas

MongoDB Atlas is a cloud offering of MongoDB database. In addition to providing managed MongoDB instance, there is a Charts feature which can used to create charts based on the data available in MongoDB database.

Files

Project Proposal

  • ./project\ proposal/SEC Finance_Project3.pdf

DB Design

  • File saved from https://studio.hackolade.com ./design/FinanceDB_MongoDB_Model.hck.json

  • Database Documentation - ./design/FinanceDB_Design.pdf, ./design/Database_Design.png

Source

  • Jupyter Notebook used for analysing SEC Data

    • source/analysis/SECFinanceData_Analysis.ipynb

  • Jupyter Notebook used for extracting list of S&P 500 companies

    • source/SP500/SP500Info.ipynb

  • Jupyter Notebook used for ETL of SEC finance data

    • source/etl/SECFinanceData_ETL.ipynb

  • Python files for API

    • source/api/company_api.py
    • source/api/finance_api.py

  • Postman scripts for testing API

    • source/api/postman-tests/Project-3.postman_collection.json

Data

  • Input Data -

    • ./data/Input/Sp500.csv

  • Output Data -

    • ./data/output/finance_data.json
    • ./data/output/company_data.json

Run Instructions

  • Open SP500Info.ipynb file using Jupyter Notebook

    • Click on 'Cell > Run All' to run
    • This will create S&P 500 csv file under 'data/input' folder

  • Open SECFinanceData_ETL.ipynb file using Jupyter Notebook

    • Click on 'Cell > Run All' to run
    • This will create output files under 'data/output' folder

  • Data files to be loaded into the MongoDB database are under the directory - data/output

  • Use below commands to import collections to the MongoDB database

    • mongoimport --type json -d FinanceDB -c companies --drop --jsonArray company_data.json
    • mongoimport --type json -d FinanceDB -c finance --drop --jsonArray finance_data.json

  • Open 2 terminals to run API endpoints. The source is located under 'source/api'

    • python company_api.py
    • python finance_api.py

  • Use Postman tool to test the API. Import postman test scripts located under 'source/api/postman-tests' to run the tests.

References: