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

OAuth2 oauth-client-credentials

Required Scopes:

valuations:read

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:read · Read reports
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

account_id

string

uuid

required

Account unique identifier.

price_quality

string

required

Defines the quality of the price used in the valuation.

Enum
  • EOD

Response

Examples Schema

Valuations

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

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

id

string

uuid

required

Account valuation unique identifier.

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

account_id

string

uuid

required

Account unique identifier.

total_security_value

object (total_security_value)

required

Entity representing the monetary value by amount and currency.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

price_quality

string

required

Price quality used for the calculation of the account valuation.

  • EOD - end of day price
Default
"EOD"
Enum
  • EOD

security_positions

array[object (Account valuation security position)]

Positions associated with this account valuation.

Account valuation security position

object (Account valuation security position)

instrument

object (instrument)

required

Entity representing the financial instrument.

uuid

string

uuid

required

String representing the instrument internal identifier.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

quantity

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

value

object (value) or null

required

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

price_time

string

date-time

required

The date and time of the price used for the calculation. RFC 3339-5, ISO8601 UTC

weight

string or null

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

valuation_time

string

date-time

required

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

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

List valuation history for an account

get /accounts/{account_id}/valuations

List valuation history for an account

OAuth2 oauth-client-credentials

Required Scopes:

valuations:read

All Scopes

  • account_liquidations:admin · Trigger/read/cancel accounts liquidations
  • account_liquidations:read · Read accounts liquidations
  • account_returns:read · Read accounts returns
  • accounts:admin · Create/update/delete accounts and account groups
  • accounts:read · Read accounts and account groups
  • checks:admin · Create checks
  • checks:read · Read checks
  • credit_fundings:read · Credit Fundings read operations
  • fees:admin · Create and read fee operations
  • fees:read · Read fee operations
  • instruments:read · Read instruments
  • mandates:admin · Create/update/delete mandates
  • mandates:read · Read mandates
  • orders:admin · Create/update/delete orders
  • orders:read · Read orders
  • payments:admin · Payins and withdrawal operations
  • payments:read · Payins and withdrawal read operations
  • portfolios:admin · Modify portfolios
  • portfolios:read · Read portfolios
  • positions:read · Read positions
  • reference_accounts:admin · Create/update/delete reference accounts
  • reference_accounts:read · Read reference accounts
  • reports:read · Read reports
  • taxes:admin · Modify tax residencies
  • taxes:read · Read tax residencies
  • topups:admin · Topups operations
  • topups:read · Topups read operations
  • transactions:read · Read cash and securities transactions
  • users:admin · Create/update/delete users
  • users:read · Read users
  • valuations:read · Read valuations
  • webhooks:admin · Create/update/delete webhooks
  • webhooks:read · Read webhooks
Flow Type:
Client Credentials
Token URL:
https://sandbox.upvest.co/auth/token

upvest-client-id

string

uuid

required

Tenant Client ID

Example
"ebabcf4d-61c3-4942-875c-e265a7c2d062"

authorization

string

^Bearer [a-zA-Z0-9\-\._~+/]*=*

required

Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750

Example
"Bearer c2VjcmV0Cg=="

signature

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-input

string

required

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-version

string

Upvest API version (Note: Do not include quotation marks)

Default
"1"
Enum
  • 1
Example
1

account_id

string

uuid

required

Account unique identifier.

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

Examples Schema

Valuations

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

Bad Request. The incoming request had a malformed parameter/object.

{
  "status": 400,
  "type": "bad_request"
}

Unauthorized. The caller has not been authenticated.

{
  "status": 401,
  "type": "unauthorized"
}

Forbidden. The caller has been authenticated but is not allowed to take the requested action.

{
  "status": 403,
  "type": "forbidden"
}

Not Found. The requested resource could not be found.

{
  "status": 404,
  "type": "not_found"
}

Method Not Allowed. The requested method is not allowed on the requested resource.

{
  "status": 405,
  "type": "method_not_allowed"
}

Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.

{
  "status": 406,
  "type": "not_acceptable"
}

Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.

{
  "status": 429,
  "type": "too_many_requests"
}

Internal Server Error. The service encountered an unexpected error.

{
  "status": 500,
  "type": "internal_server_error"
}

Service Unavailable. The service handling for this request cannot be reached at this time.

{
  "status": 503,
  "type": "method_not_allowed"
}

Gateway Timeout. The service gateway has reached its internal timeout.

{
  "status": 504,
  "type": "gateway_timeout"
}

meta

object (meta)

required

offset

int

required

Amount of resource to offset in the response.

limit

