API status
  • Balances

Valuations

All valuations related paths.

get

Get current valuation for an account

Get current valuation for an account

price_qualitystring

required

Defines the quality of the price used in the valuation.

Enum
  • EOD
  • HIGHEST_AVAILABLE

Responses

Response examples

Valuations

{
  "id": "404b170a-9042-11ed-9a51-2eabd0c03f8a",
  "created_at": "2023-01-10T14:15:22Z",
  "updated_at": "2023-01-10T14:15:22Z",
  "valuation_time": "2023-01-10T14:15:22Z",
  "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a",
  "price_quality": "EOD",
  "total_security_value": {
    "amount": "142.29",
    "currency": "EUR"
  },
  "security_positions": [
    {
      "instrument": {
        "uuid": "123e4567-e89b-12d3-a456-426614174000",
        "isin": "DE0007664005"
      },
      "value": {
        "amount": "104.81",
        "currency": "EUR",
        "price_time": "2023-01-09"
      },
      "quantity": "0.65",
      "weight": "0.736595",
      "price_quality": "EOD"
    },
    {
      "instrument": {
        "uuid": "48b798b7-3a62-4f30-8307-ee94d35b21b7",
        "isin": "FR0010524777"
      },
      "value": {
        "amount": "37.48",
        "currency": "EUR",
        "price_time": "2023-01-09"
      },
      "quantity": "1.00",
      "weight": "0.263405",
      "price_quality": "EOD"
    },
    {
      "instrument": {
        "uuid": "7499ccf8-6fa5-43ef-af9e-dd062e10ab59",
        "isin": "SE0019889775"
      },
      "quantity": "5.00",
      "value": null,
      "weight": null,
      "price_quality": "NA"
    }
  ]
}
get

List valuation history for an account

List valuation history for an account

start_datestring

Returns account valuations starting from and including this date (UTC)

Format
date
Example
"2023-01-03"
end_datestring

Returns account valuations up until this date (UTC)

Format
date
Example
"2023-01-11"
sortstring

Sort the result by valuation_time.

Default
"valuation_time"
Enum
  • valuation_time
orderstring

Sort order of the result list if the sort parameter is specified. Use ASC for ascending or DESC for descending sort order.

Default
"ASC"
Enum
  • ASC
  • DESC
offsetint

Use the offset argument to specify where in the list of results to start when returning items for a particular query.

Format
int32
Min
0
limitint

Use the limit argument to specify the maximum number of items returned.

Format
int32
Default
100
Min
0
Max
1000

Responses

Response examples

Valuations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 3,
    "total_count": 3,
    "sort": "created_at",
    "order": "ASC"
  },
  "data": [
    {
      "id": "404b170a-9042-11ed-9a51-2eabd0c03f8a",
      "created_at": "2023-01-10T14:15:22Z",
      "updated_at": "2023-01-10T14:15:22Z",
      "valuation_time": "2023-01-10T14:15:22Z",
      "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a",
      "price_quality": "EOD",
      "total_security_value": {
        "amount": "142.29",
        "currency": "EUR"
      },
      "security_positions": [
        {
          "instrument": {
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "isin": "DE0007664005"
          },
          "value": {
            "amount": "104.81",
            "currency": "EUR",
            "price_time": "2023-01-09"
          },
          "quantity": "0.65",
          "weight": "0.736595"
        },
        {
          "instrument": {
            "uuid": "48b798b7-3a62-4f30-8307-ee94d35b21b7",
            "isin": "FR0010524777"
          },
          "value": {
            "amount": "37.48",
            "currency": "EUR",
            "price_time": "2023-01-09"
          },
          "quantity": "1.00",
          "weight": "0.263405"
        },
        {
          "instrument": {
            "uuid": "7499ccf8-6fa5-43ef-af9e-dd062e10ab59",
            "isin": "SE0019889775"
          },
          "quantity": "5.00",
          "value": null,
          "weight": null
        }
      ]
    },
    {
      "id": "adfbf024-3d31-11ef-b99b-2eabd0c03f8a",
      "created_at": "2023-01-11T14:15:22Z",
      "updated_at": "2023-01-11T14:15:22Z",
      "valuation_time": "2023-01-11T14:15:22Z",
      "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a",
      "price_quality": "EOD",
      "total_security_value": {
        "amount": "104.81",
        "currency": "EUR"
      },
      "security_positions": [
        {
          "instrument": {
            "uuid": "123e4567-e89b-12d3-a456-426614174000",
            "isin": "DE0007664005"
          },
          "value": {
            "amount": "104.81",
            "currency": "EUR",
            "price_time": "2023-01-10"
          },
          "quantity": "0.65",
          "weight": "1"
        }
      ]
    },
    {
      "id": "be38000e-3d31-11ef-ac4e-2eabd0c03f8a",
      "created_at": "2023-01-12T14:15:22Z",
      "updated_at": "2023-01-12T14:15:22Z",
      "valuation_time": "2023-01-12T14:15:22Z",
      "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a",
      "price_quality": "EOD",
      "total_security_value": {
        "amount": "0",
        "currency": "EUR"
      },
      "security_positions": []
    }
  ]
}
webhook

