(filing-by-accession accession-number)Hydrate a filing map from an accession number string. Accepts dashed format: "XXXXXXXXXX-YY-ZZZZZZ" The first 10 digits of the accession number are the filer's CIK. Returns a filing map with :cik :accessionNumber :form :primaryDocument, ready for filing-html, filing-text, filing-obj, extract-items, etc. Throws ex-info with ::not-found if the accession number does not exist.
Hydrate a filing map from an accession number string. Accepts dashed format: "XXXXXXXXXX-YY-ZZZZZZ" The first 10 digits of the accession number are the filer's CIK. Returns a filing map with :cik :accessionNumber :form :primaryDocument, ready for filing-html, filing-text, filing-obj, extract-items, etc. Throws ex-info with ::not-found if the accession number does not exist.
(filing-document filing doc-name & {:keys [raw?] :or {raw? true}})Fetch a specific named document from a filing as a string.
Fetch a specific named document from a filing as a string.
(filing-exhibit filing exhibit-type)Return the first exhibit entry matching exhibit-type (e.g. "EX-21"). Returns nil if no matching exhibit is found. Fetch its content with (filing-document filing (:name exhibit)).
Return the first exhibit entry matching exhibit-type (e.g. "EX-21"). Returns nil if no matching exhibit is found. Fetch its content with (filing-document filing (:name exhibit)).
(filing-exhibits filing)Return all exhibit entries from a filing's index as a seq of maps. Each map has :name :type :document :description :sequence. Exhibits have :type values beginning with "EX-" (e.g. "EX-21", "EX-31.1").
Return all exhibit entries from a filing's index as a seq of maps. Each map has :name :type :document :description :sequence. Exhibits have :type values beginning with "EX-" (e.g. "EX-21", "EX-31.1").
(filing-html filing)Fetch the primary HTML document of a filing as a string.
Fetch the primary HTML document of a filing as a string.
(filing-index filing)Fetch the filing index — list of all documents/attachments in a filing. Returns a map with :files (seq of {:name :type :document :description :size}).
Fetch the filing index — list of all documents/attachments in a filing.
Returns a map with :files (seq of {:name :type :document :description :size}).(filing-index-url {:keys [cik accessionNumber]})Build the submission index URL for a filing.
Build the submission index URL for a filing.
Parse a filing into a structured form-specific map. Dispatches on the :form key of the filing map.
Parse a filing into a structured form-specific map. Dispatches on the :form key of the filing map.
(filing-save! filing dir)Download a filing's primary document to a directory. Creates subdirectory structure: dir/{form}/{cik}/{accession-no}/{filename} Returns the saved file path.
Download a filing's primary document to a directory.
Creates subdirectory structure: dir/{form}/{cik}/{accession-no}/{filename}
Returns the saved file path.(filing-save-all! filing dir)Download all documents in a filing to a directory. Returns a seq of saved file paths.
Download all documents in a filing to a directory. Returns a seq of saved file paths.
(filing-text filing)Fetch the primary document of a filing as plain text (HTML stripped).
Fetch the primary document of a filing as plain text (HTML stripped).
(filing-xbrl-docs filing)Return all XBRL-related document entries from a filing's index as a seq of maps. Covers EX-101.* linkbases (instance, schema, calculation, label, presentation, definition) and .xsd schema files.
Return all XBRL-related document entries from a filing's index as a seq of maps. Covers EX-101.* linkbases (instance, schema, calculation, label, presentation, definition) and .xsd schema files.
(primary-doc index)Return the primary document entry from a filing index.
Return the primary document entry from a filing index.
cljdoc builds & hosts documentation for Clojure/Script libraries
| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |