Attributes

Attributes are qualitative and quantitative details you can use to organize and analyze data in Addepar. Use the Attributes API to discover the Addepar attributes available to your firm.

Read more about Addepar attributes here.

Base Route

/v1/attributes

Endpoints

GET
/v1/attributes
/v1/attributes/:id
/v1/attributes/:id/relationships/arguments
/v1/attributes/:id/arguments

Produces

JSON

Pagination

No

Application Permissions Required

"API Access: Create, edit, and delete" is required to retrieve available attributes.

OAuth Scopes

O

Resource Overview

Attributes are described by the below resource object attributes and will appear in successful GET responses.

Attribute

Description

Example

e

The output type of the attribute. String.

"

usage

Applicability of attribute. [String.]. See. "Usage" below.

]

display_name

Display name of the attribute. String.

"

category

Usage category for the attribute. String.

"

Usage

Usage

Description

s

Can be used in portfolio columns.

s

Can be used in portfolio groupings.

s

Can be used to portfolio filters.

s

Can be applied at the position level and will appear under additional attributes in the application.

s

Can be applied at the entity level and will appear under additional attributes in the application. These can also be applied to groups unless otherwise noted.

s

Can be applied at the entity level and will appear under the entities' attributes in the application.

Relationships

Relationship

Description

s

Possible settings that can be applied to each instance of an attribute.

"relationships": {
        "arguments": {
          "links": {
            "self": "/v1/attributes/value/relationships/arguments",
            "related": "/v1/attributes/value/arguments"
          },
          "data": [{
              "type": "arguments",
              "id": "time_point"
            },{
              "type": "arguments",
              "id": "adjusted"
            },
            {
              "type": "arguments",
              "id": "accrued"
            },
            {
              "type": "arguments",
              "id": "currency"
            }
          ]
        }
      }

Get All Attributes

Retrieves all attributes available to the user.

GET v1/attributes

Example:

GET https://examplefirm.addepar.com/api/v1/attributes
HTTP/1.1 200

{
  "data": [
    {
      "id": "time_weighted_return",
      "type": "attributes",
      "attributes": {
        "output_type": "Percent",
        "usage": [
          "groupings",
          "columns",
          "filters"
        ],
        "display_name": "TWR",
        "category": "Performance Metrics"
      },
      "relationships": {
        "arguments": {
          "links": {
            "self": "/v1/attributes/time_weighted_return/relationships/arguments",
            "related": "/v1/attributes/time_weighted_return/arguments"
          },
          "data": [{
              "type": "arguments",
              "id": "period"
            },
            {
              "type": "arguments",
              "id": "bucketed"
            },
            {
              "type": "arguments",
              "id": "adjusted"
            },
            {
              "type": "arguments",
              "id": "accrued"
            },
            {
              "type": "arguments",
              "id": "currency"
            },
            {
              "type": "arguments",
              "id": "annualized_default_false"
            }
          ]
        }
      },
      "links": {
        "self": "/v1/attributes/time_weighted_return"
      }
    },
    {
      "id": "value",
      "type": "attributes",
      "attributes": {
        "output_type": "Number",
        "usage": [
          "groupings",
          "columns",
          "filters"
        ],
        "display_name": "Value",
        "category": "Holding Details"
      },
      "relationships": {
        "arguments": {
          "links": {
            "self": "/v1/attributes/value/relationships/arguments",
            "related": "/v1/attributes/value/arguments"
          },
          "data": [{
              "type": "arguments",
              "id": "time_point"
            },{
              "type": "arguments",
              "id": "adjusted"
            },
            {
              "type": "arguments",
              "id": "accrued"
            },
            {
              "type": "arguments",
              "id": "currency"
            }
          ]
        }
      },
      "links": {
        "self": "/v1/attributes/value"
      }
    },
    {
      "id": "_custom_boolean_custom_1_419",
      "type": "attributes",
      "attributes": {
        "output_type": "Boolean",
        "usage": [
          "entity_custom_attributes",
          "groupings",
          "columns",
          "position_custom_attributes",
          "filters"
        ],
        "display_name": "Boolean Custom 1",
        "category": "Custom"
      },
      "relationships": {
        "arguments": {
          "links": {
            "self": "/v1/attributes/_custom_boolean_custom_1_419/relationships/arguments",
            "related": "/v1/attributes/_custom_boolean_custom_1_419/arguments"
          },
          "data": []
        }
      },
      "links": {
        "self": "/v1/attributes/_custom_boolean_custom_1_419"
      }
    }
  ],
  "included": [],
  "links": {
    "next": null
  }
}

