Investments Solutions

Portfolios Rebalancing

Download Spec

All portfolios rebalancing related paths.

post/portfolios/rebalancings/executions

Trigger portfolio rebalancing

Must match one of

accountsarray

required

List of accounts

Account unique identifier.

Format: uuid

Responses

Request examples

{
  "accounts": [
    "43801b85-bbcf-41c7-8389-b018082a5ec5",
    "20151679-c159-4f16-b8a2-267b3d968c6f"
  ]
}

Response examples

Portfolio

{
  "id": "735381ce-8380-4b07-9e42-97e2b6d3643e"
}

get/portfolios/rebalancings/executions/{execution_id}

Retrieve portfolios rebalancing execution

execution_idstring

required

Format: uuid

Responses

Response examples

Portfolios

{
  "id": "735381ce-8380-4b07-9e42-97e2b6d3643e",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "accounts": [
    "43801b85-bbcf-41c7-8389-b018082a5ec5",
    "20151679-c159-4f16-b8a2-267b3d968c6f"
  ],
  "allocations": []
}

get/portfolios/rebalancings/executions/{execution_id}/orders

List portfolio rebalancing execution orders

sortstring

Sort the result by status.

Default: "status"
Enum: status

orderstring

Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.

Default: "ASC"
Enum: ASC

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

start_datestring

Returns rebalancing orders with dates starting from and including this date (UTC)

Example: "2022-10-14"

end_datestring

Returns rebalancing orders with dates up until this date (UTC)

Example: "2022-10-14"

Responses

Response examples

Portfolios

{
  "meta": {
    "count": 2,
    "limit": 10,
    "offset": 0,
    "order": "ASC",
    "sort": "state",
    "total_count": 2
  },
  "data": [
    {
      "id": "adf706aa-4fac-4e1d-878b-5b225f7b7354",
      "created_at": "2022-09-28T09:14:02Z",
      "updated_at": "2022-09-28T09:14:02Z",
      "execution_id": "edc74b48-a377-4b93-84fb-543b1137de05",
      "account_id": "100bb408-149c-4e6f-8697-837c2a144a29",
      "portfolio_order_id": "b31723e0-8c8c-4bd0-a962-8bd26c5aee4d",
      "status": "FILLED"
    },
    {
      "id": "1dd8cede-a326-43b3-a54c-9d2d0e80edb5",
      "created_at": "2022-09-28T09:14:02Z",
      "updated_at": "2022-09-28T09:14:02Z",
      "execution_id": "f678fe2b-ffd8-4b99-844f-a8f78a67e528",
      "account_id": "98b21a45-5ea0-481f-bb1e-880aab0d154d",
      "portfolio_order_id": "411c625e-b2f4-4af4-ac21-e17846fb6bcc",
      "status": "PROCESSING"
    },
    {
      "id": "1bf46252-ad90-4e22-8717-9586d2b86327",
      "created_at": "2022-09-28T09:14:02Z",
      "updated_at": "2022-09-28T09:14:02Z",
      "execution_id": "9275e08d-012f-40bd-80b7-58037bdc7ab6",
      "portfolio_order_id": null,
      "account_id": "98b21a45-5ea0-481f-bb1e-880aab0d154d",
      "status": "NEW"
    },
    {
      "id": "1bf46252-ad90-4e22-8717-9586d2b86327",
      "created_at": "2022-09-28T09:14:02Z",
      "updated_at": "2022-09-28T09:14:02Z",
      "execution_id": "9275e08d-012f-40bd-80b7-58037bdc7ab6",
      "portfolio_order_id": null,
      "account_id": "98b21a45-5ea0-481f-bb1e-880aab0d154d",
      "status": "CANCELLED",
      "cancellation_reason": "PORTFOLIO_IS_BALANCED",
      "cancellation_details": "Portfolio is balanced, no need to rebalance."
    }
  ]
}

webhook

Portfolio rebalancing execution orders 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: REBALANCING_EXECUTION_ORDER.NEW
REBALANCING_EXECUTION_ORDER.PROCESSING
REBALANCING_EXECUTION_ORDER.CANCELLED
REBALANCING_EXECUTION_ORDER.FILLED

objectobject (Portfolios rebalancing execution order)

required

idstring

required

Format: uuid

execution_idstring

required

Format: uuid

account_idstring

required

Account unique identifier.

Format: uuid

portfolio_order_idOne Of

required

Must match one of

statusstring

required

Status of the Rebalancing Execution Order.

NEW -
PROCESSING -
FILLED -
CANCELLED -

Enum: NEW
PROCESSING
FILLED
CANCELLED

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

cancellation_reasonstring

Reason for Rebalancing Execution Order Cancellation. The field is present in case the Order has a status of CANCELLED.

ACCOUNT_IS_EMPTY -
ACCOUNT_NOT_FOUND -
CANCELLED_BY_CLIENT -
CANCELLED_BY_UPVEST -
CONFIGURATION_IS_MISSING -
INVALID_ACCOUNT_TYPE -
PORTFOLIO_IS_BALANCED -
UNKNOWN -

Enum: ACCOUNT_IS_EMPTY
ACCOUNT_NOT_FOUND
CANCELLED_BY_CLIENT
CANCELLED_BY_UPVEST
CONFIGURATION_IS_MISSING
INVALID_ACCOUNT_TYPE
PORTFOLIO_IS_BALANCED
UNKNOWN

cancellation_detailsstring

webhook_idstring

required

Webhook unique identifier.

Format: uuid

Responses

Request examples

{
  "id": "54b8d84f-5bd0-4e43-bf0f-164388cb4c23",
  "created_at": "2021-07-21T14:10:00.00Z",
  "type": "REBALANCING_EXECUTION_ORDER.NEW",
  "object": {
    "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
    "execution_id": "760abce7-e6b5-440b-bdf3-88e35ed6417a",
    "created_at": "2021-07-21T14:10:00.000Z",
    "updated_at": "2021-07-21T14:10:00.000Z",
    "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
    "portfolio_order_id": "4f2f5db9-ef4e-4dbf-80a1-bffc71985d6c",
    "status": "PROCESSING"
  },
  "webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?