Composite Securities (limited access)

Composite securities are investments made up of underlying "constituent" securities. Common examples of composite securities are ETFs, mutual funds, and benchmarks.

You can track underlying constituent data in Addepar to deepen your analysis of composite securities. Use the Composite Securities API to get, create, and delete constituent weights in Addepar.

Addepar currently only supports constituent data for ETFs. We plan to expand this functionality to more investments over time.

ℹ️

Limited access

Only a few firms can currently manage ETF constituent data in Addepar. We'll increase access when we add more functionality. Reach out to your Addepar contact if you have questions.

Base route/v1/composite_securities
EndpointsGET
/v1/composite_securities/:id/:constituentId

POST
/v1/composite_securities

DELETE
/v1/composite_securities/:id/:date
ProducesJSON
PaginationYes
Application permissions required"API Access: Create, edit, and delete"
OAuth scopesGET
COMPOSITE_SECURITIES_READ

POST and DELETE
COMPOSITE_SECURITIES_WRITE

Resource overview

Composite securities are described by the below attributes. Required attributes are noted in the description.

AttributeDescriptionExample
dateThe date of the composite security’s constituent weights. String. Required."2024-01-01"
constituentsA list of objects forming the composite security’s constituents for the specified date. See below for object details. Required.See below.

Constituent object

The constituent object represents a constituent security and its weighting in the composite security on a particular date.

AttributeDescriptionExample
entityIdThe constituent security entity, identified by its Entity ID. Number. Required.199
percentageThe constituent security's weight. Number. Required.0.42

Get constituent weight

Returns a constituent's weight data from within a composite security. Only one constituent can be retrieved per request. If you don't provide a start date or end date, all weights will be returned.

GET /v1/composite_securities/:id/:constituentId

  • startDate: The start date for the constituent data (optional)
  • endDate: The end date for the constituent data (optional)

Example

GET https://examplefirm.addepar.com/api/v1/composite_securities/58/199&startDate=2024-01-01
HTTP/1.1 200

{
    "data": {
        "id": "58",
        "type": "constituent_values",
        "attributes": {
            "values": [
                {
                    "2024-01-01": 0.42
                },
                {
                    "2024-01-02": 0.45
                }
            ]
        }
    },
    "included": []
}

Response codes

  • 200 Success: Success
  • 400 Bad Request: Invalid query parameters
  • 400 Bad Request: Composite Security ID or Constituent ID do not refer to valid entities
  • 404 Not Found: Composite Security ID or Constituent ID not found

Create constituent weight

Adds new constituent weight data to a composite security on a specific date.

POST /v1/composite_securities

Example

POST https://examplefirm.addepar.com/api/v1/composite_securities

{
  "data": {
    "type": "composite_security",
    "id": "58",
    "attributes":{
      "date": "2024-01-01",
      "constituents": [
        {
          "entityId": 199,
          "percentage": 0.42
        },
        {
          "entityId": 200,
          "percentage": 0.58
        }
      ]
    }
  }
}
HTTP/1.1 200

{
    "data": {
        "id": "58",
        "type": "composite_security",
        "attributes": {
            "date": "2024-01-01",
            "constituents": [
                {
                    "entityId": 199,
                    "percentage": 0.42
                },
                {
                    "entityId": 200,
                    "percentage": 0.58
                }
            ]
        }
    },
    "included": []
}

Response codes

  • 201 Created: Created
  • 400 Bad Request: Composite Security ID is found in the constituent list
  • 400 Bad Request: Composite Security ID or Constituent ID do not refer to valid entities
  • 400 Bad Request: Duplicate Constituent ID

Delete constituent weight

Removes all constituent weight data from a composite security on a specific date.

DELETE /v1/composite_securities/:id/:date

Example

GET https://examplefirm.addepar.com/api/v1/composite_securities/58/2024-01-01
HTTP/1.1 204

Response codes

  • 204 No Content: Deleted