Optional Query Parameters:

  • filter[category]: Cash Flows, Security Details, Holding Details, etc.
  • filter[usage]: One of columns, groupings, filters, positon_custom_attributes,entity_custom_attributes,entity_attributes.
  • filter[output_type]: One of Word, Boolean, Percent, Date, Currency, List, Number.

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: User lacks API permission or has not granted the appropriate scope

Get Attribute By ID

Retrieves the attribute with the given ID.

GET /v1/attributes/:id

Example:

GET https://examplefirm.addepar.com/api/v1/attributes/time_weighted_return
HTTP/1.1 200

{
  "data": {
    "id": "time_weighted_return",
    "type": "attributes",
    "attributes": {
      "output_type": "Percent",
      "usage": [
        "groupings",
        "columns"
      ],
      "display_name": "TWR",
      "category": "Performance Metrics"
    },
    "relationships": {
      "arguments": {
        "links": {
          "self": "/v1/attributes/time_weighted_return/relationships/arguments",
          "related": "/v1/attributes/time_weighted_return/arguments"
        },
        "data": [{
            "type": "arguments",
            "id": "period"
          },
          {
            "type": "arguments",
            "id": "excluded_fee_types"
          },
          {
            "type": "arguments",
            "id": "bucketed"
          },
          {
            "type": "arguments",
            "id": "adjusted"
          },
          {
            "type": "arguments",
            "id": "accrued"
          },
          {
            "type": "arguments",
            "id": "currency"
          },
          {
            "type": "arguments",
            "id": "annualized_default_false"
          }
        ]
      }
    },
    "links": {
      "self": "/v1/attributes/time_weighted_return"
    }
  },
  "included": []
}

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: User lacks API permission or has not granted the appropriate scope
  • 404 Not Found: Attribute does not exist

Get Arguments For Attribute

Retrieves the list of argument ids associated with the given attribute ID.

GET v1/attributes/:id/relationships/arguments

Example:

GET https://examplefirm.addepar.com/api/v1/attributes/time_weighted_return/relationships/arguments
HTTP/1.1 200

{
  "data": [{
      "id": "period",
      "type": "arguments"
    },
    {
      "id": "excluded_fee_types",
      "type": "arguments"
    },
    {
      "id": "bucketed",
      "type": "arguments"
    },
    {
      "id": "adjusted",
      "type": "arguments"
    },
    {
      "id": "accrued",
      "type": "arguments"
    },
    {
      "id": "currency",
      "type": "arguments"
    },
    {
      "id": "annualized_default_false",
      "type": "arguments"
    }
  ]
}

Responses:

  • 200 OK: Success
  • 403 Forbidden: User lacks API permission or has not granted the appropriate scope
  • 404 Not Found: Attribute does not exist

Get Argument Objects For Attribute

Retrieves the list of arguments associated with the given attribute ID.

GET /v1/attributes/:id/arguments

Example:

GET https://examplefirm.addepar.com/api/v1/attributes/cost_basis/arguments
HTTP/1.1 200

