/api/facts
GET
Retrieve one or more facts for a combination of archives.
Parameters
| Name | Type | Description | Profile |
|---|---|---|---|
| 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. | |
| aid | query | Archive IDs, to retrieve archives, sections, components or slice facts. | |
| eid | query | The EIDs (scheme + local name) of a company, to retrieve entities, archives, sections, components or dice facts. | |
| cik | query | The CIK of a company, to retrieve entities, archives, sections, components or dice facts. | sec |
| ticker | query | The ticker of a company, to retrieve entities, archives, sections, components or dice facts. | sec, japan |
| edinetcode | query | The EDINET code of a company, to retrieve entities, archives, sections, components or dice facts. | 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 |
| concept | query | The name of a concept to dice facts (a synonym for the dimension xbrl:Concept). | |
| fiscalYear | query | A fiscal year to slice facts (a synonym for the dimension xbrl28:FiscalYear, default: no filtering). | sec, japan |
| fiscalPeriod | query | A fiscal period to slice facts (a synonym for the dimension xbrl28:FiscalPeriod, default: no filtering). | sec, japan |
| fiscalPeriodType | query | A fiscal period type to slice facts (a synonym for the dimension xbrl28:FiscalPeriodType, default: no filtering). | sec, japan |
| archiveFiscalYear | query | The fiscal year focus of the archive, to retrieve archives, sections, components or slice facts (default: no filtering). | sec, japan |
| archiveFiscalPeriod | query | The fiscal period focus of the archive, to retrieve archives, sections, components or slice facts (default: no filtering). | sec, japan |
| map | query | [Deprecated, use report] The concept map that should be used to resolve the concept (default: none). | |
| rule | query | [Deprecated, use report] The rules that should be used to resolve the concept (default: none). | |
| report | query | The report to use as a context to retrieve the facts. In particular, concept maps and rules found in this report will be used. (default: none). | |
| additional-rules | query | The name of a report from which to use rules in addition to a report's rules (e.g. FundamentalAccountingConcepts). | |
| labels | query | Whether human-readable labels should be included for concepts in each fact (default: false). | |
| metadata | query | Whether metadata about the facts concept and dimensions should be included in each fact (default: false). | |
| audit-trails | query | Whether audit trails should be included in each fact (default: no). | |
| open | query | Whether the hypercube query has open hypercube semantics, i.e., automatically stretches to accommodate for all found dimensions (default: false). | |
| 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. | |
| prefix:dimension::category | query | Specifies whether the dimension is a slicer, a dicer, or unchanged. If an aggregation function is specified, facts are aggregated along slicers and grouped along dicers (default: unchanged). | |
| prefix:dimension::visible | query | Specifies whether the dimension is visible in the output. Only applies to dimensions defined as slicers. Default: false for slicers, but always true for dicers. | |
| prefix:dimension::slicer | query | [Deprecated] Specifies whether the dimension is a slicer (true) or not (false). Slicer dimensions do not appear in the output fact table, and if an aggregation function is specified, facts are aggregated along this dimension (default: false). | |
| prefix:dimension::column | query | If the dimension is visible in the output, specifies the position at which it appears in the output fact table (default: arbitrary order). | |
| prefix:dimension::aggregation | query | [Deprecated] Specifies whether this dimension is a dicer ('group') or not ('no'). If a dicer, facts will be grouped along this dimension before applying the supplied aggregation function. By default, all key aspects, except those explicitly specified as slicers, are dicers ('group') and non-key aspects are not ('no'). Has no effect if no aggregation function is supplied, or if the dimension is explicitly specified as a slicer. | |
| aggregation-function | query | Specify an aggregation function to aggregate facts. Will aggregate facts, grouped by dicers, but aggregated along slicers, with this function. | |
| validate | query | Whether or not to stamp facts for validity (default is false). | |
| 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. |
Status codes
| Code | Description |
|---|---|
| 200 | Returns the fact listing |
| 400 | Bad request: a parameter is missing or invalid or total is used together with csv or excel serialization |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges |
| 404 | No such entity could be found. / No such archive could be found |
| 500 | An internal error occurred during the processing of the request |
POST
Parameters
| Name | Type | Description | Profile |
|---|---|---|---|
| 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. | |
| fact | body | The fact objects (they must be valid, and have an archive aspect that points to an existing archive). To logically delete a fact, omit the Value field. |
Status codes
| Code | Description |
|---|---|
| 200 | Returns the fact objects that has been added to the cell store. |
| 400 | One of the supplied facts is invalid. |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges |
| 403 | Access denied |
| 404 | No such archive or entity could be found. |
| 500 | An internal error occurred during the processing of the request. |
PATCH
Patch one or more facts
Parameters
| Name | Type | Description | Profile |
|---|---|---|---|
| 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. | |
| entity-tag | query | The tag of an entity (such as an index), to retrieve entities, archives, sections, components or dice facts. | sec, japan |
| eid | query | The EIDs (scheme + local name) of a company, to retrieve entities, archives, sections, components or dice facts. | |
| 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 |
| sic | query | The SIC (industry group) of a company, to retrieve entities, archives, sections, components or dice facts. | sec |
| ticker | query | The ticker of a company, to retrieve entities, archives, sections, components or dice facts. | sec, japan |
| aid | query | Archive IDs, to retrieve archives, sections, components or slice facts. | |
| concept | query | The name of a concept to dice facts (a synonym for the dimension xbrl:Concept). | |
| fiscalYear | query | A fiscal year to slice facts (a synonym for the dimension xbrl28:FiscalYear, default: no filtering). | sec, japan |
| fiscalPeriod | query | A fiscal period to slice facts (a synonym for the dimension xbrl28:FiscalPeriod, default: no filtering). | sec, japan |
| fiscalPeriodType | query | A fiscal period type to slice facts (a synonym for the dimension xbrl28:FiscalPeriodType, default: no filtering). | sec, japan |
| archiveFiscalYear | query | The fiscal year focus of the archive, to retrieve archives, sections, components or slice facts (default: no filtering). | sec, japan |
| archiveFiscalPeriod | query | The fiscal period focus of the archive, to retrieve archives, sections, components or slice facts (default: no filtering). | sec, japan |
| map | query | [Deprecated, use report] The concept map that should be used to resolve the concept (default: none). | |
| rule | query | [Deprecated, use report] The rules that should be used to resolve the concept (default: none). | |
| report | query | The report to use as a context to retrieve the facts. In particular, concept maps and rules found in this report will be used. (default: none). | |
| additional-rules | query | The name of a report from which to use rules in addition to a report's rules (e.g. FundamentalAccountingConcepts). | |
| open | query | Whether the hypercube query has open hypercube semantics, i.e., automatically stretches to accommodate for all found dimensions (default: false). | |
| 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. | |
| prefix:dimension::category | query | Specifies whether the dimension is a slicer, a dicer, or unchanged. If an aggregation function is specified, facts are aggregated along slicers and grouped along dicers (default: unchanged). | |
| prefix:dimension::visible | query | Specifies whether the dimension is visible in the output. Only applies to dimensions defined as slicers. Default: false for slicers, but always true for dicers. | |
| prefix:dimension::slicer | query | [Deprecated] Specifies whether the dimension is a slicer (true) or not (false). Slicer dimensions do not appear in the output fact table, and if an aggregation function is specified, facts are aggregated along this dimension (default: false). | |
| prefix:dimension::column | query | If the dimension is visible in the output, specifies the position at which it appears in the output fact table (default: arbitrary order). | |
| prefix:dimension::aggregation | query | [Deprecated] Specifies whether this dimension is a dicer ('group') or not ('no'). If a dicer, facts will be grouped along this dimension before applying the supplied aggregation function. By default, all key aspects, except those explicitly specified as slicers, are dicers ('group') and non-key aspects are not ('no'). Has no effect if no aggregation function is supplied, or if the dimension is explicitly specified as a slicer. | |
| aggregation-function | query | Specify an aggregation function to aggregate facts. Will aggregate facts, grouped by dicers, but aggregated along slicers, with this function. | |
| validate | query | Whether or not to stamp facts for validity (default is false). | |
| count | query | If true, only outputs statistics (default: false). | |
| patch | body | The patch object, which will be merged into each facts (the facts must be valid after applying it). |
Status codes
| Code | Description |
|---|---|
| 200 | Returns the patched facts |
| 400 | Bad request: a parameter is missing or invalid, or a fact is invalid after applying the patch |
| 401 | Unauthorized: the specified project token is invalid, expired, or has insufficient privileges |
| 403 | Access denied |
| 404 | No such entity could be found. / No such archive could be found |
| 500 | An internal error occurred during the processing of the request |