List Entities

All entities

You can retrieve all entities with the ALL entity-tag:

[Public datalake] You can retrieve all entities with the tag ALL

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?entity-tag=ALL&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

You should be careful making this call, however, if the repository is bigger. The API supports paging, so that the top parameter used above will only select the first 20. You can access the next page with the skip parameter, like so:

[Public datalake] You can retrieve all entities with the top and skip parameters

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?entity-tag=ALL&format=html&top=20&skip=20&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

For convenience, we are using the HTML format in the above example: paging is supported with a link at the bottom.

Getting companies by stock index

On some profiles, some tags are defined with other values that often represent stock indices.

You can retrieve all companies in an index with a single call. Here is an example with the DOW30:

[Public datalake] List DOW30 entities

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?entity-tag=DOW30&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

And here is one with the NIKKEI (which requires the Japanese profile).

[Public datalake] List NIKKEI entities

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?entity-tag=NIKKEI&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

Look up a specific entity

This query retrieves a company, say, Apple. Apple's ticker is aapl. This doesn't require explicitly setting the SEC profile because it is activated by default in this cell store deployment.

[Public datalake] List Apple entity

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?ticker=aapl&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

The same company can be retrieved, in the SEC profile, with its CIK:

[Public datalake] List Apple entity via CIK

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?cik=320193&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

The following query retrieves a Japanese company, say, Canon. Canon's ticker is 7751. This requires the Japanese profile.

[Public datalake] List Canon

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?ticker=7751&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"

In the Japanese profile, the EDINET code is also available:

[Public datalake] List Canon via edinetcode

curl -X GET "http://secxbrl.28.io/v1/_queries/public/api/entities?edinetcode=E02274&profile-name=japan&format=html&token=c3049752-4d35-43da-82a2-f89f1b06f7a4"