Portfolios

List portfolios orders

Changed on

Returns a paginated list of portfolio orders for the authenticated client.

Portfolio orders represent buy or sell instructions that invest or withdraw a cash amount across all instruments in the account's current allocation.

See the Portfolios guide (TOL / BYOL) for order lifecycle details.

get/portfolios/orders

Request

  • Base URL: https://sandbox.upvest.co
  • URL: https://sandbox.upvest.co/portfolios/orders
  • Auth: OAuth 2 (client credentials, token URL https://sandbox.upvest.co/auth/token, scopes: portfolios:read, portfolios:admin)

Query parameters

sort'id'

Sort the result by id.

order'ASC'

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

offsetinteger

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

limitinteger

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

start_datestring

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

end_datestring

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

allocation_idstring uuid

Universally Unique Identifier (UUID) of a portfolio allocation.

Filters portfolio orders containing the allocation id

account_idstring uuid

Universally Unique Identifier (UUID) of the account.

Filters portfolio orders containing the account id

Response

Portfolios orders

Changes

  • 34243fe649c4Revision changes
    • warning

      added the new AUTO_INVESTMENT enum value to the // response property for the response status