Operating Model:

All order related paths.

Get orders for an account by ID

get /accounts/{account_id}/orders

Returns a list of all orders for the account specified by its ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

orders:readorders:admin

All Scopes

  • 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.

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

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

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 (Order)]

required

Order

object (Order)

id

string

uuid

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

required

Cash amount for a nominal order, not needed if share quantity is specified

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT - [COMING SOON]
  • STOP - [COMING SOON]
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

Quantity of securities for the order. Only needed if the cash amount is not specified

user_instrument_fit_acknowledgement

boolean

Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.

price

string

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

[DEPRECATED] The limit or stop price for limit and stop orders respectively.

limit_price

string

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

[COMING SOON] The limit price for limit type order

stop_price

string

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

[COMING SOON] The stop price for stop type order

expiry_date

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}$

[COMING SOON] Date of order expiration (last day the order can trade) in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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

  • CANCELLED_BY_CLIENT -
  • CANCELLED_BY_UPVEST_OPERATIONS -
  • CANCELLED_BY_TRADING_PARTNER -
  • CANCELLED_BY_UPVEST_PLATFORM -
Enum
  • CANCELLED_BY_CLIENT
  • CANCELLED_BY_UPVEST_OPERATIONS
  • CANCELLED_BY_TRADING_PARTNER
  • CANCELLED_BY_UPVEST_PLATFORM

initiation_flow

string

required

Initiation flow used during order creation, i.e. what triggered the order.

  • API -
  • PORTFOLIO -
  • CASH_DIVIDEND_REINVESTMENT -
  • PORTFOLIO_REBALANCING -
  • SELL_TO_COVER_FEES -
  • SELL_TO_COVER_TAXES -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

client_reference

string

required

An ID provided by the client

Max Length
100

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "data": [
    {
      "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
      "cash_amount": "56.65",
      "client_reference": "",
      "created_at": "2021-07-21T14:10:00.00Z",
      "currency": "EUR",
      "executions": [
        {
          "cash_amount": "56.65",
          "currency": "EUR",
          "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
          "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
          "price": "130.65",
          "share_quantity": "0.05",
          "side": "BUY",
          "status": "FILLED",
          "taxes": [
            {
              "amount": "1.3",
              "type": "TOTAL"
            }
          ],
          "transaction_time": "2021-07-21T14:10:00.00Z"
        }
      ],
      "fee": "0.5",
      "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "initiation_flow": "API",
      "instrument_id": "US0378331005",
      "instrument_id_type": "ISIN",
      "limit_price": "",
      "order_type": "MARKET",
      "price": "",
      "quantity": "0.05",
      "side": "BUY",
      "status": "FILLED",
      "stop_price": "",
      "updated_at": "2021-07-21T14:10:00.00Z",
      "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
      "user_instrument_fit_acknowledgement": true
    }
  ],
  "meta": {
    "count": 1,
    "limit": 100,
    "offset": 0,
    "order": "ASC",
    "sort": "id",
    "total_count": 1
  }
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Place an order

post /orders

Places a new order. After the creation request for the order is accepted, further processing takes place asynchronously.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

orders:admin

All Scopes

  • 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

idempotency-key

string

uuid

required

Idempotency key to prevent the same request from replaying. https://datatracker.ietf.org/doc/id/draft-ietf-httpapi-idempotency-key-header-01.html

Example
"f1150421-2e34-42b6-aae9-52ef157065b9"

application/json

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

Cash amount for a nominal order, not needed if share quantity is specified

currency

string

ISO4217

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

Type of the order.

  • MARKET -
  • LIMIT - [COMING SOON]
  • STOP - [COMING SOON]
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

Quantity of securities for the order. Only needed if the cash amount is not specified

user_instrument_fit_acknowledgement

boolean

Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.

price

string

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

[DEPRECATED] The limit or stop price for limit and stop orders respectively.

limit_price

string

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

[COMING SOON] The limit price for limit type order

stop_price

string

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

[COMING SOON] The stop price for stop type order

expiry_date

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}$

[COMING SOON] Date of order expiration (last day the order can trade) in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

client_reference

string

An ID provided by the client

Max Length
100

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

id

string

uuid

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

required

Cash amount for a nominal order, not needed if share quantity is specified

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT - [COMING SOON]
  • STOP - [COMING SOON]
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

Quantity of securities for the order. Only needed if the cash amount is not specified

user_instrument_fit_acknowledgement

boolean

Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.

price

string

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

[DEPRECATED] The limit or stop price for limit and stop orders respectively.

limit_price

string

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

[COMING SOON] The limit price for limit type order

stop_price

string

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

[COMING SOON] The stop price for stop type order

expiry_date

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}$

