/api/archives

GET

Retrieve metadata about the archives, also called archives. The archives are identified with Archive IDs (AIDs). Facts can be bound with archives with the xbrl28:Archive aspect, whose values are AIDs.

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
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
language query A language code (default: en-US) for displaying labels.  
dts query Whether DTS and entrypoint information should be included for each archive (default: 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 all archives for the given entity
401 Unauthorized: the specified project token is invalid, expired, or has insufficient privileges
404 No such entity could be found
500 An internal error occurred during the processing of the request

POST

Add or update archives. The archives are identified with Archive IDs (AIDs).

A new empty archive can be created by submitting a JSON object containing general information about the archive. This JSON object must be valid agains a JSound schema. It can be either taken from the output of a GET request to the same endpoint (in which case it will be valid), or created manually.

For convenience, we offer a user-friendly summary of the fields involved. The JSound schema is available on request.

Body properties

Field Type Presence Content
AID string required The AID of the archive
Entity string optional The EID to which the archive belongs
Entities array of strings (at least one) required if Entity is absent Used if the archive reports information on more than one entity.
InstanceURL string optional The URL of the original XBRL instance
Namespaces object with string values optional Maps prefixes to namespaces for the archive (common bindings are automatically added)
Profiles object optional Maps profile names to additional profile-specific information. The profile-specific information must have a Name field containing the profile name, that is, identical to its key. The other fields in the profile information is not restricted.

Additionally, the following fields are allowed for the purpose of feeding back the output of the archives endpoint as input:

  • Components (string)
  • Sections (string)
  • NumSections (integer)
  • NumFacts (integer)
  • NumFootnotes (integer)
  • NumReportElements (integer)
  • NumHypercubes (integer)
  • NumDimensions (integer)
  • NumMembers (integer)
  • NumLineItems (integer)
  • NumAbstracts (integer)
  • NumConcepts (integer)

Several empty archives can be created at the same time by posting a sequence of non-comma-separated JSON objects as above.

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.  
archive body The body of the request. The archive JSON objects, which must satisfy the constraints described in the field table.  

Status codes

Code Description
200 Archives have been added.
400 One of the supplied archives is invalid or already exists.
401 Unauthorized: the specified project token is invalid, expired, or has insufficient privileges.
403 Access denied.
404 No such entity could be found.
409 Duplicate archive in the input or archive already exists.
500 An internal error occurred during the processing of the request.

DELETE

Deletes an archive.

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 ID of the archive or taxonomy.  
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
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

Status codes

Code Description
204 Archives have been deleted.
400 Cannot delete more than one archive at a time (safety mechanism).
401 Unauthorized: the specified project token is invalid, expired, or has insufficient privileges.
403 Access denied.
404 No such entity or archive could be found.
500 An internal error occurred during the processing of the request.

PATCH

Update one or more archives with partial information

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.  
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
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
patch body The patch object, which will be merged into each archive (the archive objects must be valid after applying it).

Updating the AID of an archive is not allowed. |   |

Status codes

Code Description
200 Returns the patched archives
400 Bad request: a parameter is missing or invalid, or an archive is invalid after applying the patch, or an AID was updated
401 Unauthorized: the specified project token is invalid, expired, or has insufficient privileges
403 Access denied
404 No such archive could be found.
500 An internal error occurred during the processing of the request