Liking cljdoc? Tell your friends :D

edgar.filings


full-index-urlclj

(full-index-url year quarter type)

Build the URL for a quarterly full-index file. type : "company" | "form" | "crawler" | "master"

Build the URL for a quarterly full-index file.
type : "company" | "form" | "crawler" | "master"
sourceraw docstring

get-daily-filingsclj

(get-daily-filings date & {:keys [form filter-fn]})

Return a seq of all filings the SEC disseminated on a given date, built from the EDGAR daily master index — complete, one map per filing.

date — a java.time.LocalDate, or a "YYYY-MM-DD" string Options: :form — keep only this exact form type ("8-K" excludes "8-K/A") :filter-fn — an arbitrary predicate applied to each result map

Returns an empty seq for dates without an index: weekends, holidays, future dates, and the current day until the SEC publishes its index (around 10 pm ET).

Each result map has: :accessionNumber — dashed accession number :form — form type string :filingDate — "YYYY-MM-DD" (the requested date; 1990s indexes also list late-disseminated filings) :cik — zero-padded 10-digit CIK of the first listed filer :companyName — that filer's name :filers — every filer as {:cik :name}, e.g. the issuer and the reporting owner of a Form 4

The maps carry :cik and :accessionNumber, so they work directly with e/html, e/text, e/items, e/obj, e/exhibits etc. (the primary document is resolved from the filing index on first use). The index names neither the primary document nor the filer roles: call e/filing-by-accession for :primaryDocument, :url and role-resolved :filers.

Return a seq of all filings the SEC disseminated on a given date, built
from the EDGAR daily master index — complete, one map per filing.

date — a java.time.LocalDate, or a "YYYY-MM-DD" string
Options:
  :form      — keep only this exact form type ("8-K" excludes "8-K/A")
  :filter-fn — an arbitrary predicate applied to each result map

Returns an empty seq for dates without an index: weekends, holidays,
future dates, and the current day until the SEC publishes its index
(around 10 pm ET).

Each result map has:
  :accessionNumber — dashed accession number
  :form            — form type string
  :filingDate      — "YYYY-MM-DD" (the requested date; 1990s indexes
                     also list late-disseminated filings)
  :cik             — zero-padded 10-digit CIK of the first listed filer
  :companyName     — that filer's name
  :filers          — every filer as {:cik :name}, e.g. the issuer and
                     the reporting owner of a Form 4

The maps carry :cik and :accessionNumber, so they work directly with
e/html, e/text, e/items, e/obj, e/exhibits etc. (the primary document is
resolved from the filing index on first use). The index names neither
the primary document nor the filer roles: call e/filing-by-accession for
:primaryDocument, :url and role-resolved :filers.
sourceraw docstring

get-filingsclj

(get-filings ticker-or-cik
             &
             {:keys [form start-date end-date limit include-amends?]
              :or {include-amends? false}})

Return a lazy seq of filing metadata maps for a company. ticker-or-cik : ticker string or CIK integer/string Options: :form - filter by exact form type string e.g. "10-K" "8-K"; an amendment form such as "10-K/A" returns the amendments themselves :start-date - filter to filings on/after this date string "YYYY-MM-DD" :end-date - filter to filings on/before this date string "YYYY-MM-DD" :limit - max number of results (default all) :include-amends? - include amended filings e.g. 10-K/A, 10-Q/A (default false; implied when :form itself is an amendment)

Return a lazy seq of filing metadata maps for a company.
ticker-or-cik : ticker string or CIK integer/string
Options:
  :form            - filter by exact form type string e.g. "10-K" "8-K";
                     an amendment form such as "10-K/A" returns the
                     amendments themselves
  :start-date      - filter to filings on/after this date string "YYYY-MM-DD"
  :end-date        - filter to filings on/before this date string "YYYY-MM-DD"
  :limit           - max number of results (default all)
  :include-amends? - include amended filings e.g. 10-K/A, 10-Q/A (default
                     false; implied when :form itself is an amendment)
sourceraw docstring

get-quarterly-indexclj

(get-quarterly-index year quarter)

