Skip to content
API Reference/
/
Get instrument venues

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

Get instrument venues

Request

The venues where the instrument is traded and for which the price data is available.

Security
oauth-client-credentials
Path
instrument_idstringrequired
One of:

International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.

string^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$
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/instruments/{instrument_id}/venues' \
  -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
dataArray of objectsrequired
idstring(uuid)required

Venue unique identifier.

namestring

The name of venue.

price_qualitiesArray of strings

The available price qualities.

Items Enum"EOD""REALTIME""DELAYED"
Response
application/json
{
  "data": [
    { … }
  ]
}

Get instrument latest price

Request

Returns the instrument's latest price as available at the specified venue.

NOTE: Please note that in live mode we provide the latest prices that we receive from our data provider. However, it is to be expected that such updates will only take place on trading days.

Security
oauth-client-credentials
Path
instrument_idstringrequired
One of:

International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.

string^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$
venue_idstring(uuid)required

Venue unique identifier.

Query
price_qualitystring
Default "HIGHEST_AVAILABLE"
Value"HIGHEST_AVAILABLE"
Example: price_quality=HIGHEST_AVAILABLE
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/instruments/{instrument_id}/venues/{venue_id}/prices/latest?price_quality=HIGHEST_AVAILABLE' \
  -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
price_qualityanyrequired

The retrieved price quality.

  • REALTIME -
  • DELAYED -
Enum"REALTIME""DELAYED"
currencystringrequired

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
bidsArray of objects

Bids for the instrument.

asksArray of objects

Asks for the instrument.

last_tradeobject
Response
application/json
{
  "price_quality": "REALTIME",
  "currency": "EUR",
  "bids": [
    { … }
  ],
  "asks": [
    { … }
  ],
  "last_trade": {
    "time": "2023-01-09T12:59:04Z",
    "price": "211.32",
    "size": "40"
  }
}

Get instrument OHLC prices

Request

Returns OHLC prices for the instrument at the specified venue for the chosen time period.

If requested interval is 1d, then the response also includes days with 0 volume. In these cases open, high, low are empty (""), but close is provided. If requested interval is smaller than 1d, then the intervals with 0 volume are omitted from the response.

NOTE: Please note that in live mode we provide the latest prices that we receive from our data provider. However, it is to be expected that such updates will only take place on trading days.

Security
oauth-client-credentials
Path
instrument_idstringrequired
One of:

International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.

string^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$
venue_idstring(uuid)required

Venue unique identifier.

Query
start_datestring(date)

Returns OHLC prices from and including this datetime (UTC). If not specified, OHLC prices are returned from 30 days before the specified end_date. Time part of the timestamp is optional.

Example: start_date=2023-11-01T10:30:00Z
end_datestring(date)

Returns OHLC prices from and including this datetime (UTC). If not specified, OHLC prices are returned up to yesterday. Time part of the timestamp is optional.

Example: end_date=2023-11-15T13:30:00Z
adjusted_forstring

Indication of the desired data adjustment. Prices are adjusted for corporate actions such as cash dividends and stock splits. Does not apply if intraday prices are being requested.

Default "ALL"
Enum"NONE""ALL"
Example: adjusted_for=NONE
intervalstring^1d|[1-9][0-9]*[hm]$

Indicates the maximum length of the interval each OHLC price tuple covers. If a price did not change subsequent price tuples are omitted. Allowed values are 1d for daily prices or any positive integer followed by h or m for hour or minute, respectively. Requests are limited to a maximum of 1000 data points.

Default "1d"
Example: interval=4h
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/instruments/{instrument_id}/venues/{venue_id}/prices/ohlc?start_date=2023-11-01T10%3A30%3A00Z&end_date=2023-11-15T13%3A30%3A00Z&adjusted_for=NONE&interval=4h' \
  -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
dataArray of objectsrequired
currencystring

Alphabetic three-letter ISO 4217 currency code.

  • EUR - Euro
Default "EUR"
Value"EUR"
timestring(date-time)

The date and time indicating start of the interval. RFC 3339-5, ISO8601 UTC

openstring^-?[0-9]{0,63}(\.[0-9]{1,27})?$
closestring^-?[0-9]{0,63}(\.[0-9]{1,27})?$
highstring^-?[0-9]{0,63}(\.[0-9]{1,27})?$
lowstring^-?[0-9]{0,63}(\.[0-9]{1,27})?$
volumestring^-?[0-9]{0,63}(\.[0-9]{1,27})?$
metaobjectrequired
countinteger

Count of the resources returned in the response.

Response
application/json
{
  "data": [
    { … },
    { … }
  ],
  "meta": {
    "count": 2
  }
}

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

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