[COMING SOON] Date of order expiration (last day the order can trade) in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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

  • CANCELLED_BY_CLIENT -
  • CANCELLED_BY_UPVEST_OPERATIONS -
  • CANCELLED_BY_TRADING_PARTNER -
  • CANCELLED_BY_UPVEST_PLATFORM -
Enum
  • CANCELLED_BY_CLIENT
  • CANCELLED_BY_UPVEST_OPERATIONS
  • CANCELLED_BY_TRADING_PARTNER
  • CANCELLED_BY_UPVEST_PLATFORM

initiation_flow

string

required

Initiation flow used during order creation, i.e. what triggered the order.

  • API -
  • PORTFOLIO -
  • CASH_DIVIDEND_REINVESTMENT -
  • PORTFOLIO_REBALANCING -
  • SELL_TO_COVER_FEES -
  • SELL_TO_COVER_TAXES -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

client_reference

string

required

An ID provided by the client

Max Length
100

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Request Examples

{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "56.65",
  "client_reference": "ORD-01",
  "currency": "EUR",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "0.05",
  "side": "BUY",
  "stop_price": "",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "1000",
  "currency": "EUR",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "side": "BUY",
  "stop_price": "",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "currency": "EUR",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "10",
  "side": "SELL",
  "stop_price": "",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}

Response Examples

{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "56.65",
  "client_reference": "ORD-01",
  "created_at": "2021-07-21T14:10:00.00Z",
  "currency": "EUR",
  "executions": [],
  "fee": "0.5",
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "initiation_flow": "API",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "0.05",
  "side": "BUY",
  "status": "NEW",
  "stop_price": "",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "1000",
  "client_reference": "",
  "created_at": "2021-07-21T14:10:00.00Z",
  "currency": "EUR",
  "executions": [],
  "fee": "0.0",
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "initiation_flow": "API",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "0",
  "side": "BUY",
  "status": "NEW",
  "stop_price": "",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "1000",
  "client_reference": "",
  "created_at": "2021-07-21T14:10:00.00Z",
  "currency": "EUR",
  "executions": [
    {
      "cash_amount": "1000",
      "currency": "EUR",
      "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
      "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "price": "85.22",
      "share_quantity": "11.734334663",
      "side": "BUY",
      "status": "FILLED",
      "taxes": [
        {
          "amount": "0",
          "type": "TOTAL"
        }
      ],
      "transaction_time": "2021-07-21T14:10:00.020Z"
    }
  ],
  "fee": "0.0",
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "initiation_flow": "API",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "0",
  "side": "BUY",
  "status": "FILLED",
  "stop_price": "",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "0",
  "client_reference": "",
  "created_at": "2021-07-21T14:10:00.00Z",
  "currency": "EUR",
  "executions": [],
  "fee": "0.0",
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "initiation_flow": "API",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "10",
  "side": "SELL",
  "status": "NEW",
  "stop_price": "",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "0",
  "client_reference": "",
  "created_at": "2021-07-21T14:10:00.00Z",
  "currency": "EUR",
  "executions": [
    {
      "cash_amount": "852.20",
      "currency": "EUR",
      "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
      "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
      "price": "85.22",
      "share_quantity": "10",
      "side": "SELL",
      "status": "FILLED",
      "taxes": [
        {
          "amount": "23.45",
          "type": "TOTAL"
        }
      ],
      "transaction_time": "2021-07-21T14:10:00.020Z"
    }
  ],
  "fee": "0.0",
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "initiation_flow": "API",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "10",
  "side": "SELL",
  "status": "FILLED",
  "stop_price": "",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "status": 400,
  "type": "bad_request"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 422,
  "type": "unprocessable_entity"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Get an order by ID

get /orders/{order_id}

Returns the order specified by its ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

orders:readorders:admin

All Scopes

  • 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

order_id

string

uuid

required

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

id

string

uuid

required

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

user_id

string

uuid

required

The ID of the user

account_id

string

uuid

required

The ID of the account that owns the order

cash_amount

required

Cash amount for a nominal order, not needed if share quantity is specified

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT - [COMING SOON]
  • STOP - [COMING SOON]
Enum
  • MARKET
  • LIMIT
  • STOP

quantity

string

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

required

Quantity of securities for the order. Only needed if the cash amount is not specified

user_instrument_fit_acknowledgement

boolean

Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.

price

string

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

[DEPRECATED] The limit or stop price for limit and stop orders respectively.

limit_price

string

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

[COMING SOON] The limit price for limit type order

stop_price

string

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

[COMING SOON] The stop price for stop type order

expiry_date

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}$

[COMING SOON] Date of order expiration (last day the order can trade) in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

fee

string

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

required

cancellation_reason

