https://github.com/rozap/edgarex

elixir interface for fetching SEC filings from EDGAR
https://github.com/rozap/edgarex

Last synced: 2 months ago
JSON representation

elixir interface for fetching SEC filings from EDGAR

• Host: GitHub
• URL: https://github.com/rozap/edgarex
• Owner: rozap
• License: mit
• Created: 2015-02-10T00:18:21.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-03-01T06:55:38.000Z (almost 10 years ago)
• Last Synced: 2024-10-13T06:20:57.069Z (3 months ago)
• Language: Elixir
• Size: 5.02 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - Elixir interface for fetching SEC filings from EDGAR. (Third Party APIs)
• fucking-awesome-elixir - edgarex - Elixir interface for fetching SEC filings from EDGAR. (Third Party APIs)
• awesome-elixir - edgarex - Elixir interface for fetching SEC filings from EDGAR. (Third Party APIs)

README

        
Edgarex

=======

#### Fetching an index

```elixir

alias Edgarex.Fetcher

#get the first 50 records in `crawler.idx` for 2014, quarter 4.

#note that this is a stream, and will only download the chunks 

#from the ftp server that you need. As a result, Enum.take(stream, 50)

#will complete much faster than Enum.into([]), which will exhaust the stream

some_items = Fetcher.crawler(2014, 4) |> Enum.take(50)

#An item in `some_items` might look like

%{

	cik: "1623034", 

	company_name: "101 Sheridan Apartments, LLC",

	date_filed: "2014-10-30", 

	form_type: "D",

	url: "http://www.sec.gov/Archives/edgar/data/1623034/0001623034-14-000001-index.htm"

}

#similarly, you can get other indexes, which look similar

#get the `form.idx` for 2014, quarter 4

Fetcher.form(2014, 4)

#get the `xbrl.idx` for 2014, quarter 4

Fetcher.xbrl(2014, 4)

#get the `master.idx` for 2014, quarter 4

Fetcher.master(2014, 4)

```