View as Markdown

Asset classes

Data model

Asset class

JSON:API resource type asset-class.

namestring

Required. Display name of the asset class.

Asset class detailed

JSON:API resource type asset-class-detailed.

namestring

Required. Display name of the detailed asset class.

Relationships

assetClassasset-class

The asset class that the detailed asset class belongs to.

GET/api/v2/asset-classes/{id}

Retrieve an asset class

Fetch the asset class with the given id.

Parameters

idstring

Path, required. Asset class identifier.

Request
GET/api/v2/asset-classes/{id}
curl https://api.aleta.ai/api/v2/asset-classes/5e6a90cf921d8b1874c32ed5 \
  -H "Authorization: Bearer {access_token}"
Response
{
  "data": {
    "id": "f2d93a1df9ffeb8aa6c140be",
    "type": "asset-class",
    "attributes": {
      "name": "Equities"
    }
  }
}
GET/api/v2/asset-classes-detailed/{id}

Retrieve a detailed asset class

Fetch the detailed asset class with the given id.

Parameters

idstring

Path, required. Detailed asset class identifier.

Request
GET/api/v2/asset-classes-detailed/{id}
curl https://api.aleta.ai/api/v2/asset-classes-detailed/5e6a90cf921d8b1874c32ed5 \
  -H "Authorization: Bearer {access_token}"
Response
{
  "data": {
    "id": "68c280b298f321781b449771",
    "type": "asset-class-detailed",
    "attributes": {
      "name": "Equities - American"
    },
    "relationships": {
      "assetClass": {
        "data": {
          "type": "asset-class",
          "id": "f2d93a1df9ffeb8aa6c140be"
        }
      }
    }
  }
}

Related