Valuations

Download Spec

All valuations related paths.

Get current valuation for an account

get /accounts/{account_id}/valuations/current

Get current valuation for an account

price_quality

string

required

Defines the quality of the price used in the valuation.

Enum
  • EOD
  • HIGHEST_AVAILABLE

Response

ExamplesSchema

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-09T00:00:00Z"
      },
      "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-09T00:00:00Z"
      },
      "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"
    }
  ]
}

List valuation history for an account

get /accounts/{account_id}/valuations

List valuation history for an account

start_date

string

date

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

Example
"2023-01-03"

end_date

string

date

Returns account valuations up until this date (UTC)

Example
"2023-01-11"

sort

string

Sort the result by valuation_time.

Default
"valuation_time"
Enum
  • valuation_time

order

string

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

offset

int

i32

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

Min
0

limit

int

i32

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

Default
100
Min
0
Max
1000

Response

ExamplesSchema

Valuations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "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-09T00:00:00Z"
          },
          "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-09T00:00:00Z"
          },
          "quantity": "1.00",
          "weight": "0.263405"
        },
        {
          "instrument": {
            "uuid": "7499ccf8-6fa5-43ef-af9e-dd062e10ab59",
            "isin": "SE0019889775"
          },
          "quantity": "5.00",
          "value": null,
          "weight": null
        }
      ]
    }
  ]
}

Account valuation events

webhook

Account valuation events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Enum
  • ACCOUNT_VALUATION.CREATED

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Response

ExamplesSchema

Request has been processed successfully.

Empty response

Intraday account valuation events

webhook

Intraday account valuation events

id

string

uuid

required

Event unique identifier

created_at

string

date-time

required

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

type

string

required

Event type

Enum
  • INTRADAY_ACCOUNT_VALUATION.CREATED

object

object (object)

required

webhook_id

string

uuid

required

Webhook unique identifier.

Response

ExamplesSchema

Request has been processed successfully.

Empty response