Liking cljdoc? Tell your friends :D

edgar.xbrl


concept-frame-urlclj

(concept-frame-url taxonomy concept unit frame)

Build the frames endpoint URL for a cross-sectional concept fetch.

Build the frames endpoint URL for a cross-sectional concept fetch.
sourceraw docstring

facts->datasetclj

(facts->dataset facts-map)

Convert company facts map to a tech.ml.dataset. Returns a dataset with columns: taxonomy concept unit end val accn fy fp form filed frame

Convert company facts map to a tech.ml.dataset.
Returns a dataset with columns:
taxonomy concept unit end val accn fy fp form filed frame
sourceraw docstring

get-company-factsclj

(get-company-facts cik)

Fetch pre-parsed XBRL company facts from SEC data endpoint. Returns the raw response map.

Fetch pre-parsed XBRL company facts from SEC data endpoint.
Returns the raw response map.
sourceraw docstring

get-concept-frameclj

(get-concept-frame concept
                   frame
                   &
                   {:keys [taxonomy unit] :or {taxonomy "us-gaap" unit "USD"}})

Fetch cross-sectional data for a concept across all companies for a period. frame examples: "CY2023Q4I" (instant) or "CY2023Q4" (duration) Options: :taxonomy - default "us-gaap" :unit - default "USD" Returns a dataset with columns: accn cik entityName loc end val.

Fetch cross-sectional data for a concept across all companies for a period.
frame examples: "CY2023Q4I" (instant) or "CY2023Q4" (duration)
Options:
  :taxonomy - default "us-gaap"
  :unit     - default "USD"
Returns a dataset with columns: accn cik entityName loc end val.
sourceraw docstring

get-conceptsclj

(get-concepts cik)

Return a dataset of all XBRL concepts available for a CIK. Columns: :taxonomy :concept :label :description Each row is a distinct concept (one row per concept, not per observation).

Return a dataset of all XBRL concepts available for a CIK.
Columns: :taxonomy :concept :label :description
Each row is a distinct concept (one row per concept, not per observation).
sourceraw docstring

get-facts-datasetclj

(get-facts-dataset cik & {:keys [concept form sort] :or {sort :desc}})

Fetch company facts for a CIK and return as a tech.ml.dataset. Options: :concept - string or set of strings to filter concepts :form - "10-K" | "10-Q" to filter by form type :sort - :desc (default) or :asc — sort :end column descending/ascending Pass nil to skip sorting.

Fetch company facts for a CIK and return as a tech.ml.dataset.
Options:
  :concept - string or set of strings to filter concepts
  :form    - "10-K" | "10-Q" to filter by form type
  :sort    - :desc (default) or :asc — sort :end column descending/ascending
             Pass nil to skip sorting.
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