Account valuation events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Enum
  • ACCOUNT_VALUATION.CREATED
objectobject (Account Valuation)

required

idstring

required

Account valuation unique identifier.

Format
uuid
created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format
date-time
updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format
date-time
account_idstring

required

Account unique identifier.

Format
uuid
total_security_valueobject (Total security value)

required

Entity representing the monetary value by amount and currency.

price_qualitystring

required

The requested price quality.

  • EOD - End of day prices
  • HIGHEST_AVAILABLE - The most recent available prices
Enum
  • EOD
  • HIGHEST_AVAILABLE
security_positionsarray

Positions associated with this account valuation.

valuation_timestring

required

Date and time as of which the value was calculated. RFC 3339-5, ISO8601 UTC

Format
date-time
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "created_at": "2023-01-10T00:15:32Z",
  "type": "ACCOUNT_VALUATION.CREATED",
  "object": {
    "id": "404b170a-9042-11ed-9a51-2eabd0c03f8a",
    "created_at": "2023-01-10T00:15:22Z",
    "updated_at": "2023-01-10T00:15:22Z",
    "valuation_time": "2023-01-10T00:15:22Z",
    "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a",
    "price_quality": "EOD",
    "total_security_value": {
      "amount": "142.29",
      "currency": "EUR"
    },
    "security_positions": [
      {
        "instrument": {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "isin": "DE0007664005"
        },
        "value": {
          "amount": "104.81",
          "currency": "EUR",
          "price_time": "2023-01-09"
        },
        "quantity": "0.65",
        "weight": "0.736595"
      },
      {
        "instrument": {
          "uuid": "48b798b7-3a62-4f30-8307-ee94d35b21b7",
          "isin": "FR0010524777"
        },
        "value": {
          "amount": "37.48",
          "currency": "EUR",
          "price_time": "2023-01-09"
        },
        "quantity": "1.00",
        "weight": "0.263405"
      }
    ]
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Intraday account valuation events

idstring

required

Event unique identifier

Format
uuid
created_atstring

required

Date and time when the event was created. RFC 3339-5, ISO8601 UTC

Format
date-time
typestring

required

Event type

Enum
  • INTRADAY_ACCOUNT_VALUATION.CREATED
objectobject (Account Valuation)

required

idstring

required

Account valuation unique identifier.

Format
uuid
created_atstring

required

Date and time when the resource was created. RFC 3339-5, ISO8601 UTC

Format
date-time
updated_atstring

required

Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC

Format
date-time
account_idstring

required

Account unique identifier.

Format
uuid
total_security_valueobject (Total security value)

required

Entity representing the monetary value by amount and currency.

price_qualitystring

required

The requested price quality.

  • EOD - End of day prices
  • HIGHEST_AVAILABLE - The most recent available prices
Enum
  • EOD
  • HIGHEST_AVAILABLE
security_positionsarray

Positions associated with this account valuation.

valuation_timestring

required

Date and time as of which the value was calculated. RFC 3339-5, ISO8601 UTC

Format
date-time
webhook_idstring

required

Webhook unique identifier.

Format
uuid

Responses

Request examples

{
  "id": "8962b496-8d42-4560-bfab-10490dd1a722",
  "created_at": "2023-01-10T14:15:32Z",
  "type": "INTRADAY_ACCOUNT_VALUATION.CREATED",
  "object": {
    "id": "404b170a-9042-11ed-9a51-2eabd0c03f8b",
    "created_at": "2023-01-10T14:15:22Z",
    "updated_at": "2023-01-10T14:15:22Z",
    "valuation_time": "2023-01-10T14:15:22Z",
    "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a",
    "price_quality": "EOD",
    "total_security_value": {
      "amount": "142.29",
      "currency": "EUR"
    },
    "security_positions": [
      {
        "instrument": {
          "uuid": "123e4567-e89b-12d3-a456-426614174000",
          "isin": "DE0007664005"
        },
        "value": {
          "amount": "104.81",
          "currency": "EUR",
          "price_time": "2023-01-09"
        },
        "quantity": "0.65",
        "weight": "0.736595"
      },
      {
        "instrument": {
          "uuid": "48b798b7-3a62-4f30-8307-ee94d35b21b7",
          "isin": "FR0010524777"
        },
        "value": {
          "amount": "37.48",
          "currency": "EUR",
          "price_time": "2023-01-09"
        },
        "quantity": "1.00",
        "weight": "0.263405"
      }
    ]
  },
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee7"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?