API status
  • Investments Solutions

Portfolios

All portfolios related paths.

get

List portfolios allocations

List portfolios allocations

sortstring

Sort the result by id.

Default
"id"
Enum
  • id
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 portfolio allocations with dates starting from and including this date (UTC)

Example
"2022-10-14T10:10:10Z"
end_datestring

Returns portfolio allocations with dates up until this date (UTC)

Example
"2022-10-14T10:10:10Z"
instrument_idsstring

Filters portfolio allocations containing the instruments ID's

Example
"bf72bdc1-b342-494f-9739-b27ae9011b86,dcbe2cf4-4f37-4fe5-9393-4fb52bb87fab"

Responses

Response examples

Portfolios allocations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "c27c1fdc-b129-4d7a-95ac-c8a4f05d2804",
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "name": "Allocation 1",
      "allocation": [
        {
          "instrument_id": "IE00B0M62Q58",
          "instrument_id_type": "ISIN",
          "weight": "0.7"
        },
        {
          "instrument_id": "US0378331005",
          "instrument_id_type": "ISIN",
          "weight": "0.3"
        }
      ]
    }
  ]
}
post

Create portfolios allocation

Create portfolios allocation

namestring

Allocation name

allocationarray

required

List of portfolios allocations

instrument_idOne Of

required

Must match one of

instrument_id_typestring

required

The type of the ID used in the request.

  • ISIN - International Securities Identification Number
  • UPVEST - UPVEST's unique instrument identifier
Default
"ISIN"
Enum
  • ISIN
  • UPVEST
weightstring

required

Instrument allocation weight

Pattern
^(100|[0-9]{1,2}(\.[0-9]{1,5})?)$
rebalancing_strategy_idsarray

List of rebalancing strategy ids

Format
uuid

Responses

Request examples

{
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.7"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.3"
    }
  ]
}

Response examples

Portfolios allocation

{
  "id": "436244bb-4afd-4002-b53b-b1d7a3bca032",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.7"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.3"
    }
  ]
}
get

Retrieve portfolios allocation

Retrieve portfolios allocation

allocation_idstring

required

Format
uuid

Responses

Response examples

Portfolios allocation

{
  "id": "bf5f2676-4535-403d-bc66-06ec38cc70af",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.7"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.3"
    }
  ]
}
put

Update portfolios allocation

Update portfolios allocation

namestring

Allocation name

allocationarray

required

List of portfolios allocations

instrument_idOne Of

required

Must match one of

instrument_id_typestring

required

The type of the ID used in the request.

  • ISIN - International Securities Identification Number
  • UPVEST - UPVEST's unique instrument identifier
Default
"ISIN"
Enum
  • ISIN
  • UPVEST
weightstring

required

Instrument allocation weight

Pattern
^(100|[0-9]{1,2}(\.[0-9]{1,5})?)$

Responses

Request examples

{
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.6"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.4"
    }
  ]
}

Response examples

Portfolios allocation

{
  "id": "436244bb-4afd-4002-b53b-b1d7a3bca032",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-22T15:10:00.00Z",
  "name": "Allocation 1",
  "allocation": [
    {
      "instrument_id": "IE00B0M62Q58",
      "instrument_id_type": "ISIN",
      "weight": "0.6"
    },
    {
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "weight": "0.4"
    }
  ]
}
get

List portfolios configurations

List portfolios configurations

sortstring

Sort the result by account_id.

Default
"account_id"
Enum
  • account_id
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 portfolio configurations with dates starting from and including this date (UTC)

Example
"2022-10-14T10:10:10Z"
end_datestring

Returns portfolio configurations with dates up until this date (UTC)

Example
"2022-10-14T10:10:10Z"
account_idstring

Filters portfolio configurations by account ID

Example
"3ada8e9e-82c4-4c78-a43d-a691b1636509"
allocation_idstring

Filters portfolio configurations by allocation ID

Example
"f6c2b02a-3214-4a40-82ae-6c76df50bc8c"

Responses

Response examples

Portfolios configurations

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "account_id",
    "order": "ASC"
  },
  "data": [
    {
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "account_id": "4ca934ae-66b2-4494-86f9-df6ab89351f1",
      "allocation_id": "65c69f95-c7b9-4c93-9943-a8c7fe4f7aef",
      "rebalancing_strategy_ids": [
        "7a7322f5-b45d-4aba-aae4-c12797938c93",
        "d7b4291b-5a26-40c2-a8dd-235bd904a2ed"
      ]
    },
    {
      "created_at": "2021-07-21T14:10:00.00Z",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "account_id": "a46c4531-ec90-4ac3-ac6b-356d743a3859",
      "allocation_id": "a4117e26-7c31-43ad-af47-0784a4957da9",
      "rebalancing_strategy_ids": [
        "7a7322f5-b45d-4aba-aae4-c12797938c93",
        "692e318a-d6d0-43ac-999a-b84a82dbe304"
      ]
    }
  ]
}
post

