The release notes on this page describe the API at the time of release. Refer to Latest releases for the latest release notes.
Also note, that the API Reference reflects the most current behaviour.
Docs update
With Upvest Investments API you have access to instrument and price data. This allows you to effectively handle specific instrument-related use cases, including the introduction of new instruments, delisting and trading bans, etc.
We have now published a detailed guide to help you understand the process of requesting instrument and price data.
We will show you step by step how to obtain instrument data and prices and how to implement business use cases for your needs.
Version 1.16.0 release
Normally, many of our payment flows can only be tested in conjunction with the corresponding bank transactions. While outgoing transactions are initiated by us and we can easily automate the artificial creation of bank transactions for testing payment flows, this is not so easy for flows that require incoming bank transactions such as top-ups or credit funding.
For this purpose we provide our clients with a new endpoint to create banking transactions.
Version 1.15.0 release
Hurray! We’re introducing savings plan features to your favorite API !
With this version of the Upvest Investments API, you can create savings plans for individual instruments and portfolios; there is virtually no limit to the number of savings plans you can create for your users.
Read how to use our Investment API to place the first investment order for an account, including all relevant status updates. Get to know the lifecycle of savings plans and its execution states.
Version 1.12.0 release
With this release we have introduced the user onboarding method LIVENESS_PHOTO_ID.
With the photo KYC method, the user submits photos of their document (front and back, tilted), a selfie and a liveness video (a short video in which they turn their head to the left and right) in addition to the usual personal data such as date of birth, place of residence, geolocation point of the device and document number.
Please note that this method is only supported outside of Germany due to compliance with anti-money laundering laws in Germany.
You can only onboard users whose place of residence is NOT in Germany by this method.
Docs update
We have published a new guide on virtual cash management.
The Investment API provides a virtual cash system for tracking and managing virtual funds for your end users. Learn more about the virtual cash management feature, which enables an increase to be triggered before an order is placed and a decrease to be triggered after the order execution has been completed.
This functionality not only simplifies the complexity of tracking cash that has not yet settled, but extends additional use cases, e.g. portfolio management and rebalancing, automatic reinvestment of cash dividends, sales to cover fees and reinvestment of tax refunds.
Version 1.11.0 release
We have added the following options to the /instruments endpoint:
GET
/instruments/{instrument_id}/venues
Returns the venues where the speicified instrument is traded and for which the price data is available.GET
/instruments/{instrument_id}/venues/{venue_id}/prices/latest
Returns the instrument's latest price as available at the specified venue.GET
/instruments/{instrument_id}/venues/{venue_id}/prices/ohlc
Returns OHLC prices for the instrument at the specified venue for the chosen period.
We have added two new fields to the portfolio object:
initiation_flowclient_reference
| Parameter | Description |
|---|---|
inition_flow | Possible values: * API * SAVINGS_PLAN This way it is distinguished where the portfolio order came from. |
client_reference | This field is empty if the portfolio order is created via API. It contains the savings_plan_id if portfolio order is created via a savings plan. |
Version 1.10.0 release
The user tax onboarding function via the Investment API is now available.
Read this guide in our documentation to learn why Upvest requires additional tax-related information from users prior to account opening, what information has to be provided to Upvest and how to interact with the Investment API endpoints to achieve it.
Go to the API reference
With this release, it is also possible to retrieve ex-ante reports for orders.
- With POST
/reportsyou can create an ex-ante cost report for an order by providing the required input data: - order details
- order type =
ORDER_EX_ANTE_COST.
Currently only ex-ante cost reporting for nominal and unit orders is supported (support for LIMITand STOP orders will be added soon).
- With GET
/reports/{report_id}you can retrieve reports in the following formats:- JSON
It is possible that the creation of the PDF report will take a little more time than the report creation response, and if needed you can use webhooks REPORT.CREATED to confirm that the PDF report has been created.
Other improvements
It is now possible to specify the transaction fees for the
BUYandSELLorder sides separately.The JSON response has been extended with some additional fields to cover all data displayed in the PDF.
Version 1.09.0 release
Version 1.08.0 release
For customers using the "Take our license" operating model, it is now possible to send an updated KYC check by posting to the /users/{user_id}/checks endpoint with the new kyc_update parameter set to true.
This new parameter is documented here.
Signature code samples
We now provide you with some Python and Javascript code examples, and show you how to implement V15 of the HTTP message signing mechanism and the authorisation tokens. These are needed for secure access to the Upvest Investment API.
Docs update
Testing portfolio rebalancing is a useful way to verify the effectiveness and accuracy of rebalancing executions, while understanding the flow of events and how best to integrate this functionality into your platform.
Read the new documentation chapter on how to test portfolio rebalancing in Sandbox.
Version 1.05.0 release
You can now specify order requests with "execution_flow": "BLOCK" to group orders from different end users and execute them at a predefined cut-off time according to your business requirements.
For more information on this function, see our guide 'Block orders'.
We have activated the following mock ISINs to work with block orders in the Sandbox: IE00BKBF6H24 , IE00B3XXRP09 , DE0005933931 , IE00BK5BCH80, IE00BM8QRZ79.
Big news!
We are pleased to share great and exciting news:
As of now we offer a NEWS section in our documentation portal.
We, at Upvest are constantly working hard to make the Investment API a top class experience. Check out changes and bug fixes.
- We will introduce you to the new features we have developed or improved through our continuous development.
- We let you know when specific actions are required to continue operating smoothly with the new features or updates.
- We will inform you about bug fixes, known issues & deprecations.
- And of course, we will direct you to the relevant documentation to get all the information you need.
To further maximise the transparency of changes, we offer our automatically generated changelogs.
Keep an eye on the detailed diffs to understand how they differ from the previous version so that you can better adapt to a new version.