Liking cljdoc? Tell your friends :D
Clojure only.

edgar.forms.form13f

Form 13F-HR parser — Institutional Investment Manager Holdings Report. Registers filing-obj methods for form types "13F-HR" and "13F-HR/A".

Only handles XML-era filings (post-2013 Q2). Earlier filings use heterogeneous plain-text infotables and are not supported.

Usage: (require '[edgar.forms.form13f]) ; side-effectful load registers the method (edgar.filing/filing-obj filing) ; => {:form "13F-HR" :holdings <dataset> ...}

Form 13F-HR parser — Institutional Investment Manager Holdings Report.
Registers filing-obj methods for form types "13F-HR" and "13F-HR/A".

Only handles XML-era filings (post-2013 Q2). Earlier filings use
heterogeneous plain-text infotables and are not supported.

Usage:
  (require '[edgar.forms.form13f])  ; side-effectful load registers the method
  (edgar.filing/filing-obj filing)  ; => {:form "13F-HR" :holdings <dataset> ...}
raw docstring

parse-form13fclj

(parse-form13f filing)

Parse a 13F-HR or 13F-HR/A filing map into a structured map. Header, cover and summary data come from primary_doc.xml, holdings from the separate INFORMATION TABLE attachment. Returns nil when the filing has neither XML document.

Dollar amounts (:table-value-total, holdings :value, :total-value) are as filed: whole US dollars in filings made from January 3, 2023 onward, thousands of US dollars in earlier filings.

Returns: {:form "13F-HR" | "13F-HR/A" (XML submissionType; falls back to the filing's :form) :period-of-report "YYYY-MM-DD" :report-type "13F HOLDINGS REPORT" | "13F COMBINATION REPORT" :is-amendment? boolean :amendment-number long (amendments only) :amendment-type "RESTATEMENT" | "NEW HOLDINGS" (amendments only) :form13f-file-number "028-..." :other-managers-count long (other included managers) :table-entry-count long (as reported on the summary page) :table-value-total long (as reported on the summary page) :manager {:name ... :street ... :city ... :state ... :zip ...} :holdings <tech.ml.dataset> columns: :name :cusip :title :value :shares :shares-type :put-call :investment-discretion :other-managers :voting-sole :voting-shared :voting-none :total-value long (sum of the :value column)}

Parse a 13F-HR or 13F-HR/A filing map into a structured map. Header,
cover and summary data come from primary_doc.xml, holdings from the
separate INFORMATION TABLE attachment. Returns nil when the filing has
neither XML document.

Dollar amounts (:table-value-total, holdings :value, :total-value) are
as filed: whole US dollars in filings made from January 3, 2023 onward,
thousands of US dollars in earlier filings.

Returns:
  {:form                 "13F-HR" | "13F-HR/A" (XML submissionType;
                         falls back to the filing's :form)
   :period-of-report     "YYYY-MM-DD"
   :report-type          "13F HOLDINGS REPORT" | "13F COMBINATION REPORT"
   :is-amendment?        boolean
   :amendment-number     long (amendments only)
   :amendment-type       "RESTATEMENT" | "NEW HOLDINGS" (amendments only)
   :form13f-file-number  "028-..."
   :other-managers-count long (other included managers)
   :table-entry-count    long (as reported on the summary page)
   :table-value-total    long (as reported on the summary page)
   :manager              {:name ... :street ... :city ... :state ... :zip ...}
   :holdings             <tech.ml.dataset>
                           columns: :name :cusip :title :value :shares
                                    :shares-type :put-call
                                    :investment-discretion :other-managers
                                    :voting-sole :voting-shared :voting-none
   :total-value          long (sum of the :value column)}
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