Instruments
Download SpecAll instrument related paths.
trading_status
string
Filters the list to only show instruments with a certain status (e.g. only instruments that can be currently traded).
- Enum
-
- ACTIVE
- INACTIVE
- Example
- "ACTIVE"
sort
string
Sort the result by created_at
or updated_at
.
- Default
- "created_at"
- Enum
-
- created_at
- updated_at
order
string
Sort order of the result list if the sort
parameter is specified. Use ASC
for ascending or DESC
for descending sort order.
- Default
- "ASC"
- Enum
-
- ASC
- DESC
offset
int
int32
Use the offset
argument to specify where in the list of results to start when returning items for a particular query.
- Min
- 0
limit
int
int32
Use the limit
argument to specify the maximum number of items returned.
- Default
- 100
- Min
- 0
- Max
- 1000
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^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=="
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)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
oauth-client-credentials
Required Scopes:
instruments:read
List instruments
All Scopes
-
account_liquidations:admin
· Trigger/read/cancel accounts liquidations -
account_liquidations:read
· Read accounts liquidations -
account_returns:read
· Read accounts returns -
accounts:admin
· Create/update/delete accounts and account groups -
accounts:read
· Read accounts and account groups -
checks:admin
· Create checks -
checks:read
· Read checks -
credit_fundings:read
· Credit Fundings read operations -
fees:admin
· Create and read fee operations -
fees:read
· Read fee operations -
files:read
· Read files metadata -
instruments:read
· Read instruments -
mandates:admin
· Create/update/delete mandates -
mandates:read
· Read mandates -
orders:admin
· Create/update/delete orders -
orders:read
· Read orders -
payments:admin
· Payins and withdrawal operations -
payments:read
· Payins and withdrawal read operations -
portfolios:admin
· Modify portfolios -
portfolios:read
· Read portfolios -
positions:read
· Read positions -
prices:read
· Read instrument prices, -
reference_accounts:admin
· Create/update/delete reference accounts -
reference_accounts:read
· Read reference accounts -
reports:admin
· Create reports -
reports:read
· Read reports -
savings_plans:admin
· Create/read savings plans -
savings_plans:read
· Read savings plans -
securities_transfers:admin
· Securities Transfers operations -
securities_transfers:read
· Securities Transfers read transfers -
taxes:admin
· Modify tax residencies and tax exemptions -
taxes:read
· Read tax residencies -
tests:admin
· Testing related operations -
topups:admin
· Top-ups operations -
topups:read
· Top-ups read operations -
transactions:read
· Read cash and securities transactions -
users:admin
· Create/update/delete users -
users:read
· Read users -
valuations:read
· Read valuations -
virtual_cash_balances:admin
· Virtual cash balances -
webhooks:admin
· Create/update/delete webhooks -
webhooks:read
· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
Response
OK
{
"meta": {
"offset": 0,
"limit": 100,
"count": 1,
"total_count": 10,
"sort": "created_at",
"order": "ASC"
},
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2022-08-31T17:28:00.00Z",
"updated_at": "2022-08-31T17:28:00.00Z",
"isin": "DE0007664005",
"wkn": "766400",
"name": "Volkswagen (VW) St. Aktie.",
"fractional_trading": true,
"trading_status": "ACTIVE"
}
]
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad Request. The incoming request had a malformed parameter/object.
{
"status": 400,
"type": "bad_request"
}
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}
Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}
Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}
Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}
Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}
Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}
Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
meta
object (meta)
required
offset
int
required
Amount of resource to offset in the response.
limit
int
required
Total limit of the response.
count
int
required
Count of the resources returned in the response.
total_count
int
required
Total count of all the resources.
sort
string
The field that the list is sorted by.
order
string
The ordering of the response.
- ASC - Ascending order
- DESC - Descending order
- Enum
-
- ASC
- DESC
data
array[object]
required
object
id
string
uuid
required
Instrument unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
isin
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
wkn
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
name
string
required
Instrument name
- Max Length
- 100
fractional_trading
boolean
required
Determines whether the platform can handle fractional investments within this instrument.
trading_status
string
required
Instrument trading status
- ACTIVE - The instrument can currently be traded on the Upvest platform.
- INACTIVE - The instrument cannot currently be traded on the Upvest platform.
- Enum
-
- ACTIVE
- INACTIVE
details
object (details)
Details
distribution_countries
array[string]
Distribution Countries
string
^[A-Z]{2}$
Country code. ISO 3166 alpha-2 Codes.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
instrument_id
One Of
required
Instrument unique identifier.
International securities identification number with 'isin:' URN namespace
string
^(urn:)?isin:[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166, prefixed with a 'isin:' URN scheme.
Universally Unique IDentifier (UUID) with 'uuid:' URN scheme
string
^(urn:)?uuid:[0-9a-fA-F]{8}-?[0-9a-fA-F]{4}-?[0-5][0-9a-fA-F]{3}-?[089abAB][0-9a-fA-F]{3}-?[0-9a-fA-F]{12}$
Universally Unique IDentifier (UUID) with 'uuid:' URN namespace, defined by RFC 4122.
upvest-client-id
string
uuid
required
Tenant Client ID
- Example
- "ebabcf4d-61c3-4942-875c-e265a7c2d062"
authorization
string
^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=="
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)
- Default
- "1"
- Enum
-
- 1
- Example
- "1"
oauth-client-credentials
Required Scopes:
instruments:read
Returns the instrument.
All Scopes
-
account_liquidations:admin
· Trigger/read/cancel accounts liquidations -
account_liquidations:read
· Read accounts liquidations -
account_returns:read
· Read accounts returns -
accounts:admin
· Create/update/delete accounts and account groups -
accounts:read
· Read accounts and account groups -
checks:admin
· Create checks -
checks:read
· Read checks -
credit_fundings:read
· Credit Fundings read operations -
fees:admin
· Create and read fee operations -
fees:read
· Read fee operations -
files:read
· Read files metadata -
instruments:read
· Read instruments -
mandates:admin
· Create/update/delete mandates -
mandates:read
· Read mandates -
orders:admin
· Create/update/delete orders -
orders:read
· Read orders -
payments:admin
· Payins and withdrawal operations -
payments:read
· Payins and withdrawal read operations -
portfolios:admin
· Modify portfolios -
portfolios:read
· Read portfolios -
positions:read
· Read positions -
prices:read
· Read instrument prices, -
reference_accounts:admin
· Create/update/delete reference accounts -
reference_accounts:read
· Read reference accounts -
reports:admin
· Create reports -
reports:read
· Read reports -
savings_plans:admin
· Create/read savings plans -
savings_plans:read
· Read savings plans -
securities_transfers:admin
· Securities Transfers operations -
securities_transfers:read
· Securities Transfers read transfers -
taxes:admin
· Modify tax residencies and tax exemptions -
taxes:read
· Read tax residencies -
tests:admin
· Testing related operations -
topups:admin
· Top-ups operations -
topups:read
· Top-ups read operations -
transactions:read
· Read cash and securities transactions -
users:admin
· Create/update/delete users -
users:read
· Read users -
valuations:read
· Read valuations -
virtual_cash_balances:admin
· Virtual cash balances -
webhooks:admin
· Create/update/delete webhooks -
webhooks:read
· Read webhooks
- Flow Type:
- client_credentials
- Token URL:
- https://sandbox.upvest.co/auth/token
Response
OK
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2022-08-31T17:28:00.00Z",
"updated_at": "2022-08-31T17:28:00.00Z",
"isin": "DE0007664005",
"wkn": "766400",
"name": "Volkswagen (VW) St. Aktie.",
"fractional_trading": true,
"trading_status": "ACTIVE"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Unauthorized. The caller has not been authenticated.
{
"status": 401,
"type": "unauthorized"
}
Forbidden. The caller has been authenticated but is not allowed to take the requested action.
{
"status": 403,
"type": "forbidden"
}
Not Found. The requested resource could not be found.
{
"status": 404,
"type": "not_found"
}
Not Acceptable. The resource does not have a current representation that would be acceptable to the user agent. "Accept" header defined unsupported value.
{
"status": 406,
"type": "not_acceptable"
}
Too Many Requests. The caller has exceeded their quota for the time period and has been throttled.
{
"status": 429,
"type": "too_many_requests"
}
Internal Server Error. The service encountered an unexpected error.
{
"status": 500,
"type": "internal_server_error"
}
Service Unavailable. The service handling for this request cannot be reached at this time.
{
"status": 503,
"type": "method_not_allowed"
}
Gateway Timeout. The service gateway has reached its internal timeout.
{
"status": 504,
"type": "gateway_timeout"
}
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
type
string
required
URL to a document describing the error condition.
status
int
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.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
id
string
uuid
required
Instrument unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
isin
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
wkn
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
name
string
required
Instrument name
- Max Length
- 100
fractional_trading
boolean
required
Determines whether the platform can handle fractional investments within this instrument.
trading_status
string
required
Instrument trading status
- ACTIVE - The instrument can currently be traded on the Upvest platform.
- INACTIVE - The instrument cannot currently be traded on the Upvest platform.
- Enum
-
- ACTIVE
- INACTIVE
details
object (details)
Details
distribution_countries
array[string]
Distribution Countries
string
^[A-Z]{2}$
Country code. ISO 3166 alpha-2 Codes.
upvest-request-id
string
uuid
required
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Instruments events
id
string
uuid
required
Event unique identifier
created_at
string
date-time
required
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
type
string
required
Event type
- Enum
-
- INSTRUMENT.ONBOARDED
- INSTRUMENT.ACTIVATED
- INSTRUMENT.DEACTIVATED
- INSTRUMENT.FRACTIONAL_TRADING_ENABLED
- INSTRUMENT.FRACTIONAL_TRADING_DISABLED
- INSTRUMENT.DATA_CHANGED
object
object (object)
required
id
string
uuid
required
Instrument unique identifier.
created_at
string
date-time
required
Date and time when the resource was created. RFC 3339-5, ISO8601 UTC
updated_at
string
date-time
required
Date and time when the resource was last updated. RFC 3339-5, ISO8601 UTC
isin
string
^[A-Z]{2}[A-Z0-9]{9}[0-9]$
International securities identification number defined by ISO 6166.
wkn
string
^[A-HJ-NP-Z0-9]{6}$
German securities identification code known as Wertpapierkennnummer.
name
string
required
Instrument name
- Max Length
- 100
fractional_trading
boolean
required
Determines whether the platform can handle fractional investments within this instrument.
trading_status
string
required
Instrument trading status
- ACTIVE - The instrument can currently be traded on the Upvest platform.
- INACTIVE - The instrument cannot currently be traded on the Upvest platform.
- Enum
-
- ACTIVE
- INACTIVE
details
object (details)
Details
distribution_countries
array[string]
Distribution Countries
string
^[A-Z]{2}$
Country code. ISO 3166 alpha-2 Codes.
webhook_id
string
uuid
required
Webhook unique identifier.
Request
{
"id": "de4e9e75-5c74-44c7-b741-9b3e0d85f4de",
"created_at": "2022-08-31T17:28:00.00Z",
"type": "INSTRUMENT.ACTIVATED",
"object": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2022-03-31T17:28:00.00Z",
"updated_at": "2022-08-31T17:28:00.00Z",
"isin": "DE0007664005",
"wkn": "766400",
"name": "Volkswagen (VW) St. Aktie.",
"fractional_trading": true,
"trading_status": "ACTIVE"
},
"webhook_id": "0af63506-289c-4051-8859-4e17ec89b002"
}
Response
Request has been processed successfully.
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
No schema
Was this page helpful?