Entity Lookup Endpoint
All tags associated with an article are managed as entities. Entities are maintained in a database with an Entity ID associated with them. Whenever you read a channel, read articles, or need to utilize data through the API, you will be either given or will need to use the Entity ID. The Entity Lookup Endpoint is used to translate the Entity ID into a name.
Entity Lookup Endpoint: "/entity/ids/{entity_ids}"
Payload: [] (Empty)
Header: (Standard API Header)
{
"x-api-key": "{api_key}",
"Authorization": "{security token}",
"Content-Type": "application/json",
}
The Entity Lookup Endpoint will take one or more Entity IDs in a single call. This is very effective when used where you are provided with a list of entities such as in an article JSON structure where the Primary Entities, Secondary Entities, and Tertiary Entities are all provided as lists of Entity IDs which can be directly used with the Entity Lookup Endpoint to get the entity information for each.
The response JSON is a list of entity records.
{
"entities": [
{
"id": 163,
"external_id": "company_100004964",
"provider": "B41034DF-6F6F-4662-BFCA-4769B625A073",
"name": "International Business Machines Corp",
"type": "company",
"type_display": "Company",
"cik": null,
"sentiment": 0,
"popularity": 2757,
"private": null,
"owner": null,
"authorization_bridge": null,
"created_at": null,
"updated_at": "2022-11-28T18:27:04.656Z",
"ric": "",
"isin": "",
"sedol": "",
"issuer": 163,
"exchange": 1761889,
"exchange_qm_id": "US",
"exchange_acronym": "NYSE",
"exchange_mic": "XNYS",
"symbol": "IBM",
"figi": "BBG001G4LRK6",
"legal_body_uri": "kbent:organization/ibm"
},
{
"id": 246,
"external_id": "company_100000671",
"provider": "B41034DF-6F6F-4662-BFCA-4769B625A073",
"name": "Apple Inc",
"type": "company",
"type_display": "Company",
"cik": null,
"sentiment": 0,
"popularity": 14942,
"private": null,
"owner": null,
"authorization_bridge": null,
"created_at": null,
"updated_at": "2022-11-28T18:25:57.463Z",
"ric": "",
"isin": "",
"sedol": "",
"issuer": 246,
"exchange": 2363672,
"exchange_qm_id": "US",
"exchange_acronym": "NGS",
"exchange_mic": "XNGS",
"symbol": "AAPL",
"figi": "BBG001FDZRP7",
"legal_body_uri": "kbent:organization/apple"
},
{
"id": 690,
"external_id": "company_100008721",
"provider": "B41034DF-6F6F-4662-BFCA-4769B625A073",
"name": "AT&T Inc",
"type": "company",
"type_display": "Company",
"cik": null,
"sentiment": 0,
"popularity": 2399,
"private": null,
"owner": null,
"authorization_bridge": null,
"created_at": null,
"updated_at": "2024-04-12T20:52:24.134Z",
"ric": "",
"isin": "",
"sedol": "",
"issuer": 690,
"exchange": 1761889,
"exchange_qm_id": "US",
"exchange_acronym": "NYSE",
"exchange_mic": "XNYS",
"symbol": "T",
"figi": "BBG001FDZFM6",
"legal_body_uri": null
}
]
}
Note
The entity list in the response is contained in a field called entities. When you examine the response pull the list from the entities field and then use the list of entity information.