List Archives
Archives belonging to a given entity
Let us begin with a very simple query that just lists the archives submitted by an entity, like Canon. The way the entity or the entities are identified is identical to the entities endpoint.
[Public datalake] List Canon archives
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?ticker=7751&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
If you read the chapter on entities, you will immediately recognize how this output looks like in JSON: first some metadata, then some statistics (number of output archives, total number of archives in the cell store), and finally the results, as an Archives array.
Like in all endpoints, you can pick the output format you need (XML, CSV, HTML).
[Public datalake] List Canon archives as XML
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?ticker=7751&profile-name=japan&format=xml&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
[Public datalake] List Canon archives as CSV
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?ticker=7751&profile-name=japan&format=csv&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
By default, only fiscal archives submitted for the latest fiscal year and the FY period are shown. However, you can change that as shown further down.
Several entities at the same time
Like in the entities endpoint, you can request the archives of as many entities as you wish in a single call and in the exact same way as in the entities endpoint.
[Public datalake] Archives from multiple entities
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?entity-tag=NIKKEI&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
Filtering by fiscal year, period, filing kind
If you are looking for earlier archives, or for different periods, or for all archives, you can use additional parameters to adapt the filter.
For example, you can specify that you want all periods and years. This will also return archives without any fiscal focus.
[Public datalake] Archives from any period and year
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?ticker=7751&archiveFiscalYear=ALL&archiveFiscalPeriod=ALL&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
You could also look for the Q1 archives filed for 2012:
[Public datalake] Archives from Q1 2012
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/archives?ticker=7751&archiveFiscalYear=2012&archiveFiscalPeriod=Q1&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
The available fiscal periods are Q1, Q2, Q3, Q4 and FY. Fiscal years are integers (2012, 2013, ...). ALL can be used as a joker for one or both parameters.
Finally, you can filter by filing tags (TDNET, EDINET, quarterly-securities-report, etc). This is the one that appears in the Tags field of the output.