Sesame Data
  • Introduction
  • Authentication
    • Create and manage your API token
    • How to Authenticate
    • IP Whitelisting
  • API Endpoints
    • Entity List
    • Entity Dates
    • Transactions
    • Holdings
    • Sub Portfolio Holdings
    • Entity Risk
    • Asset Risk
    • Entity Performance
  • Sesame Data Developer Portal
  • Data Feeds
  • Tutorials/Recipes
    • How to use pagination
    • Using Sesame Data with Postman
    • Using Sesame Data with Excel
    • Using Sesame Data with PowerBi
  • FAQ and Troubleshooting
    • Viewing Logs
    • Glossary
Powered by GitBook
On this page

Was this helpful?

  1. API Endpoints

Entity Performance

PreviousAsset RiskNextSesame Data Developer Portal

Last updated 1 year ago

Was this helpful?

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.

get
Path parameters
entityIdinteger · int64Required

Unique identifier provided by Landytech

Example: 123
Query parameters
fromDatestring · dateOptional

Start of Date Range (Inclusive)

Example: 2025-05-01
toDatestring · dateOptional

End of Date Range (Inclusive)

Example: 2025-05-13
lookThroughstringOptional

Enable/disable look through

Default: false
pageNumberinteger · int32Optional

The current page, the first page should be '0'

Default: 0
pageSizeinteger · int32 · max: 100Optional

Number of records per page

Default: 100
Responses
200
OK
application/json
get
GET /api/v1/entityperformance/{entityId} HTTP/1.1
Host: data.api.landytech.net
Accept: */*
200

OK

{
  "content": [
    {
      "entityId": 36403,
      "entityName": "HSBC (7095754)",
      "date": "2025-05-13",
      "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
}
  • Request and Response
  • GET/api/v1/entityperformance/{entityId}