Addepar Attributes

Attributes are qualitative and quantitative details that you can use to organize and analyze data in Addepar. Addepar comes with over 300 Standard Attributes and allows for creating Custom Attributes to record and calculate data that is not covered.

The Entities API, Positions API, and Groups API can be used to characterize entities, positions, and groups beyond their required resource attributes. All attributes are grouped under the "attributes" object of the resource. The exception is market data attributes, which cannot be retrieved.

đź‘Ť

The Attributes API can be used to discover attributes available for use in the Portfolio Query, Entities, and Positions APIs.

Attributes and their respective API field name can also be found in the application. Open Addepar, navigate to the Global Navigation bar and click on Firm Administration.

Select Attributes on the left menu under Data Configuration, and then select the attribute from the list to display its details, including its API Field Name.

Description

Example

Standard Attributes

Built-in attributes provided by Addepar.

These include descriptive details about portfolio owners, like the client’s name, and investments, like a
bond’s issue date or a security’s CUSIP.

Display Name: Asset Class

API Field Name: asset_class

Custom Attributes

Custom attributes are identified in the API with the prefix "custom" (to easily differentiate between standard and custom attributes), followed by the attribute's given name, and finally its Addepar attribute ID (to differentiate it from other, similarly-named custom attributes).

Display Name: GIC Taxonomy

API Field Name: _custom_gic_taxonomy_637951

Standard Attribute Example

Applying the above standard attribute "Asset Class" to an entity.

{
  "data":{
    "id":"207",
    "type":"entities",
    "attributes":{
      "asset_class":"Equity"
    }
  }
}

Custom Attribute Example

Applying the above custom attribute "GIC Taxonomy" to a position.

{
  "data":{
    "id":"61580665",
    "type":"positions",
    "attributes":{
      "_custom_gic_taxonomy_637951":[
        {
          "value":"Emerging Market"
        }
      ]
    }
  }
}

Output Types

Both standard and custom attributes can hold any of the below Addepar output types. See the "Usage" section of Attributes API to learn more about attribute applicability:

Output Type

Description

Example

Word

A string.

"Equities"

Number

A number.

100

Percentage

A percentage expressed as a decimal.

0.05

Date

A date in YYYY-MM-DD format.

"2017-03-30"

Yes/No

A boolean (true or false).

true

Currency

Currency code as a string

"USD"

Money Value

An object containing currency and value.

"value": 167.23}```

Time-Varying Attributes

Some Addepar Attributes and all Custom Attributes can support time-varying outputs to reflect changes in the attribute's value over time (for example, to record a change in a stock's geography by holding different values before or after a merger or another event).

All time-varying attributes have three required fields: date, value, and weight. Each field must be present, regardless of whether the field's value is null or non-null.

When the value of date is null, it means the value and weight apply at all points in time. When multiple dates are included for an attribute, it means the values of value and weight apply as of that date.

The value of weight must be a decimal. Non-decimals will cause an error. For example, using 1.0 instead of 1.

Some attributes can have multiple values on the same date. To represent this, weight takes on a decimal value or value less than one. For example, if a stock is listed in two sectors on the same date, and the stock is divided between the two sectors 50/50, the value of each sector's weight is 0.5.

The example below shows the different ways a time-varying attribute may appear.

"attributes":{
  "asset_class":[
    {
      "date":null,
      "value":"Equity",
      "weight":1.0
    }
  ],
  "country":[
    {
      "date":"2015-01-01",
      "value":"USA",
      "weight":1.0
    },
    {
      "date":"2018-01-01",
      "value":"2018-01-01",
      "weight":1.0
    }
  ],
  "sector":[
    {
      "date":"2018-01-01",
      "value":"CAD",
      "weight":1.0
    },
    {
      "date":"2018-01-01",
      "value":"Large Cap",
      "weight":0.5
    }
  ]
}

Money Value Attributes

All money value attributes have two required fields: value and currency. Both fields must be present. The example below shows how the money value Next Call Price attribute appears.

"attributes":{
  "call_price":{
    "value":100,
    "currency":"USD"
  }
}

Updated 11 months ago


Addepar Attributes


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.