Fetch and parse the full quarterly index for year/quarter. Returns a seq of maps with :cik (zero-padded 10-digit string) :company-name :form-type :date-filed (YYYY-MM-DD) :filename.

Uses master.idx, the pipe-delimited variant of the quarterly index. (company.idx and form.idx are fixed-width files; master.idx carries the same rows in a machine-friendly format.) The 30-60 MB file bypasses the in-memory response cache (the opt-in disk cache still applies).

Fetch and parse the full quarterly index for year/quarter.
Returns a seq of maps with :cik (zero-padded 10-digit string)
:company-name :form-type :date-filed (YYYY-MM-DD) :filename.

Uses master.idx, the pipe-delimited variant of the quarterly index.
(company.idx and form.idx are fixed-width files; master.idx carries the
same rows in a machine-friendly format.) The 30-60 MB file bypasses the
in-memory response cache (the opt-in disk cache still applies).
sourceraw docstring

get-quarterly-index-by-formclj

(get-quarterly-index-by-form year quarter form)

Like get-quarterly-index but pre-filtered to a specific form type.

Like get-quarterly-index but pre-filtered to a specific form type.
sourceraw docstring

latest-effective-filingclj

(latest-effective-filing ticker-or-cik & {:keys [form]})

Return the most recent effective (non-amended) filing for a company and form type. If an amendment exists that is newer than the original, returns the amendment instead. Options: :form - form type string e.g. "10-K"

Return the most recent effective (non-amended) filing for a company and form type.
If an amendment exists that is newer than the original, returns the amendment instead.
Options:
  :form - form type string e.g. "10-K"
sourceraw docstring

search-filingsclj

(search-filings query
                &
                {:keys [forms start-date end-date limit] :or {limit 10}})

Full-text search across SEC EDGAR filings (EFTS, filings since 2001). Options: :forms - vector of form types e.g. ["10-K" "10-Q"] :start-date - "YYYY-MM-DD" :end-date - "YYYY-MM-DD" :limit - max results (default 10)

Returns a lazy seq of one map per FILING, best match first. EFTS indexes documents, so a filing whose exhibits also match appears once (its best-scoring document). Each map is the raw EFTS _source map plus filing keys: :accessionNumber - dashed accession number (= :adsh) :cik - zero-padded 10-digit CIK of the first filer :form - form type, e.g. "10-K" :filingDate - "YYYY-MM-DD" (= :file_date) :companyName - first display name, e.g. "Apple Inc. (AAPL) (CIK 0000320193)" :document - file name of the matching document :url - archive URL of the matching document and the raw keys :adsh :ciks :display_names :root_forms :file_date :period_ending :items :sics :biz_locations :inc_states :file_num ...

Lazily pages through the EFTS search-index with from= offsets, so :limit may exceed the EFTS page size. Note that EFTS itself caps result offsets at 10,000 — narrow the query or date range for exhaustive sweeps.

Full-text search across SEC EDGAR filings (EFTS, filings since 2001).
Options:
  :forms       - vector of form types e.g. ["10-K" "10-Q"]
  :start-date  - "YYYY-MM-DD"
  :end-date    - "YYYY-MM-DD"
  :limit       - max results (default 10)

Returns a lazy seq of one map per FILING, best match first. EFTS indexes
documents, so a filing whose exhibits also match appears once (its
best-scoring document). Each map is the raw EFTS _source map plus filing
keys:
  :accessionNumber - dashed accession number (= :adsh)
  :cik             - zero-padded 10-digit CIK of the first filer
  :form            - form type, e.g. "10-K"
  :filingDate      - "YYYY-MM-DD" (= :file_date)
  :companyName     - first display name, e.g. "Apple Inc.  (AAPL)  (CIK 0000320193)"
  :document        - file name of the matching document
  :url             - archive URL of the matching document
and the raw keys :adsh :ciks :display_names :root_forms :file_date
:period_ending :items :sics :biz_locations :inc_states :file_num ...

Lazily pages through the EFTS search-index with from= offsets, so :limit
may exceed the EFTS page size. Note that EFTS itself caps result offsets
at 10,000 — narrow the query or date range for exhaustive sweeps.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
←Move to previous article
→Move to next article
Ctrl+/Jump to the search field
× close