Create portfolios configuration

Create portfolios configuration

account_idstring

required

Account unique identifier.

Format
uuid
allocation_idstring

required

Format
uuid
rebalancing_strategy_idsarray

List of rebalancing strategy ids

Format
uuid

Responses

Request examples

{
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f"
}

Response examples

Portfolios configuration

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}
get

Retrieve portfolios configuration

Retrieve portfolios configuration

account_idstring

required

Account unique identifier.

Format
uuid

Responses

Response examples

Portfolios

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}
patch

Update portfolios configuration

Update portfolios configuration

allocation_idstring
Format
uuid
rebalancing_strategy_idsarray

List of rebalancing strategy ids

Format
uuid

Responses

Request examples

{
  "allocation_id": "359e9c9e-b91c-4853-8674-e6657af609fc"
}

Response examples

Portfolio

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-22T15:10:00.00Z",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "359e9c9e-b91c-4853-8674-e6657af609fc",
  "rebalancing_strategy_ids": [
    "7a7322f5-b45d-4aba-aae4-c12797938c93",
    "fd8e5363-a89c-4a2f-b3c6-5f857721625f"
  ]
}
get

List portfolios orders

List portfolios orders

sortstring

Sort the result by id.

Default
"id"
Enum
  • id
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 portfolio orders with dates starting from and including this date (UTC)

Example
"2022-10-14T10:10:10Z"
end_datestring

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

Example
"2022-10-14T10:10:10Z"
allocation_idstring

Filters portfolio orders containing the allocation id

Format
uuid
Example
"f96eaefd-b4c6-477a-9bbe-c744bf26172f"
account_idstring

Filters portfolio orders containing the account id

Format
uuid
Example
"2c865aab-6737-4b0e-9154-69a4622b2727"

Responses

Response examples

Portfolios orders

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "created_at": "2021-07-21T14:10:00.000Z",
      "updated_at": "2021-07-21T14:10:00.000Z",
      "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
      "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
      "cash_amount": "1000",
      "currency": "EUR",
      "status": "PROCESSING",
      "type": "SELL",
      "post_tax": false,
      "client_reference": "",
      "initiation_flow": "API",
      "orders": [
        {
          "id": "b291d8a4-21f5-4c52-8590-4f90ce54d0b1",
          "side": "SELL",
          "status": "NEW"
        },
        {
          "id": "81d02bd9-7b9d-443d-bbfa-31df4d543f7d",
          "side": "SELL",
          "status": "PROCESSING"
        },
        {
          "id": "e97fb564-ebb4-4f37-930a-bda49c09a2e4",
          "side": "SELL",
          "status": "FILLED"
        }
      ]
    }
  ]
}
post

Create portfolios order

Create portfolios order

user_idstring

required

User unique identifier.

Format
uuid
account_idstring

required

Account unique identifier.

Format
uuid
cash_amountstring

required

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

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
Enum
  • EUR
  • GBP
sidestring

required

Side of the portfolio order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL
post_taxboolean

Cash amount is post-tax value

Default
false

Responses

Request examples

{
  "user_id": "4b9732bd-7496-4e91-8a5f-6360479d7fed",
  "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030",
  "cash_amount": "100.00",
  "currency": "EUR",
  "side": "BUY"
}

Response examples

Portfolios order

{
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "created_at": "2021-07-21T14:10:00.000Z",
  "updated_at": "2021-07-21T14:10:00.000Z",
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "allocation_id": "eb68abce-29f4-483f-a384-7f243e77851f",
  "cash_amount": "1000",
  "currency": "EUR",
  "status": "NEW",
  "type": "BUY",
  "post_tax": false,
  "client_reference": "",
  "initiation_flow": "API",
  "orders": []
}
get

Retrieve portfolios order

Retrieve portfolios order

portfolio_order_idstring

required

Format
uuid

Responses

Response examples

Portfolios order

{
  "id": "29bc9a26-a6ee-47a3-b609-47d30a737afc",
  "created_at": "2021-07-21T14:10:00.00Z",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "4b9732bd-7496-4e91-8a5f-6360479d7fed",
  "account_id": "f2f7d2c7-d79b-4de2-ae9b-d01646259f9e",
  "allocation_id": "19a902ac-1c01-4c45-bd5d-62fd496805c8",
  "cash_amount": "100.00",
  "currency": "EUR",
  "status": "PROCESSING",
  "type": "BUY",
  "client_reference": "fd1ae99e-772a-11ee-b962-0242ac120002",
  "initiation_flow": "SAVINGS_PLAN",
  "post_tax": false,
  "orders": [
    {
      "id": "79f2c816-13ed-4588-85e6-f3398b0b5825",
      "side": "BUY",
      "status": "NEW"
    },
    {
      "id": "44f50a4e-7ce8-4eae-a078-f4b3d8ab4708",
      "side": "BUY",
      "status": "NEW"
    }
  ]
}
delete

