{"id":28149671,"url":"https://github.com/piquette/edgr","last_synced_at":"2025-05-15T02:14:14.006Z","repository":{"id":57510687,"uuid":"221373570","full_name":"piquette/edgr","owner":"piquette","description":"A set of tools for dealing with SEC EDGAR corporate filings","archived":false,"fork":false,"pushed_at":"2019-11-18T03:15:28.000Z","size":940,"stargazers_count":23,"open_issues_count":2,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-19T04:13:47.467Z","etag":null,"topics":["api","cli-app","data-analysis","data-mining","edgar-database","edgar-scraper","finance","financial-analysis","sec-edgar","sec-filings"],"latest_commit_sha":null,"homepage":"https://piquette.io/projects/edgr","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/piquette.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-11-13T04:37:55.000Z","updated_at":"2024-05-26T19:27:07.000Z","dependencies_parsed_at":"2022-09-26T17:50:49.840Z","dependency_job_id":null,"html_url":"https://github.com/piquette/edgr","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piquette%2Fedgr","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piquette%2Fedgr/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piquette%2Fedgr/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/piquette%2Fedgr/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/piquette","download_url":"https://codeload.github.com/piquette/edgr/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254259430,"owners_count":22040822,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","cli-app","data-analysis","data-mining","edgar-database","edgar-scraper","finance","financial-analysis","sec-edgar","sec-filings"],"created_at":"2025-05-15T02:14:13.347Z","updated_at":"2025-05-15T02:14:13.987Z","avatar_url":"https://github.com/piquette.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# edgr | Makes SEC filings not terrible\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/piquette/edgr)](https://goreportcard.com/badge/github.com/piquette/edgr)\n[![Build Status](https://travis-ci.org/piquette/edgr.svg?branch=master)](https://travis-ci.org/piquette/edgr)\n[![GoDoc](https://godoc.org/github.com/piquette/edgr?status.svg)](https://godoc.org/github.com/piquette/qtrn)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n\nThis project consists of:\n* `edgr` - a cli tool that can populate a postgres db with SEC filings for use in data analysis projects\n* `github.com/edgr/core` a go module that requests SEC filers/filings and can be used in other go projects\n\n\n## edgr CLI\nThe `edgr` tool makes jumpstarting your data analysis projects that much easier by abstacting away a lot of annoying SEC EDGAR data gathering and parsing. `edgr` can download, parse full text, and persist large quantities of SEC filings in a pre-configured postgres db.\n\n### Installation\n`edgr` supports macOS, linux, and windows systems.\n\n#### Brew\nThe preferred way to install, run the following commands in the terminal after installing homebrew\n```sh\nbrew tap piquette/edgr\nbrew install edgr\n```\n#### Download the binary\nDistributions for your specific OS can be found on the releases page for this repo.\n\n#### Build from source\nClone this repository and run `make build`\n\n### Usage\n`edgr` is a standard cli executable. A running/reachable postgres instance is required for proper usage. You can easily run one locally through docker.\n```sh\ndocker run -p 5432:5432 -d postgres:9.6\n```\nThe default parameters for `edgr` commands will be able to access this instance immediately.\nNext, we need to set up the proper db tables to store data. In the terminal, run \n```sh\nedgr init\n```\nFinally, we need to insert some desired filers into the db so we can pull some filings.\n```sh\n# add the filer.\nedgr filers init --symbol AAPL\n# download 8-K filings for apple inc.\nedgr get --symbol AAPL --form 8-K\n```\nNow you can access the raw text and meta-data associated with those filings in the database as you normally would, through other analytical tools or a command-line pg client. Run `edgr help` for more information regarding commands.\n\n## `github.com/edgr/core` module\n\n### Installation\nSupports Go v1.13+ and modules. Run the usual\n```sh\ngo get -u github.com/piquette/edgr\n```\n\n### Usage\nThere are 3 easy functions\n```go\n// GetPublicCompanies returns a list of public companies.\nfunc GetPublicCompanies() ([]Company, error) {...}\n\n// GetFiler gets a single filer from the SEC website based on symbol.\nfunc GetFiler(symbol string) (filer *model.Filer, err error) {...}\n\n// GetFilings gets a list of filings for a single CIK.\nfunc GetFilings(cik, formtype, stoptime string) (filings []SECFiling, err error) {...}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiquette%2Fedgr","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpiquette%2Fedgr","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpiquette%2Fedgr/lists"}