Entities

Entity types

An entity type is a group of entities having similar real world meaning, for instance company, web domain, brand, or region. Every entity has a single entity type.

Some standard entity types are provided by Exabel:

Entity type	Resource name	Customers can create entities	Can be listed
brand	`entityTypes/brand`	yes	yes
company	`entityTypes/company`	no	no
country	`entityTypes/country`	no	yes
currency	`entityTypes/currency`	no	yes
listing	`entityTypes/listing`	no	no
regional	`entityTypes/regional`	no	no
security	`entityTypes/security`	no	no
web_domain	`entityTypes/web_domain`	no	yes
rbics	`entityTypes/rbics`	no	yes

A regional is a group of listings (of the same security) with the same trading currency in the same region. The other entity types should be self-explanatory.

Some entity types are marked as associative, representing a many-to-many relationship in the Data API graph. Entities of associative entity types will normally not show in search results, but they act as connections in order to connect a signal to a pair of entities.

The collection id for entity types is entityTypes.

Entities

An entity is an instance of any one of the entity types, such as a company or a brand. The full resource name for an entity is entityTypes/ns.type/entities/ns.name. For example, the company entity referring to Apple, Inc. has the resource name entityTypes/company/entities/F_000C7F-E. (Note that the identifier does not specify any namespace since the entity belongs to the global namespace.)

A large number of entities are created and managed by Exabel. Those entities cover all publicly listed companies on a large number of exchanges, along with the corresponding securities and listings. Some of those entity types are too large to be listed as shown in the above table, but they can be searched for.

When searching for entities, you must provide the entity type of the entities and set of search terms. The list of search terms are supported for different entity types is provided below:

Fields	Supported entities	Example	Comments
`ISIN`	Companies, securities	`US-000402625-0`	International Securities Identification Number.
`MIC` and `ticker`	Companies, securities, listings	`XNAS` and `AAPL`	Market Identifier Code. Must be present in pairs, with `MIC` immediately before `ticker`. One such pair is treated as one search query.
`bloomberg_ticker`	Companies	`HSBA LN`	A Bloomberg ticker. Only works for currently listed tickers.
`bloomberg_symbol`	Companies	`HSBA LN Equity`	A Bloomberg ticker, optionally with its symbol. Only works for currently listed tickers.
`factset_identifier`	Companies	`WWDPYB-S`	Either a FactSet entity identifier or a FactSet permanent identifier (also known as "FSYM_ID").
`FIGI`	Companies	`BBG001S696H2`	A Financial Instrument Global Identifier (FIGI). Only works for current FIGIs.
`text`	Companies	`microsoft`	A free text search for ISINs, tickers and/or company names. If a search term is sufficiently long, it will also perform a prefix search.

Of the built-in entity types all except for the brand entity type are read-only, meaning that new entities can only be added by Exabel. Customers can add entities with the brand entity type, and any entity type that has been created in their namespace.

The collection id for entities is entities.

-EntityService REST reference documentation
-EntityService gRPC reference documentation