| profile-name |
query |
Specifies which profile to use, which will enable some parameters or modify hypercube queries accordingly. The default depends on the underlying repository |
|
| format |
query |
Returns the results in the supplied format |
|
| format-indent |
query |
Whether or not to indent JSON or XML output (default: no indent). |
|
| token |
query |
The token that allows you to use this API. Gives you read (GET) and/or write (POST, DELETE, PATCH) credentials. |
|
| eid |
query |
The EIDs (scheme + local name) of a company, to retrieve entities, archives, sections, components or dice facts. |
|
| ticker |
query |
The ticker of a company, to retrieve entities, archives, sections, components or dice facts. |
sec, japan |
| entity-tag |
query |
The tag of an entity (such as an index), to retrieve entities, archives, sections, components or dice facts. |
sec, japan |
| sic |
query |
The SIC (industry group) of a company, to retrieve entities, archives, sections, components or dice facts. |
sec |
| cik |
query |
The CIK of a company, to retrieve entities, archives, sections, components or dice facts. |
sec |
| edinetcode |
query |
The EDINET code of a company, to retrieve entities, archives, sections, components or dice facts. |
japan |
| archiveFiscalYear |
query |
The fiscal year focus of the archive, to retrieve archives, sections, components or slice facts (default: ALL). |
sec, japan |
| archiveFiscalPeriod |
query |
The fiscal period focus of the archive, to retrieve archives, sections, components or slice facts (default: ALL). |
sec, japan |
| archive-tag |
query |
The tag of the archive, to retrieve archives, sections, components or slice facts (default: no filtering). |
japan |
| aid |
query |
Archive IDs, to retrieve archives, sections, components or slice facts. |
|
| section |
query |
The URI of a particular section, to retrieve a section, component or report element. |
|
| hypercube |
query |
The name of a hypercube report element, to retrieve labels. |
|
| disclosure |
query |
A disclosure, to identify sections or components (e.g. BalanceSheet). |
sec, japan |
| reportElement |
query |
The name of the report element to search for, to retrieve a section, a component or a report element (e.g. us-gaap:Goodwill). |
|
| label |
query |
A search term to search in the labels of components, to retrieve components (e.g. stock). |
|
| count |
query |
If true, only outputs statistics (default: false). |
|
| top |
query |
Output only the first [top] results (default: no limit). |
|
| skip |
query |
Skip the first [skip] results. |
|
| validate |
query |
Whether to run validation on the output components (default: false). Adds a column ValidationErrors |
|
| language |
query |
A language code (default: en-US) for displaying labels. |
|
| concept |
query |
The name of a concept to specify a data point to restrict components. |
|
| prefix:dimension |
query |
The name of a dimension used for slicing and dicing facts. Accepted format: prefix:dimension. As a value, the value of the dimension or ALL can be provided if all facts with this dimension should be retrieved. |
|
| prefix:dimension::type |
query |
Sets the dimension to be a typed dimension with the specified type (default: xbrl:Entity/xbrl:Period/xbrl:Unit/xbrl28:Archive are typed string, others are explicit dimensions; Some further dimensions may have default types depending on the profile). |
|
| prefix:dimension::default |
query |
The default value of the dimension [prefix:dimension] that should be returned if the dimension was not provided explicitly for a fact. Accepted format: prefix:dimension::default. |
|