Upvest Investment API.
Savings Plans
Access Tokens
Users
User Identifiers
User Checks
Accounts
Account Groups
Tax Residencies
Corporate Actions
Tax Wrappers
Tax Exemptions
Tax Collections
Instruments
Price Data
Orders
Portfolios
Portfolios Rebalancing
Liquidations
Direct Debits
Top-ups
Withdrawals
Reference Accounts
Mandates
Virtual Bank Accounts
Credit Fundings
Cash Balances
Positions
Valuations
Returns
Virtual Cash Balances
Fees
Fees Configurations
Reports
Treasury Reports
Transactions
Files
Webhook Subscriptions
Tests
Upvest Investment API (1.76.1)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/savings_plans/{savings_plan_id}
- Live environment
https://api.upvest.co/savings_plans/{savings_plan_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/savings_plans/{savings_plan_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'OK
First date of the savings plan execution in YYYY-MM-DD format.
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
One of:
International securities identification number defined by ISO 6166.
string^[A-Z]{2}[A-Z0-9]{9}[0-9]$
The type of the ID used in the request.
- ISIN - International Securities Identification Number
- WKN - German securities identification code
Default "ISIN"
Enum"ISIN""WKN"
Response
application/json
{ "id": "fc34d28e-38f5-49d2-92f6-82acb79098f4", "created_at": "2023-07-21T14:10:00.00Z", "updated_at": "2023-07-21T15:10:00.00Z", "user_id": "4b9732bd-7496-4913-8a5f-6360479d7fed", "account_id": "00ef0be8-d564-43af-b3c7-11b7a2188030", "name": "Instrument savings plan", "type": "INSTRUMENT", "instrument_id": "DE0007664005", "instrument_id_type": "ISIN", "cash_amount": "100.00", "currency": "EUR", "start_date": "2023-07-24", "period": "WEEK", "interval": 1, "status": "ACTIVE" }
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/savings_plans/{savings_plan_id}
- Live environment
https://api.upvest.co/savings_plans/{savings_plan_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://sandbox.upvest.co/savings_plans/{savings_plan_id}' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'Response
No contentQuery
Filters savings plans by account ID
Example: account_id=3ada8e9e-82c4-4c78-a43d-a691b1636509
Example: instrument_id=FR0010524777
One of:
International securities identification number defined by ISO 6166.
string^[A-Z]{2}[A-Z0-9]{9}[0-9]$
Sort order of the result list if the sort parameter is specified. By default, only ASC for ascending sort.
Default "ASC"
Value"ASC"
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
Headers
Bearer (access) token from the OAuth flow with correct scopes. https://datatracker.ietf.org/doc/html/rfc6750
Example: Bearer c2VjcmV0Cg==
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header
https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he
- Sandbox environment
https://sandbox.upvest.co/savings_plans
- Live environment
https://api.upvest.co/savings_plans
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/savings_plans?account_id=3ada8e9e-82c4-4c78-a43d-a691b1636509&user_id=996e5e2c-bb76-4a38-8d5c-ff43d86904da&instrument_id=FR0010524777&sort=id&order=ASC&offset=0&limit=100' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'authorization: Bearer c2VjcmV0Cg==' \
-H 'signature: string' \
-H 'signature-input: string' \
-H 'upvest-api-version: 1' \
-H 'upvest-client-id: ebabcf4d-61c3-4942-875c-e265a7c2d062'OK
First date of the savings plan execution in YYYY-MM-DD format.
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
One of:
International securities identification number defined by ISO 6166.
string^[A-Z]{2}[A-Z0-9]{9}[0-9]$
The type of the ID used in the request.
- ISIN - International Securities Identification Number
- WKN - German securities identification code
Default "ISIN"
Enum"ISIN""WKN"
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 1, "total_count": 1, "sort": "id", "order": "ASC" }, "data": [ { … } ] }