Data Portal » API Data Feeds » Entities API » Documentation

Entities API

Table of contents

Table of contents

Documentation
Overview and quick start
Authentication and authorization
Example usage
How to query
Query parameters
Data glossary
Error handling
Changelog
Version 1
Changelog

The following is a sample selection of the most commonly used query parameters. The full list of query parameters for the Acuris Entities API is available via the Swagger pages. 

‘entityName’ 

Use the ‘entityName’ property to look up entities by name and retrieve their details. Use the percentage encoding standard for string, e.g. space encoded as %20, to yield better results. 

https://api.acuris.com/entities/?entityName=ION%20Analytics 

 “Begin With” and partial matching is the default logic applied to the entity’s name and entity’s aliases. For example, searching “ION%20Group” will match both “ION Group” and “Ionics Inc.”. 

‘sector’ and ‘subsector’ 

Get all items that are relevant for a specific industry. The industry classification is according to Acuris proprietary categorization. The following example shows how to query entities relevant for the leisure sector. 

https://api.acuris.com/entities/?sector=leisure 

To narrow the search to a specific industry’s subsector, use the ‘subsector’ parameter. For example, to find entities that operate as travel, holidays and tour operators, use the following query: 

https://api.acuris.com/entities/?subsector=travel 

Sector and subsectors can be combined to create a unique industry view. For example, to create a list of companies that operate in agriculture, plus the ones that operate in agrochemicals, you can use the following query. 

https://api.acuris.com/entities/?sector=agriculture&subsector=agrochem 

‘hqCountry’ and ‘hqState’ 

These two properties allow you to retrieve entities that are headquartered in a specific country or state. The example below shows how to query entities with headquarter in Germany. 

https://api.acuris.com/entities/?hqCountry=DEU 

To narrow the search to a specific state, use the ‘hqState’ parameter. For example, to find entities that are headquartered in Bavaria, use the following query. 

https://api.acuris.com/entities/?hqState=DE-BY 

‘operationalCountry’ and ‘operationalState’ 

Use these parameters to find entities that operate, or are headquartered, in specific countries or states. For example, to query for entities that operate, or are headquartered, in the Cayman Islands. 

https://api.acuris.com/entities/?operationalCountry=CYM 

To run the same search on specific states, use the ‘operationalState’ parameter. For example, to find entities that operate or have the headquarter in Bavaria, use the following query. 

https://api.acuris.com/entities/?operationalState=DE-BY 

/id 

To augment the entity data available in other Acuris APIs with the information available in the entity API, you can use the company’s “prime-id”. 

For example, the Acuris Intelligence API response shows the “prime-id” of each company and advisor tagged in the article: 

"companyRelationshipGroups":[{ "bidders":[{ "mmgid":"prime-381", "name": "Deloitte" }]}] 

To get additional information on Deloitte from the entities API, use its “prime-id”, like so: 

https://api.acuris.com/entities/prime-381