string

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

  • CANCELLED_BY_CLIENT -
  • CANCELLED_BY_UPVEST_OPERATIONS -
  • CANCELLED_BY_TRADING_PARTNER -
  • CANCELLED_BY_UPVEST_PLATFORM -
Enum
  • CANCELLED_BY_CLIENT
  • CANCELLED_BY_UPVEST_OPERATIONS
  • CANCELLED_BY_TRADING_PARTNER
  • CANCELLED_BY_UPVEST_PLATFORM

initiation_flow

string

required

Initiation flow used during order creation, i.e. what triggered the order.

  • API -
  • PORTFOLIO -
  • CASH_DIVIDEND_REINVESTMENT -
  • PORTFOLIO_REBALANCING -
  • SELL_TO_COVER_FEES -
  • SELL_TO_COVER_TAXES -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

client_reference

string

required

An ID provided by the client

Max Length
100

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
  "cash_amount": "56.65",
  "client_reference": "",
  "created_at": "2021-07-21T14:10:00.00Z",
  "currency": "EUR",
  "executions": [],
  "fee": "0.5",
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "initiation_flow": "API",
  "instrument_id": "US0378331005",
  "instrument_id_type": "ISIN",
  "limit_price": "",
  "order_type": "MARKET",
  "price": "",
  "quantity": "0.05",
  "side": "BUY",
  "status": "NEW",
  "stop_price": "",
  "updated_at": "2021-07-21T14:10:00.00Z",
  "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
  "user_instrument_fit_acknowledgement": true
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Cancel an order by ID

delete /orders/{order_id}

Cancels an order specified by its ID. It is possible to cancel an order of the NEW status. Once a cancellation has been accepted, the further processing steps take place asynchronously and depending on the respective order status.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

orders:admin

All Scopes

  • 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

order_id

string

uuid

required

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

id

string

uuid

required

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Get an order execution by ID

get /orders/{order_id}/executions/{execution_id}

Returns the order execution specified by its ID.

Authentication

OAuth2 oauth-client-credentials

Required Scopes:

orders:readorders:admin

All Scopes

  • 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

execution_id

string

uuid

required

order_id

string

uuid

required

Responses

Response Headers

upvest-request-id

string

uuid

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

Response: application/json

id

string

uuid

required

cash_amount

string

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

required

share_quantity

string

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

required

price

string

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

required

transaction_time

string

date-time

required

taxes

array[object (Tax)]

required

Tax

object (Tax)

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

amount

string

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

required

order_id

string

uuid

required

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Headers

upvest-request-id

string

uuid

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

Response: application/problem+json

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.

Response Examples

{
  "cash_amount": "56.65",
  "currency": "EUR",
  "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e",
  "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
  "price": "130.65",
  "share_quantity": "0.05",
  "side": "BUY",
  "status": "FILLED",
  "taxes": [
    {
      "amount": "1.3",
      "type": "TOTAL"
    }
  ],
  "transaction_time": "2021-07-21T14:10:00.00Z"
}
{
  "status": 401,
  "type": "unauthorized"
}
{
  "status": 403,
  "type": "forbidden"
}
{
  "status": 404,
  "type": "not_found"
}
{
  "status": 406,
  "type": "not_acceptable"
}
{
  "status": 429,
  "type": "too_many_requests"
}
{
  "status": 500,
  "type": "internal_server_error"
}
{
  "status": 503,
  "type": "method_not_allowed"
}

Executions events

webhook

Executions events

application/json

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

cash_amount

string

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

required

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

id

string

uuid

required

order_id

string

uuid

required

price

string

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

required

share_quantity

string

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

required

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

taxes

array[object (Tax)]

required

Tax

object (Tax)

amount

string

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

required

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

transaction_time

string

date-time

required

type

string

required

Event type

Enum
  • EXECUTION.FILLED
  • EXECUTION.SETTLED
  • EXECUTION.CANCELLED

webhook_id

string

uuid

required

Webhook unique identifier.

Responses

Request Examples

