Entity Types

Entity Types describe the characteristics of available entities, including associated attributes, attributes required for creation, and which attributes are editable. Use the Entity Types API in conjunction with the Entities API to discover, create, and edit entities more easily.

Base Route/v1/entity_types
EndpointsGET
/v1/entity_types
/v1/entity_types/:id
ProducesJSON
PaginationNo
Application Permissions Required"API Access: Create, edit, and delete" is required to retrieve available entity types.
OAuth ScopesENTITIES or ENTITIES_WRITE

Resource Overview

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

AttributeDescriptionExample
display_nameDisplay name of the entity type. String."Person"
categoryCategory for the entity type. String."Security"
ownership_typeOwnership type of the entity. String."share_based"
entity_attributesAttribute properties. Object.See Entity Attributes

Entity Attributes

AttributeDescriptonExample
keyThe ID of the entity attribute. String."currency_factor"
requiredSpecifies if attribute is required for entity creation or modification. Boolean.true
writabilityIndicates whether attribute can be modified. String.

- MUTABLE: Can be edited with permission.
- IMMUTABLE: Cannot be set or modified.
- FINAL: Can be set upon entity creation but cannot be modified.
- RESTRICTED_FOR_ONLINE: Requires "edit online data" permissions to modify.
"MUTABLE"

Get All Entities Types

Returns a list of all entity types.

GET /v1/entity_types

Example:

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

{
    "data": [
      {
        "id": "person_node",
        "type": "entity_types",
        "attributes": {
          "entity_attributes": [
            {
              "key": "currency_factor",
              "required": true,
              "writability": "MUTABLE"
            },
            {
              "key": "original_name",
              "required": false,
              "writability": "MUTABLE"
            },
            {
              "key": "display_name",
              "required": false,
              "writability": "MUTABLE"
            }
          ],
          "display_name": "Person",
        },
        "links": {
          "self": "/v1/entity_types/person_node"
        }
      },
      {
        "id": "stock",
        "type": "entity_types",
        "attributes": {
          "ownership_type": "share_based",
          "entity_attributes": [
            {
              "key": "currency_factor",
              "required": true,
              "writability": "IMMUTABLE"
            },
            {
              "key": "original_name",
              "required": true,
              "writability": "IMMUTABLE"
            },
            {
              "key": "ownership_type",
              "required": true,
              "writability": "IMMUTABLE"
            },
            {
              "key": "ticker_symbol",
              "required": false,
              "writability": "IMMUTABLE"
            },
            {
              "key": "display_name",
              "required": false,
              "writability": "MUTABLE"
            },
            {
              "key": "cusip",
              "required": false,
              "writability": "IMMUTABLE"
            },
            {
              "key": "isin",
              "required": false,
              "writability": "IMMUTABLE"
            },
            {
              "key": "sedol",
              "required": false,
              "writability": "IMMUTABLE"
            },
            {
              "key": "secid_id",
              "required": false,
              "writability": "IMMUTABLE"
            },
            {
              "key": "secid_element_type",
              "required": false,
              "writability": "IMMUTABLE"
            },
            {
              "key": "secid_verification_state",
              "required": false,
              "writability": "IMMUTABLE"
            }
          ],
          "category": "Security",
          "display_name": "Stock",
        },
        "links": {
          "self": "/v1/entity_types/stock"
        }
      }
    ],
    "included": [],
    "links": {
        "next": null
    }
}

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: Insufficient application permissions or appropriate scope not granted

Get Entity Type By ID

Returns an entity type object corresponding to the given ID.

GET /v1/entity_types/:id

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

{
  "data": {
    "id": "bond",
    "type": "entity_types",
    "attributes": {
      "ownership_type": "share_based",
      "entity_attributes": [
        {
          "key": "currency_factor",
          "required": true,
          "writability": "MUTABLE"
        },
        {
          "key": "original_name",
          "required": true,
          "writability": "IMMUTABLE"
        },
        {
          "key": "ownership_type",
          "required": true,
          "writability": "IMMUTABLE"
        },
        {
          "key": "display_name",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "cusip",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "isin",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "sedol",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "bond_type",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "coupon_rate",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "coupon_type",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "bond_frequency",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "original_principal_per_share",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "issue_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "dated_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "accrual_start_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "first_payment_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "last_payment_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "maturity_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "day_count_convention",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "call_info",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "is_prerefunded",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "secid_id",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "secid_element_type",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "secid_verification_state",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "coupon_cap",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "coupon_floor",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "reset_frequency",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "first_variable_coupon_date",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "floating_index",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "floating_spread",
          "required": false,
          "writability": "IMMUTABLE"
        },
        {
          "key": "actual_security_type",
          "required": false,
          "writability": "IMMUTABLE"
        }
      ],
      "category": "Security",
      "display_name": "Bond",
    },
    "links": {
      "self": "/v1/entity_types/bond"
    }
  },
  "included": []
}

Response Codes:

  • 200 OK: Success
  • 403 Forbidden: Insufficient application permissions or appropriate scope not granted
  • 404 Not Found: Invalid Entity Type