Entity Info

Get Entity Info

Returns entity information for a list of entities. - uri_suffixes: a list of suffixes, of the format ['company.tesla_motors', 'company.volkswagen']

Examples

Curl

Note: If you are using Windows, adjust the syntax:

• Replace line breaks (\) with caret (^).
• Use double quotes (") instead of single quotes (').

curl -X 'POST' \
  'https://metadata.api.yukkalab.com/v2/entity_info' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer $YUKKA_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '["company:apple"]'

Python

import requests

headers = {
    'accept': 'application/json',
    'Authorization': f'Bearer {token}',
}

json_data = [
    'company:apple',
]

response = requests.post('https://metadata.api.yukkalab.com/v2/entity_info', headers=headers, json=json_data)

Return type

List[YlMetadataApiModelsRelatedModelEntity]

Example Response

[{"type":"company","alpha_id":"apple","compound_key":"company:apple","name":"Apple Inc","description":{"Country":[{"entity":{"type":"country","alpha_id":"us","compound_key":"country:us"},"name":"United States of America"}],"City":[{"entity":{"type":"city","alpha_id":"cupertino","compound_key":"city:cupertino"},"name":"Cupertino"}],"Industry":[{"entity":{"type":"industry","alpha_id":"technology","compound_key":"industry:technology"},"name":"Technology"}],"Supersector":[{"entity":{"type":"supersector","alpha_id":"technology","compound_key":"supersector:technology"},"name":"Technology"}],"Sector":[{"entity":{"type":"sector","alpha_id":"technology_hardware_equipment","compound_key":"sector:technology_hardware_equipment"},"name":"Technology Hardware & Equipment"}],"Subsector":[{"entity":{"type":"subsector","alpha_id":"computer_hardware","compound_key":"subsector:computer_hardware"},"name":"Computer Hardware"}],"Ticker":[{"entity":{"type":"ticker","alpha_id":"AAPL_US","compound_key":"ticker:AAPL_US"},"name":"AAPL US"}],"CEO":[{"entity":{"type":"person","alpha_id":"steve_jobs","compound_key":"person:steve_jobs"},"name":"Steve Jobs"},{"entity":{"type":"person","alpha_id":"tim_cook","compound_key":"person:tim_cook"},"name":"Tim Cook"}],"Member_of":null,"Member_of_political_party":null,"CEO_of":null,"Manufacturer":null,"Location":null,"Source_provider":null,"Source_url":null},"isin":["US0378331005"],"media":null}]

Parameters

Name	Type	Description	Notes
request_body	List[str]

Authorization

JSON Web Token. Issued by Yukka.

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Successful Response	-
422	Validation Error	-