Cancel portfolios order

Cancel portfolios order. Cancellations may not be possible - in rare situations, some individual orders within portfolios order may already have been filled. In this case, cancellation could result in a mix of cancelled and filled orders.

portfolio_order_idstring

required

Format
uuid

Responses

Response examples

The request has been successfully accepted and will be processed asynchronously.

Empty response

get

List portfolios allocation accounts

List portfolios allocation accounts

sortstring

Sort the result by id.

Default
"id"
Enum
  • id
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

Responses

Response examples

Portfolios allocation accounts

{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    {
      "id": "81d6e710-37e6-4a5a-9877-ef5bb6d717e3"
    }
  ]
}
webhook

Portfolios 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
  • PORTFOLIO_ORDER.NEW
  • PORTFOLIO_ORDER.PROCESSING
  • PORTFOLIO_ORDER.FILLED
  • PORTFOLIO_ORDER.SETTLED
  • PORTFOLIO_ORDER.CANCELLED
objectobject (Portfolios order)

required

idstring

required

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
user_idstring

User unique identifier.

Format
uuid
account_idstring

required

Account unique identifier.

Format
uuid
allocation_idstring
Format
uuid
cash_amountstring

required

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

required

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
Enum
  • EUR
  • GBP
statusstring

required

Execution status of the Portfolio Order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • SETTLED
  • CANCELLED
typestring

Type of the Portfolio Order.

  • BUY -
  • SELL -
  • REBALANCING -
Enum
  • BUY
  • SELL
  • REBALANCING
post_taxboolean

required

Cash amount is post-tax value

Default
false
ordersarray

required

Orders associated with this portfolio order

client_referencestring

required

initiation_flowstring

required

What triggered the order creation .

  • API -
  • SAVINGS_PLAN -
Enum
  • API
  • SAVINGS_PLAN
cancellation_reasonstring

Explains the reason why the order was cancelled .

  • ACCOUNT_IS_EMPTY -
  • CANCELLED_BY_CLIENT -
  • CANCELLED_BY_UPVEST -
  • PORTFOLIO_IS_BALANCED -
  • SELL_LIMIT_EXCEEDED -
Enum
  • ACCOUNT_IS_EMPTY
  • CANCELLED_BY_CLIENT
  • CANCELLED_BY_UPVEST
  • PORTFOLIO_IS_BALANCED
  • SELL_LIMIT_EXCEEDED
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": "PORTFOLIO_ORDER.NEW",
  "object": {
    "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
    "created_at": "2021-07-21T14:10:00.000Z",
    "updated_at": "2021-07-21T14:10:00.000Z",
    "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
    "allocation_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
    "cash_amount": "1000",
    "currency": "EUR",
    "status": "PROCESSING",
    "type": "SELL",
    "post_tax": false,
    "client_reference": "",
    "initiation_flow": "API",
    "orders": [
      {
        "id": "e7aecb80-5e84-4bf7-984b-b39ab77eb0a8",
        "side": "SELL",
        "status": "NEW"
      },
      {
        "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
        "side": "SELL",
        "status": "PROCESSING"
      },
      {
        "id": "d8a85120-2941-4ed6-8d57-e80401a4779c",
        "side": "SELL",
        "status": "FILLED"
      }
    ]
  },
  "webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}

Response examples

Request has been processed successfully.

Empty response

webhook

Portfolios allocations 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
  • PORTFOLIO_ALLOCATION.CREATED
  • PORTFOLIO_ALLOCATION.CHANGED
objectobject (Portfolios allocation)

required

idstring

required

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
namestring

required

Allocation name

allocationarray

required

List of portfolios allocations

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": "PORTFOLIO_ALLOCATION.CREATED",
  "object": {
    "id": "436244bb-4afd-4002-b53b-b1d7a3bca032",
    "created_at": "2021-07-21T14:10:00.00Z",
    "updated_at": "2021-07-21T14:10:00.00Z",
    "name": "Allocation 1",
    "allocation": [
      {
        "instrument_id": "IE00B0M62Q58",
        "instrument_id_type": "ISIN",
        "weight": "0.7"
      },
      {
        "instrument_id": "US0378331005",
        "instrument_id_type": "ISIN",
        "weight": "0.3"
      }
    ]
  },
  "webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}

Response examples

Request has been processed successfully.

Empty response

Was this page helpful?