Instruments
Download SpecAll instrument related paths.
Authentication
oauth-client-credentials
Required Scopes:
instruments:read
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
meta
object (meta)
required
data
array[object]
required
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Examples
{
"data": [
{
"created_at": "2022-08-31T17:28:00.00Z",
"fractional_trading": true,
"id": "123e4567-e89b-12d3-a456-426614174000",
"isin": "DE0007664005",
"name": "Volkswagen (VW) St. Aktie.",
"trading_status": "ACTIVE",
"updated_at": "2022-08-31T17:28:00.00Z",
"wkn": "766400"
}
],
"meta": {
"count": 1,
"limit": 100,
"offset": 0,
"order": "ASC",
"sort": "created_at",
"total_count": 10
}
}
{
"status": 400,
"type": "bad_request"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Authentication
oauth-client-credentials
Required Scopes:
instruments:read
Responses
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/json
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
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Headers
upvest-request-id
string
uuid
- Example
- "169ae4c7-ebd7-4041-94da-25369653eba7"
Response: application/problem+json
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.
Response Examples
{
"created_at": "2022-08-31T17:28:00.00Z",
"fractional_trading": true,
"id": "123e4567-e89b-12d3-a456-426614174000",
"isin": "DE0007664005",
"name": "Volkswagen (VW) St. Aktie.",
"trading_status": "ACTIVE",
"updated_at": "2022-08-31T17:28:00.00Z",
"wkn": "766400"
}
{
"status": 401,
"type": "unauthorized"
}
{
"status": 403,
"type": "forbidden"
}
{
"status": 404,
"type": "not_found"
}
{
"status": 406,
"type": "not_acceptable"
}
{
"status": 429,
"type": "too_many_requests"
}
{
"status": 500,
"type": "internal_server_error"
}
{
"status": 503,
"type": "method_not_allowed"
}
Was this page helpful?