{
  "created_at": "2022-11-17T10:42:34.758Z",
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "object": {
    "cash_amount": "852.20",
    "currency": "EUR",
    "id": "b40f4631-e83b-4737-a003-c0cb36382bc5",
    "order_id": "cd2d6019-c11d-4114-aab3-b2e5dbe58cbf",
    "price": "85.22",
    "share_quantity": "10",
    "side": "BUY",
    "status": "FILLED",
    "taxes": [
      {
        "amount": "0",
        "type": "TOTAL"
      }
    ],
    "transaction_time": "2022-11-17T10:42:34.758Z"
  },
  "type": "EXECUTION.FILLED",
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Orders events

webhook

Orders events

application/json

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

The ID of the account that owns the order

cancellation_reason

string

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

  • CANCELLED_BY_CLIENT -
  • CANCELLED_BY_UPVEST_OPERATIONS -
  • CANCELLED_BY_TRADING_PARTNER -
  • CANCELLED_BY_UPVEST_PLATFORM -
Enum
  • CANCELLED_BY_CLIENT
  • CANCELLED_BY_UPVEST_OPERATIONS
  • CANCELLED_BY_TRADING_PARTNER
  • CANCELLED_BY_UPVEST_PLATFORM

cash_amount

required

Cash amount for a nominal order, not needed if share quantity is specified

client_reference

string

required

An ID provided by the client

Max Length
100

created_at

string

date-time

required

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

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

executions

array[object (Order execution)]

required

Order executions associated with this order

Order execution

object (Order execution)

cash_amount

string

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

required

currency

string

ISO4217

required

Three-letter ISO 4217 alphabetical currency code.

  • EUR - Euro
Default
"EUR"
Enum
  • EUR

id

string

uuid

required

order_id

string

uuid

required

price

string

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

required

share_quantity

string

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

required

side

string

required

Side of the execution.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

status

string

required

Execution status of the Execution.

  • FILLED -
  • SETTLED -
  • CANCELLED -
Enum
  • FILLED
  • SETTLED
  • CANCELLED

taxes

array[object (Tax)]

required

Tax

object (Tax)

amount

string

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

required

type

string

required

Tax type

  • TOTAL -
Default
"TOTAL"
Enum
  • TOTAL

transaction_time

string

date-time

required

expiry_date

string

^[0-9]{4}-[0-9]{2}-[0-9]{2}$

[COMING SOON] Date of order expiration (last day the order can trade) in YYYY-MM-DD format. RFC 3339, section 5.6 RFC 3339

fee

string

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

required

id

string

uuid

required

initiation_flow

string

required

Initiation flow used during order creation, i.e. what triggered the order.

  • API -
  • PORTFOLIO -
  • CASH_DIVIDEND_REINVESTMENT -
  • PORTFOLIO_REBALANCING -
  • SELL_TO_COVER_FEES -
  • SELL_TO_COVER_TAXES -
Enum
  • API
  • PORTFOLIO
  • CASH_DIVIDEND_REINVESTMENT
  • PORTFOLIO_REBALANCING
  • SELL_TO_COVER_FEES
  • SELL_TO_COVER_TAXES

instrument_id

string

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

required

International securities identification number defined by ISO 6166.

instrument_id_type

string

required

The type of the ID used in the request.

  • ISIN -
Default
"ISIN"
Enum
  • ISIN

limit_price

string

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

[COMING SOON] The limit price for limit type order

order_type

string

required

Type of the order.

  • MARKET -
  • LIMIT - [COMING SOON]
  • STOP - [COMING SOON]
Enum
  • MARKET
  • LIMIT
  • STOP

price

string

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

[DEPRECATED] The limit or stop price for limit and stop orders respectively.

quantity

string

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

required

Quantity of securities for the order. Only needed if the cash amount is not specified

side

string

required

Side of the order.

  • BUY -
  • SELL -
Enum
  • BUY
  • SELL

status

string

required

The execution status of the order.

  • NEW -
  • PROCESSING -
  • FILLED -
  • CANCELLED -
Enum
  • NEW
  • PROCESSING
  • FILLED
  • CANCELLED

stop_price

string

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

[COMING SOON] The stop price for stop type order

updated_at

string

date-time

required

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

user_id

string

uuid

required

The ID of the user

user_instrument_fit_acknowledgement

boolean

Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.

type

string

required

Event type

Enum
  • ORDER.NEW
  • ORDER.PROCESSING
  • ORDER.FILLED
  • ORDER.CANCELLED

webhook_id

string

uuid

required

Webhook unique identifier.

Responses

Request Examples

{
  "created_at": "2021-07-21T14:10:00.00Z",
  "id": "8962b496-8d42-4560-bfab-10490dd1a721",
  "object": {
    "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3",
    "cash_amount": "56.65",
    "client_reference": "",
    "created_at": "2021-07-21T14:10:00.00Z",
    "currency": "EUR",
    "executions": [],
    "fee": "0.5",
    "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c",
    "initiation_flow": "API",
    "instrument_id": "US0378331005",
    "instrument_id_type": "ISIN",
    "order_type": "MARKET",
    "price": "",
    "quantity": "0.05",
    "side": "BUY",
    "status": "NEW",
    "updated_at": "2021-07-21T14:10:00.00Z",
    "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9",
    "user_instrument_fit_acknowledgement": true
  },
  "type": "ORDER.NEW",
  "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6"
}

Was this page helpful?