---
title: "How do I retrieve a property or derived property for an entity?"
slug: "how-do-i-retrieve-a-property-or-derived-property-for-an-entity"
updated: 2024-09-17T10:49:44Z
published: 2024-09-17T10:49:44Z
canonical: "support.lusid.com/how-do-i-retrieve-a-property-or-derived-property-for-an-entity"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://support.lusid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How do I retrieve a property or derived property for an entity?

Providing you have suitable [access control permissions](/v1/docs/introduction-to-identity-management-and-access-control), you can explicitly request any number of [properties](/v1/docs/introduction-to-properties) and/or [derived properties](/v1/docs/what-is-a-derived-property) when you retrieve entities of a particular type from LUSID.

> **Note**: By default, LUSID does *not* retrieve properties; you must explicitly request them for most entities. Note it may be more intuitive to [retrieve time-variant properties as a time-series](/v1/docs/how-do-i-retrieve-a-time-variant-property-as-a-time-series).

For example, you could request that LUSID 'decorate' the `Instrument/BBG/AnalystRating` property onto instruments retrieved from the LUSID instrument master:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(18).png)

Note the following:

- LUSID may automatically decorate relevant [system properties](/v1/docs/what-is-a-system-property) onto some API responses. These are properties in the protected `default` and `system` scopes, for example `Holding/default/SourcePortfolioId`.
- For some entities such as transactions and holdings, you can additionally retrieve properties for other entities such as instruments and portfolios. [Find out more about this](/v1/docs/retrieving-properties-from-the-domains-of-other-types-of-entity).

There are several ways to retrieve properties for entities:

- [Using the LUSID REST API](/v1/docs/how-do-i-retrieve-a-property-or-derived-property-for-an-entity#using-the-lusid-rest-api)
- [Using the LUSID web app](/v1/docs/how-do-i-retrieve-a-property-or-derived-property-for-an-entity#using-the-lusid-web-app)
- If you have a Luminesce license, by [writing a SQL query](/v1/docs/how-do-i-configure-luminesce-entity-providers-to-readwrite-properties).

## Using the LUSID REST API

Most entity types have multiple APIs for retrieving entities of that type. For example, to retrieve instruments from the instrument master you can call:

- The [ListInstruments](https://www.lusid.com/docs/api#operation/ListInstruments) API to retrieve all instruments.
- The [GetInstruments](https://www.lusid.com/docs/api#operation/GetInstruments) API to retrieve all instruments with one or more identifier types, for example FIGI and/or ISIN.
- The [GetInstrument](https://www.lusid.com/docs/api#operation/GetInstrument) API to retrieve a single instrument with a particular identifier value, for example FIGI `BBG000BDLT47`.

Most API endpoints have a query parameter you can use to decorate properties onto entities, for example `instrumentPropertyKeys` for the `ListInstruments` API:

![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(19).png)

This parameter name might differ between endpoints; for example, it is `propertyKeys` for the `GetInstruments` API.

For example, to retrieve the `Instrument/BBG/AnalystRating` and `Instrument/BBG/Country` properties for a set of instruments:

1. [Obtain an API access token](/v1/docs/how-do-i-obtain-and-use-a-short-lived-api-access-token-from-okta).
2. Call the `ListInstruments` API for your LUSID domain, passing in your API access token and specifying the 3-stage key of each property as an argument to separate instances of the `instrumentPropertyKeys` query parameter, for example:

```powershell
curl -X POST "https://<your-domain>.lusid.com/api/api/instruments?instrumentPropertyKeys=Instrument%2FBBG%2FAnalystRating&instrumentPropertyKeys=Instrument%2FBBG%2FCountry"
  -H "Authorization: Bearer <your-API-access-token>"
```

It might be easier to understand using the equivalent method in the Python SDK. Here, 3-stage property keys are specified as comma-separated string values in a list passed to the `instrument_property_keys` parameter:

```python
response = instruments_api.list_instruments(
  instrument_property_keys = ["Instrument/BBG/AnalystRating", "Instrument/BBG/Country"]
)
```

## Using the LUSID web app

Most entity types have their own dashboard in the LUSID web app. You can add the property you want retrieve as a column in your view and filter for particular values.

For example, to retrieve the `Instrument/BBG/AnalystRating` and `Instrument/BBG/Country` properties for a set of instruments:

1. Sign in to the [LUSID web app](https://www.lusid.com/app/home).
2. Use the left-hand menu to navigate to **Data Management > Instruments**: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(100).png)
3. Select the **Configuration** button: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(101).png)
4. Select **Add column**: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(102).png)
5. Choose the properties you want to retrieve. Then, select **Submit** and **Save**: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(105).png)
6. With the properties added to your dashboard view, you can filter for the values you want. For example, you might apply a filter to retrieve instruments where a value exists for the `Instrument/BBG/AnalystRating` property: ![](https://cdn.document360.io/d575ad81-c0ed-4980-bbd1-d59ac5c3de82/Images/Documentation/image(104).png)