Entity Performance

Only available for Sesame Enterprise clients

The entityperformance endpoint returns performance metrics per date for the entity requested. Some metrics are returns, provided in decimals, while others are in the entity's reporting currency. The request can be made for specific dates, or for all dates for which there is data (ie no date filters). Requests are made using the entityId parameter, which is mandatory.

For the full list of parameters accepted as well as which are required, see Parameters below. To view Sample response data, expand the menu under Responses and refer to the Example tab. To see the format of the response fields, as well as which are mandatory (that is, always returned in the response), select the tab Schema, and then expand object followed by content and finally object once more.

Request and Response

You might find it helpful to access our Sesame Data Developer Portal

The format of all Sesame Custodial Data APIs is the same. The user is required to provide their account UUID and token in the authorisation, and then make a GET request to the entityperformance endpoint, specifying the entityId of the entity being requested.

GEThttps://data.api.landytech.net/api/v1/entityperformance/{entityId}

Path parameters

entityId*integer (int64)

Unique identifier provided by Landytech

Example: 123

Query parameters

Response

200

OK

Body

application/json

content*array of EntityPerformanceDto (object)

totalPages*integer (int64)

Number of pages

Example: 1

totalElements*integer (int64)

Number of elements across all pages

Example: 1

last*boolean

Last page

Example: true

size*integer (int64)

Number of elements in one page

Example: 100

first*boolean

First page

Example: true

number*integer (int64)

Current page number

Example: 0

numberOfElements*integer (int64)

Number of elements in the page

Example: 1

empty*boolean

Empty

Example: false

Request

JavaScriptCurlPython

const response = await fetch('https://data.api.landytech.net/api/v1/entityperformance/{entityId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "content": [
    {
      "entityId": 36403,
      "entityName": "HSBC (7095754)",
      "date": "2024-02-08",
      "entityBaseCurrency": "GBP",
      "return1Month": 0.014932,
      "return3Months": 0.077934,
      "return6Months": 0.105256,
      "return12Months": 0.145604,
      "mtd": 0.005345,
      "qtd": 0.020277,
      "ytd": 0.020277,
      "fytd": 0.135429,
      "itd": 0.864921,
      "monthToDate": 53654.03,
      "quarterToDate": 200205.6,
      "yearToDate": 200205.6,
      "total": 7649087
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "last": true,
  "size": 100,
  "first": true,
  "number": 0,
  "numberOfElements": 1,
  "empty": false
}