/api/periods

GET

Retrieve the periods of the archives filed by a particular entity

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
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 periods of the archives filed by the given entity
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