{
    "data": [
        {
            "id": "cost_basis_type",
            "type": "arguments",
            "attributes": {
                "values": [
                    "ORIGINAL",
                    "ADJUSTED",
                    "CALCULATED_ADJUSTED",
                    "CALCULATED_ADJUSTED_AMORTIZATION_ONLY",
                    "CALCULATED_ADJUSTED_ACCRETION_ONLY"
                ],
                "default_value": "ORIGINAL",
                "arg_type": "discrete"
            },
            "links": {
                "self": "/v1/arguments/cost_basis_type"
            }
        },
        {
            "id": "currency",
            "type": "arguments",
            "attributes": {
                "values": [
                    "NATIVE_CURRENCY",
                    "REF_CURRENCY",
                    "USD",
                    "EUR",
                    "GBP",
                    "AED",
                    "AFN",
                    "ALL",
                    "AMD",
                    "ANG",
                    "AOA",
                    "ARS",
                    "ATS",
                    "AUD",
                    "AWG",
                    "AZN",
                    "BAM",
                    "BBD",
                    "BDT",
                    "BEF",
                    "BGN",
                    "BHD",
                    "BIF",
                    "BMD",
                    "BND",
                    "BOB",
                    "BOV",
                    "BRL",
                    "BSD",
                    "BTC",
                    "BTN",
                    "BWP",
                    "BYN",
                    "BYR",
                    "BZD",
                    "CAD",
                    "CDF",
                    "CHF",
                    "CLF",
                    "CLP",
                    "CNH",
                    "CNY",
                    "COP",
                    "CRC",
                    "CUC",
                    "CUP",
                    "CYP",
                    "CVE",
                    "CZK",
                    "DEM",
                    "DJF",
                    "DKK",
                    "DOP",
                    "DZD",
                    "EEK",
                    "EGP",
                    "ERN",
                    "ESP",
                    "ETB",
                    "ETH",
                    "FIM",
                    "FJD",
                    "FRF",
                    "GEL",
                    "GGP",
                    "GHC",
                    "GHS",
                    "GIP",
                    "GMD",
                    "GNF",
                    "GRD",
                    "GTQ",
                    "GYD",
                    "HKD",
                    "HNL",
                    "HRK",
                    "HTG",
                    "HUF",
                    "IDR",
                    "IEP",
                    "ILS",
                    "IMP",
                    "INR",
                    "IQD",
                    "IRR",
                    "ISK",
                    "ITL",
                    "JEP",
                    "JMD",
                    "JOD",
                    "JPY",
                    "KES",
                    "KGS",
                    "KHR",
                    "KMF",
                    "KPW",
                    "KRW",
                    "KWD",
                    "KYD",
                    "KZT",
                    "LAK",
                    "LBP",
                    "LKR",
                    "LRD",
                    "LSL",
                    "LTC",
                    "LTL",
                    "LVL",
                    "LUF",
                    "LYD",
                    "MAD",
                    "MDL",
                    "MGA",
                    "MKD",
                    "MMK",
                    "MNT",
                    "MOP",
                    "MRO",
                    "MRU",
                    "MTL",
                    "MUR",
                    "MVQ",
                    "MVR",
                    "MWK",
                    "MXN",
                    "MXP",
                    "MXV",
                    "MYR",
                    "MZN",
                    "NAD",
                    "NGN",
                    "NIO",
                    "NLG",
                    "NOK",
                    "NPR",
                    "NZD",
                    "OMR",
                    "PAB",
                    "PEN",
                    "PGK",
                    "PHP",
                    "PKR",
                    "PLN",
                    "PTE",
                    "PYG",
                    "QAR",
                    "RON",
                    "RSD",
                    "RUB",
                    "RWF",
                    "SAR",
                    "SBD",
                    "SCR",
                    "SDG",
                    "SEK",
                    "SGD",
                    "SHP",
                    "SIT",
                    "SKK",
                    "SLL",
                    "SOS",
                    "SRD",
                    "STD",
                    "SVC",
                    "SYP",
                    "SZL",
                    "THB",
                    "TJS",
                    "TMT",
                    "TND",
                    "TOP",
                    "TRL",
                    "TRY",
                    "TTD",
                    "TVD",
                    "TWD",
                    "TZS",
                    "UAH",
                    "UGX",
                    "UYI",
                    "UYU",
                    "UZS",
                    "VEB",
                    "VEF",
                    "VND",
                    "VUV",
                    "WST",
                    "XAU",
                    "XCD",
                    "XEU",
                    "XOF",
                    "XRP",
                    "XPF",
                    "YER",
                    "YUD",
                    "ZAR",
                    "ZMK",
                    "ZMW",
                    "ZWD",
                    "ZWL"
                ],
                "default_value": null,
                "arg_type": "discrete"
            },
            "links": {
                "self": "/v1/arguments/currency"
            }
        },
        {
            "id": "excluding_fees",
            "type": "arguments",
            "attributes": {
                "values": [
                    true,
                    false
                ],
                "default_value": false,
                "arg_type": "boolean"
            },
            "links": {
                "self": "/v1/arguments/excluding_fees"
            }
        },
        {
            "id": "rollups_ignore_dashes",
            "type": "arguments",
            "attributes": {
                "values": [
                    true,
                    false
                ],
                "default_value": false,
                "arg_type": "boolean"
            },
            "links": {
                "self": "/v1/arguments/rollups_ignore_dashes"
            }
        },
        {
            "id": "time_point",
            "type": "arguments",
            "attributes": {
                "default_value": "current",
                "arg_type": "time_point"
            },
            "links": {
                "self": "/v1/arguments/time_point"
            }
        }
    ],
    "included": [],
    "links": {
        "next": null
    }
}

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: User lacks API permission or has not granted the appropriate scope
  • 404 Not Found: Attribute does not exist

Updated 15 days ago


What's Next

Time to try it out for yourself:

API Explorer: Attributes

Attributes


Suggested Edits are limited on API Reference Pages

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