The top entity API returns a ranked list of the most popular financial entities over the last 24h; popularity based on the behaviour of the entire user base. 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 users are 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 get consensus insights, it is vital to ensure that behaviour capture is properly installed on your user platform. Without capturing user interactions, the API's will be unable to return any relevant user analytics or insights.
Example Call
Querying the top entity API is as simple as making a call to the endpoint and including your apikey.
Details of the request and response objects are given in Request/Response
{
"apikey": <your apikey>,
"max_results": 10
}
curl -X 'POST' \
'https://personafinai.azurewebsites.net/v2/consensus/entity/top' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"apikey": <your apikey>,
"max_results": 10
}'
The API will return a list of identifier values corresponding to popular entity symbols.
Request/Response
Request Object
The API request expects the following endpoint url and body parameters
POST https://personafinai.azurewebsites.net/v2/consensus/entity/top
| Field | Description |
|---|---|
| apikey string | Authentication key to use to retrieve data |
| maxresults _int | The number of results to return |
Response Object
The API will respond with an object containing the following
| Field | Description |
|---|---|
| updated datetime | Datetime that the dataset returned was last computed for the consensus. |
| dataPoints object | List of the top items found |
| dataPoints.identifier string | A financial symbol, ticker, or other value corresponding to a financial entity |
| dataPoints.distribution float | The items rank score relative to the other items |
| dataPoints.count int | The volume of interactions found against the specific item |