Skip to content
API Reference/
/
List portfolios allocatio...

Upvest Investment API (1.86.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL
https://docs.upvest.co
Upvest API Support
api@upvest.co
License
Apache 2.0
Languages
Servers
Sandbox environment
https://sandbox.upvest.co
Live environment
https://api.upvest.co

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

Operations
Webhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

Operations
Webhooks

Accounts

All accounts related paths

Operations
Webhooks

Account Groups

All account groups related paths

Operations
Webhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Wrappers

All tax wrappers related paths

Operations
Webhooks

Tax Exemptions

All tax exemptions related paths

Operations
Webhooks

Tax Collections

All tax collections related paths

Webhooks

Instruments

All instrument related paths.

Operations
Webhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

Operations
Webhooks

Portfolios

All portfolios related paths.

Operations

Cancel portfolios order

Request

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.

Security
oauth-client-credentials(Required scopes:
portfolios:admin
)
Path
portfolio_order_idstring(uuid)required
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: 363f3305-7ab0-4e82-a158-f9d382ad08b6
Authorizationstring^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==
signaturestringrequired

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

signature-inputstringrequired

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

upvest-api-versionstring

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

Default 1
Value"1"
Example: 1
curl -i -X DELETE \
  'https://sandbox.upvest.co/portfolios/orders/{portfolio_order_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: 363f3305-7ab0-4e82-a158-f9d382ad08b6'

Responses

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

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Response
No content

List portfolios allocation accounts

Request

List portfolios allocation accounts

Security
oauth-client-credentials(Required scopes:
portfolios:read
portfolios:admin
)
Path
allocation_idstring(uuid)required
Query
sortstring

Sort the result by id.

Default "id"
Value"id"
orderstring

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

Default "ASC"
Value"ASC"
offsetinteger(int32)>= 0

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

limitinteger(int32)[ 1 .. 1000 ]

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

Default 100
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: 363f3305-7ab0-4e82-a158-f9d382ad08b6
Authorizationstring^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==
signaturestringrequired

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

signature-inputstringrequired

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

upvest-api-versionstring

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

Default 1
Value"1"
Example: 1
curl -i -X GET \
  'https://sandbox.upvest.co/portfolios/allocations/{allocation_id}/accounts?sort=id&order=ASC&offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'signature: string' \
  -H 'signature-input: string' \
  -H 'upvest-api-version: 1' \
  -H 'upvest-client-id: 363f3305-7ab0-4e82-a158-f9d382ad08b6'

Responses

Portfolios allocation accounts

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
metaobjectrequired
offsetintegerrequired

Amount of resource to offset in the response.

limitintegerrequired

Total limit of the response.

countintegerrequired

Count of the resources returned in the response.

total_countintegerrequired

Total count of all the resources.

sortstring

The field that the list is sorted by.

orderstring

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum"ASC""DESC"
dataArray of objectsrequired
idstring(uuid)required

Account unique identifier.

Response
application/json
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    { … }
  ]
}

Portfolios orders eventsWebhook

Request

Portfolios orders events

Bodyapplication/json
idstring(uuid)required

Event unique identifier

created_atstring(date-time)required

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

typestringrequired

Event type

Enum"PORTFOLIO_ORDER.NEW""PORTFOLIO_ORDER.PROCESSING""PORTFOLIO_ORDER.FILLED""PORTFOLIO_ORDER.SETTLED""PORTFOLIO_ORDER.CANCELLED"
objectobjectrequired
idstring(uuid)required
created_atstring(date-time)required

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

updated_atstring(date-time)required

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

account_idstring(uuid)required

Account unique identifier.

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

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
  • GBP - Pound Sterling
Enum"EUR""GBP"
statusstringrequired

Execution status of the Portfolio Order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum"NEW""PROCESSING""FILLED""SETTLED""CANCELLED"
post_taxbooleanrequired

Cash amount is post-tax value

Default false
client_referencestringrequired
initiation_flowstringrequired

What triggered the order creation .

  • API -
  • SAVINGS_PLAN -
Enum"API""SAVINGS_PLAN"
ordersArray of objectsrequired

Orders associated with this portfolio order

idstring(uuid)required
sidestringrequired

Side of the portfolio order.

  • BUY -
  • SELL -
Enum"BUY""SELL"
statusstringrequired

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum"NEW""PROCESSING""FILLED""CANCELLED"
user_idstring(uuid)

User unique identifier.

allocation_idstring(uuid)
typestring

Type of the Portfolio Order.

  • BUY -
  • SELL -
  • REBALANCING -
Enum"BUY""SELL""REBALANCING"
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(uuid)required

Webhook unique identifier.

application/json
{
  "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": [ … ]
  },
  "webhook_id": "cd2e4183-4e62-4e0f-981b-44b594d14610"
}

Responses

Request has been processed successfully.

Portfolios Rebalancing

All portfolios rebalancing related paths.

Operations
Webhooks

Savings Plans

All savings plans related paths.

Operations
Webhooks

Liquidations

All accounts liquidations related paths.

Operations
Webhooks

Direct Debits

All direct debits related paths

Operations
Webhooks

Top-ups

All top-ups related paths

Operations
Webhooks

Withdrawals

All withdrawals related paths

Operations
Webhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

Operations
Webhooks

Credit Fundings

All credit fundings related paths

Operations
Webhooks

Cash Balances

All cash balance related paths

Operations
Webhooks

Positions

All positions related paths.

Operations
Webhooks

Valuations

All valuations related paths.

Operations
Webhooks

Returns

All accounts returns related paths.

Operations
Webhooks

Virtual Cash Balances

All virtual cash balances related paths

Operations
Webhooks

Fees

All fees related paths.

Operations
Webhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

Operations
Webhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

Operations
Webhooks

Files

All files API related paths.

Operations

Account Transfers

All Accounts Transfers related paths.

Operations
Webhooks

Securities Transfers

All Securities Transfers related paths.

Operations
Webhooks

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Tests

All test related paths.

Operations