Upvest Investment API.
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Path
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
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/instruments/{instrument_id}
- Live environment
https://api.upvest.co/instruments/{instrument_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/instruments/{instrument_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
Determines whether the platform can handle fractional investments within this instrument.
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"
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
International securities identification number defined by ISO 6166.
German securities identification code known as Wertpapierkennnummer.
Response
application/json
{ "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" }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
Event type
Enum"INSTRUMENT.ONBOARDED""INSTRUMENT.ACTIVATED""INSTRUMENT.DEACTIVATED""INSTRUMENT.FRACTIONAL_TRADING_ENABLED""INSTRUMENT.FRACTIONAL_TRADING_DISABLED""INSTRUMENT.DATA_CHANGED"
Determines whether the platform can handle fractional investments within this instrument.
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"
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
International securities identification number defined by ISO 6166.
German securities identification code known as Wertpapierkennnummer.
- Sandbox environment
https://sandbox.upvest.co/Instruments events
- Live environment
https://api.upvest.co/Instruments events
application/json
{ "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" }