Identify Labels
Labels are identified uniquely with:
- An archive
- A section
- A report element
- A language
- A label role
Archives can themselves be identified with an AID, or an entity, fiscal focus, etc. The parameters of the archives endpoint are also applicable in the labels endpoint.
Getting a specific label
You can access a specific label by providing all five identifiers, like so:
[Public datalake] Identify label
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/labels?format=html&ticker=ko&archiveFiscalYear=2014&archiveFiscalPeriod=Q3§ion=http%3A%2F%2Fwww.thecocacolacompany.com%2Frole%2FCondensedConsolidatedStatementsOfIncome&reportElement=ko%3AUnusualOrInfrequentItemOperating&labelRole=http%3A%2F%2Fwww.xbrl.org%2F2003%2Frole%2Flabel&language=en-us&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
Note: for the moment, language codes must be exact matches against the original filing, including the case. To be on the safe side, you can include several possible variants like so:
[Public datalake] Identify label
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/labels?format=html&ticker=ko&archiveFiscalYear=2014&archiveFiscalPeriod=Q3§ion=http%3A%2F%2Fwww.thecocacolacompany.com%2Frole%2FCondensedConsolidatedStatementsOfIncome&reportElement=ko%3AUnusualOrInfrequentItemOperating&labelRole=http%3A%2F%2Fwww.xbrl.org%2F2003%2Frole%2Flabel&language=en-us&language=en-US&language=en&language=en-GB&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"
Filtering labels
You can omit some of the identifiers to get more labels:
[Public datalake] Identify label
curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/labels?format=html&ticker=ko&archiveFiscalYear=2014§ion=http%3A%2F%2Fwww.thecocacolacompany.com%2Frole%2FCondensedConsolidatedStatementsOfIncome&reportElement=ko%3AUnusualOrInfrequentItemOperating&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"