get_filing_xbrl
Retrieve one XBRL part of an SEC filing at a time—summary, schema, linkbases, or instance—to inspect the filer's exact disclosures and facts.
Instructions
The XBRL files of one filing as the filer wrote them, one part at a time.
The filing is accession_number, else the first row of the company's
submissions, in the SEC's order, whose form equals form exactly (of
any form when form is None, the default); with as_of (YYYY-MM-DD)
only rows whose filingDate is on or before it, and a row without such a
date is skipped and named in warnings, never taken as earlier.
"summary": the submissions row, the acceptance time as the filing header states it, the instance and schema files and how each was found, and the SEC's FilingSummary.xml as an element tree (null, and named in
unresolved, when the folder has none)."schema": the declarations of the company schema and of every schema of the filing reached from it, the instance or their linkbases (the same files whatever the part), file by file, in document order: imports, linkbase references, role and arcrole types (definition and usedOn as written) and elements with every attribute. Imported schemas outside the filing are listed in
unresolved."presentation", "calculation", "definition", "label", "reference": the extended links of that element in every linkbase of the filing that the schemas or the instance reference (link:linkbaseRef) or that a schema contains, including schemas found only through a locator, roleRef or arcroleRef of another part's link, flattened in document order to locators, arcs and resources. Every file is read once; one not read is in
unresolved. Every attribute is kept (order, weight, priority, use="prohibited", preferredLabel, xml:lang, ...); no arc is combined, overridden or dropped, and no label or language is preferred. A locator'stargetis the element of a filing schema its href names, or unresolved with the reason (a schema outside the filing, say)."instance": the instance in document order: contexts (entity identifier and scheme, period as written, explicit members, typed members as XML), units and facts (concept as namespace URI and local name, contextRef, unitRef, decimals, precision, xsi:nil, the text as written). Every duplicate is returned; none is chosen.
concepts (with "instance", up to 50) keeps the facts of the named
concepts and the contexts and units they use. A name is "prefix:local"
(prefix resolved through the instance's own declarations),
"{namespace}local", or a bare local name, which matches that local name in
every namespace; concept_matches says what each name matched. A fact
inside a tuple is found too and has path; a name of an element that is
no fact (a tuple) is listed as unsupported and in unresolved.
Items are paged by offset and limit; page.next_offset is null on the
last page. Attribute names in a namespace are given as "{namespace}local".
Each file parsed comes with its document element (root) and namespace
declarations; not_returned lists what the response leaves out of it.
Files are found only from what the filing publishes: the instance is the
one row of the filing index page typed EX-101.INS or described as the
extracted XBRL instance; the schema is the one the instance's
link:schemaRef names. Zero or several candidates leave a file unresolved
with the candidates listed; instance_file and schema_file (a file name
in the filing folder) then name it.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| form | No | ||
| part | No | summary | |
| as_of | No | ||
| limit | No | ||
| offset | No | ||
| concepts | No | ||
| schema_file | No | ||
| cik_or_ticker | Yes | ||
| instance_file | No | ||
| accession_number | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||