Holdings

The holdings endpoint contains the holdings (or positions) of your entities. For each date where holdings are received from a custodian, data will be available in the holdings endpoint once standardised through the data processing layer. 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 holdings endpoint, specifying the entityId of the entity being requested. In the response, the results of shown per holding, which is an asset held on a date. All results within that JSON level (for example, quantity, unit price) pertain to that holding.

get

Path parameters

entityIdinteger · int64Required

Unique identifier provided by Landytech

Example: 123

Query parameters

fromDatestring · dateOptional

Start of Date Range (Inclusive)

Example: 2024-01-01

toDatestring · dateOptional

End of Date Range (Inclusive)

Example: 2024-12-31

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

HTTPcURLJavaScriptPython

GET /api/v1/holdings/{entityId} HTTP/1.1
Host: data.api.landytech.net
Accept: */*

200

OK

{
  "content": [
    {
      "entityId": 36403,
      "date": "2024-02-09",
      "entityName": "HSBC (7095754)",
      "assetName": "Apple Inc",
      "assetId": 1016,
      "assetType": "Common Stock",
      "isin": "US0378331005",
      "quantity": 300,
      "localCurrency": "USD",
      "unitPrice": 188.85,
      "marketValueLc": 56655,
      "riskCountry": "United States",
      "marketCapValue": 2916202840064,
      "marketCapCurrency": "USD"
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "last": true,
  "size": 100,
  "first": true,
  "number": 0,
  "numberOfElements": 1,
  "empty": false
}