The Recommended Entity API returns a ranked list of financial entities that are suggested for the target user to research or read about; those entities that are considered most relevant to the user, according to their interests and the interests of similar users.
Financial entities are defined here as instruments, tickers, or other symbols that are used to identify a stock, share, company, organisation or other financial entity that a user is researching or trading.
Prerequisites
Before obtaining meaningful data from this API ensure that
- You have you API
apikey. Contact us to find out how to get access.- To personalise responses it is vital to capture an end user identifier as part of behaviour capture. Without such user ids, the api will not be able to return recommended entities.
Example Call
Querying the Recommended Entity API is as simple as making a call to the endpoint and including your apikey and a valid end user id.
Details of the request and response objects are given in Request/Response
{
"apikey": <your apikey>,
"max_results": 10,
"customer_enduser_id": <end user id>
}
curl -X 'POST' \
'https://personafinai.azurewebsites.net/v2/personalized/entity/recommended' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"apikey": <your apikey>,
"max_results": 10,
"customer_enduser_id": <end user id>
}'
The API will return a list of entity_id values corresponding to recommended entity symbols on the customer platform.
Request/Response
Request Object
The API request expects the following endpoint url and body parameters
POST https://personafinai.azurewebsites.net/v2/personalized/entity/recommended
| Field | Description |
|---|---|
| apikey string | Authentication key to use to retrieve data |
| maxresults _int | The number of results to return |
| customerenduser_id _string | Value used to identify user on target platform |
Response Object
The API will respond with an object containing the following
| Field | Description |
|---|---|
| entityguid _string | Corresponds to an internal value assigned to the recommended entity. This may be null depending on permissions enabled for your api |
| entityid _object | Corresponds to the identifying symbol or instrument associated with the recommended entity on the platform on the platform that the api key is enabled for. |
| unixlast_updated _datetime | Unix timestamp corresponding to the last time the recommendation was updated. |
| lastupdated _datetime | Datetime when the recommendation was last updated. |
| score float | The score associated with the recommendation. Can be used to rank and sort. |