# List portfolios orders List portfolios orders Endpoint: GET /portfolios/orders Version: 1.75.0 Security: oauth-client-credentials ## Header parameters: - `upvest-client-id` (string, required) Tenant Client ID Example: "ebabcf4d-61c3-4942-875c-e265a7c2d062" - `authorization` (string, 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) Enum: "1" ## Query parameters: - `sort` (string) Sort the result by id. Enum: "id" - `order` (string) Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort. Enum: "ASC" - `offset` (integer) Use the offset argument to specify where in the list of results to start when returning items for a particular query. - `limit` (integer) Use the limit argument to specify the maximum number of items returned. - `start_date` (string) Returns portfolio orders with dates starting from and including this date (UTC) Example: "2022-10-14T10:10:10Z" - `end_date` (string) Returns portfolio orders with dates up until this date (UTC) Example: "2022-10-14T10:10:10Z" - `allocation_id` (string) Filters portfolio orders containing the allocation id Example: "f96eaefd-b4c6-477a-9bbe-c744bf26172f" - `account_id` (string) Filters portfolio orders containing the account id Example: "2c865aab-6737-4b0e-9154-69a4622b2727" ## Response 200 fields (application/json): - `meta` (object, required) - `meta.offset` (integer, required) Amount of resource to offset in the response. - `meta.limit` (integer, required) Total limit of the response. - `meta.count` (integer, required) Count of the resources returned in the response. - `meta.total_count` (integer, required) Total count of all the resources. - `meta.sort` (string) The field that the list is sorted by. - `meta.order` (string) The ordering of the response. * ASC - Ascending order * DESC - Descending order Enum: "ASC", "DESC" - `data` (array, required) - `data.id` (string, required) - `data.created_at` (string, required) Date and time when the resource was created. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html) - `data.updated_at` (string, required) Date and time when the resource was last updated. [RFC 3339-5](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6), [ISO8601 UTC](https://www.iso.org/iso-8601-date-and-time-format.html) - `data.account_id` (string, required) Account unique identifier. - `data.cash_amount` (string, required) - `data.currency` (string, required) Alphabetic three-letter [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code. * EUR - Euro Enum: "EUR" - `data.status` (string, required) Execution status of the Portfolio Order. * NEW - * PROCESSING - * FILLED - * SETTLED - * CANCELLED - Enum: "NEW", "PROCESSING", "FILLED", "SETTLED", "CANCELLED" - `data.post_tax` (boolean, required) Cash amount is post-tax value - `data.client_reference` (string, required) - `data.initiation_flow` (string, required) What triggered the order creation . * API - * SAVINGS_PLAN - Enum: "API", "SAVINGS_PLAN" - `data.orders` (array, required) Orders associated with this portfolio order - `data.orders.side` (string, required) Side of the portfolio order. * BUY - * SELL - Enum: "BUY", "SELL" - `data.orders.status` (string, required) The execution status of the order. * NEW - * PROCESSING - * FILLED - * CANCELLED - Enum: "NEW", "PROCESSING", "FILLED", "CANCELLED" - `data.user_id` (string) User unique identifier. - `data.allocation_id` (string) - `data.type` (string) Type of the Portfolio Order. * BUY - * SELL - * REBALANCING - Enum: "BUY", "SELL", "REBALANCING" - `data.cancellation_reason` (string) 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" - `data.cancellation_details` (string) ## Response 400 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 401 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 403 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 404 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 405 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 406 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 429 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 500 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 503 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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 504 fields (application/problem+json): - `type` (string, required) URL to a document describing the error condition. - `status` (integer, 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.