Skip to content
API Reference/
/
Retrieve a savings plan

Upvest Investment API (1.75.0)

Upvest Investment API.

Download OpenAPI description
api.json
api.yaml
Overview
URL

https://docs.upvest.co

Upvest API Support

api@upvest.co

License

Apache 2.0

Languages
Servers
Sandbox environment

https://sandbox.upvest.co/

Live environment

https://api.upvest.co/

Access Tokens

All authentication related paths.

Operations

Users

All user related paths.

OperationsWebhooks

User Identifiers

All user identifiers related paths.

Operations

User Checks

All user checks related paths.

OperationsWebhooks

Accounts

All accounts related paths

OperationsWebhooks

Account Groups

All account groups related paths

OperationsWebhooks

Tax Residencies

All tax residencies related paths.

Operations

Corporate Actions

All Corporate Action related paths.

Webhooks

Tax Exemptions

All tax exemptions related paths

OperationsWebhooks

Tax Collections

All tax collections related paths

Webhooks

Tax Wrappers

All tax wrappers related paths

OperationsWebhooks

Instruments

All instrument related paths.

OperationsWebhooks

Price Data

All price data related paths.

Operations

Orders

All order related paths.

OperationsWebhooks

Portfolios

All portfolios related paths.

Operations

Portfolios Rebalancing

All portfolios rebalancing related paths.

OperationsWebhooks

Savings Plans

All savings plans related paths.

OperationsWebhooks

Retrieve a savings plan

Request

Retrieve a savings plan specified by its ID.

Security
oauth-client-credentials
Path
savings_plan_idstring(uuid)required
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^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==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
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'

Responses

OK

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
idstring(uuid)required
user_idstring(uuid)required

User unique identifier.

account_idstring(uuid)required

Account unique identifier.

typestringrequired

Type of the Savings plan.

  • PORTFOLIO -
  • INSTRUMENT -
Enum"PORTFOLIO""INSTRUMENT"
cash_amountstring^[0-9]{0,63}(\.[0-9]{1,27})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
start_datestring^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[0...required

First date of the savings plan execution in YYYY-MM-DD format.

periodstringrequired

Unit of time.

  • WEEK -
  • MONTH -
  • YEAR -
Enum"WEEK""MONTH""YEAR"
intervalinteger[ 1 .. 1000 ]required

Number of periods between executions

Default 1
created_atstring(date-time)required

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

updated_atstring(date-time)required

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

namestring

Savings plan name

instrument_idstring
One of:

International securities identification number defined by ISO 6166.

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

The type of the ID used in the request.

  • ISIN - International Securities Identification Number
  • WKN - German securities identification code
Default "ISIN"
Enum"ISIN""WKN"
statusstring

Status of a Savings Plan.

  • ACTIVE -
  • CANCELLED -
Enum"ACTIVE""CANCELLED"
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"
}

Delete a savings plan

Request

Delete a savings plan specified by its ID.

Security
oauth-client-credentials
Path
savings_plan_idstring(uuid)required
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^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==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
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'

Responses

The request has been successfully accepted and will be processed asynchronously.

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Response
No content

List savings plans

Request

List savings plans

Security
oauth-client-credentials
Query
account_idstring

Filters savings plans by account ID

Example: account_id=3ada8e9e-82c4-4c78-a43d-a691b1636509
user_idstring

Filters savings plans by user ID

Example: user_id=996e5e2c-bb76-4a38-8d5c-ff43d86904da
instrument_idstring
Example: instrument_id=FR0010524777
One of:

International securities identification number defined by ISO 6166.

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

Sort the result by id.

Default "id"
Value"id"
orderstring

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

Default "ASC"
Value"ASC"
offsetinteger(int32)>= 0

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

limitinteger(int32)[ 0 .. 1000 ]

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

Default 100
Headers
upvest-client-idstring(uuid)required

Tenant Client ID

Example: ebabcf4d-61c3-4942-875c-e265a7c2d062
authorizationstring^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==
signaturestringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-http-header

signature-inputstringrequired

https://tools.ietf.org/id/draft-ietf-httpbis-message-signatures-01.html#name-the-signature-input-http-he

upvest-api-versionstring

Upvest API version (Note: Do not include quotation marks)

Default 1
Value"1"
Example: 1
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'

Responses

OK

Headers
upvest-request-idstring(uuid)required
Example: "169ae4c7-ebd7-4041-94da-25369653eba7"
Bodyapplication/json
metaobjectrequired
offsetintegerrequired

Amount of resource to offset in the response.

limitintegerrequired

Total limit of the response.

countintegerrequired

Count of the resources returned in the response.

total_countintegerrequired

Total count of all the resources.

sortstring

The field that the list is sorted by.

orderstring

The ordering of the response.

  • ASC - Ascending order
  • DESC - Descending order
Enum"ASC""DESC"
dataArray of objectsrequired
idstring(uuid)required
user_idstring(uuid)required

User unique identifier.

account_idstring(uuid)required

Account unique identifier.

typestringrequired

Type of the Savings plan.

  • PORTFOLIO -
  • INSTRUMENT -
Enum"PORTFOLIO""INSTRUMENT"
cash_amountstring^[0-9]{0,63}(\.[0-9]{1,27})?$required
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
start_datestring^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[0...required

First date of the savings plan execution in YYYY-MM-DD format.

periodstringrequired

Unit of time.

  • WEEK -
  • MONTH -
  • YEAR -
Enum"WEEK""MONTH""YEAR"
intervalinteger[ 1 .. 1000 ]required

Number of periods between executions

Default 1
created_atstring(date-time)required

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

updated_atstring(date-time)required

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

namestring

Savings plan name

instrument_idstring
One of:

International securities identification number defined by ISO 6166.

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

The type of the ID used in the request.

  • ISIN - International Securities Identification Number
  • WKN - German securities identification code
Default "ISIN"
Enum"ISIN""WKN"
statusstring

Status of a Savings Plan.

  • ACTIVE -
  • CANCELLED -
Enum"ACTIVE""CANCELLED"
Response
application/json
{
  "meta": {
    "offset": 0,
    "limit": 100,
    "count": 1,
    "total_count": 1,
    "sort": "id",
    "order": "ASC"
  },
  "data": [
    { … }
  ]
}

Liquidations

All accounts liquidations related paths.

OperationsWebhooks

Direct Debits

All direct debits related paths

OperationsWebhooks

Top-ups

All top-ups related paths

OperationsWebhooks

Withdrawals

All withdrawals related paths

OperationsWebhooks

Reference Accounts

All reference account related paths

Operations

Mandates

All direct debit mandates related paths

Operations

Cash Balances

All cash balance related paths

OperationsWebhooks

Positions

All positions related paths.

OperationsWebhooks

Valuations

All valuations related paths.

OperationsWebhooks

Returns

All accounts returns related paths.

OperationsWebhooks

Virtual Cash Balances

All virtual cash balances related paths

OperationsWebhooks

Fees

All fees related paths.

OperationsWebhooks

Fees Configurations

All fees configurations related paths.

Operations

Reports

All reports related paths.

OperationsWebhooks

Treasury Reports

All treasury reports related paths.

Webhooks

Transactions

All transactions related paths.

OperationsWebhooks

Files

All files API related paths.

Operations

Webhook Subscriptions

All webhook subscriptions related paths.

Operations

Virtual Bank Accounts

All virtual bank accounts related paths

OperationsWebhooks

Tests

All test related paths.

Operations