int

required

Total limit of the response.

count

int

required

Count of the resources returned in the response.

total_count

int

required

Total count of all the resources.

sort

string

The field that the list is sorted by.

order

string

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum
  • ASC
  • DESC

data

array[object (Account Valuation)]

required

Account Valuation

object (Account Valuation)

id

string

uuid

required

Account valuation unique identifier.

created_at

string

date-time

required

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

updated_at

string

date-time

required

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

account_id

string

uuid

required

Account unique identifier.

total_security_value

object (total_security_value)

required

Entity representing the monetary value by amount and currency.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

price_quality

string

required

Price quality used for the calculation of the account valuation.

  • EOD - end of day price
Default
"EOD"
Enum
  • EOD

security_positions

array[object (Account valuation security position)]

Positions associated with this account valuation.

Account valuation security position

object (Account valuation security position)

instrument

object (instrument)

required

Entity representing the financial instrument.

uuid

string

uuid

required

String representing the instrument internal identifier.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

quantity

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

value

object (value) or null

required

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

price_time

string

date-time

required

The date and time of the price used for the calculation. RFC 3339-5, ISO8601 UTC

weight

string or null

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

valuation_time

string

date-time

required

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

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

type

string

required

URL to a document describing the error condition.

status

int

required

Transmission of the HTTP status code so that all information can be found in one place, but also to correct changes in the status code due to the use of proxy servers.

title

string

A short, human-readable title for the general error type; the title should not change for given types.

detail

string

A human-readable description of the specific error.

instance

string

This optional key may be present, with a unique URI for the specific error; this will often point to an error log for that specific response.

request_id

string

Correlation ID for the original request.

upvest-request-id

string

uuid

Example
"169ae4c7-ebd7-4041-94da-25369653eba7"

Account valuation events

webhook

Account valuation events

created_at

string

date-time

required

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

id

string

uuid

required

Event unique identifier

object

object (object)

required

account_id

string

uuid

required

Account unique identifier.

created_at

string

date-time

required

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

id

string

uuid

required

Account valuation unique identifier.

price_quality

string

required

Price quality used for the calculation of the account valuation.

  • EOD - end of day price
Default
"EOD"
Enum
  • EOD

security_positions

array[object (Account valuation security position)]

Positions associated with this account valuation.

Account valuation security position

object (Account valuation security position)

instrument

object (instrument)

required

Entity representing the financial instrument.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

uuid

string

uuid

required

String representing the instrument internal identifier.

quantity

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

value

object (value) or null

required

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

price_time

string

date-time

required

The date and time of the price used for the calculation. RFC 3339-5, ISO8601 UTC

weight

string or null

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

total_security_value

object (total_security_value)

required

Entity representing the monetary value by amount and currency.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

updated_at

string

date-time

required

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

valuation_time

string

date-time

required

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

type

string

required

Event type

Enum
  • ACCOUNT_VALUATION.CREATED

webhook_id

string

uuid

required

Webhook unique identifier.

Request

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

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Intraday account valuation events

webhook

Intraday account valuation events

created_at

string

date-time

required

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

id

string

uuid

required

Event unique identifier

object

object (object)

required

account_id

string

uuid

required

Account unique identifier.

created_at

string

date-time

required

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

id

string

uuid

required

Account valuation unique identifier.

price_quality

string

required

Price quality used for the calculation of the account valuation.

  • EOD - end of day price
Default
"EOD"
Enum
  • EOD

security_positions

array[object (Account valuation security position)]

Positions associated with this account valuation.

Account valuation security position

object (Account valuation security position)

instrument

object (instrument)

required

Entity representing the financial instrument.

isin

string

^[A-Z]{2}[A-Z0-9]{9}[0-9]$

International securities identification number defined by ISO 6166.

uuid

string

uuid

required

String representing the instrument internal identifier.

quantity

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

value

object (value) or null

required

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

price_time

string

date-time

required

The date and time of the price used for the calculation. RFC 3339-5, ISO8601 UTC

weight

string or null

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

total_security_value

object (total_security_value)

required

Entity representing the monetary value by amount and currency.

amount

string

^-?[0-9]{0,63}(\.[0-9]{1,27})?$

required

currency

string

ISO4217

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

updated_at

string

date-time

required

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

valuation_time

string

date-time

required

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

type

string

required

Event type

Enum
  • INTRADAY_ACCOUNT_VALUATION.CREATED

webhook_id

string

uuid

required

Webhook unique identifier.

Request

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

Response

Examples Schema

Request has been processed successfully.

Empty response

No schema

Was this page helpful?