Upvest Investment API.
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
Query
Returns account valuations starting from and including this date (UTC)
Example: start_date=2023-01-03
Returns account valuations up until this date (UTC)
Example: end_date=2023-01-11
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"
Use the offset argument to specify where in the list of results to start when returning items for a particular query.
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/accounts/{account_id}/valuations
- Live environment
https://api.upvest.co/accounts/{account_id}/valuations
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/accounts/{account_id}/valuations?start_date=2023-01-03&end_date=2023-01-11&sort=valuation_time&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'Valuations
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
Date and time as of which the value was calculated. RFC 3339-5, ISO8601 UTC
Entity representing the monetary value by amount and currency.
The requested price quality.
- EOD - End of day prices
- HIGHEST_AVAILABLE - The most recent available prices
Enum"EOD""HIGHEST_AVAILABLE"
Response
application/json
{ "meta": { "offset": 0, "limit": 100, "count": 3, "total_count": 3, "sort": "created_at", "order": "ASC" }, "data": [ { … }, { … }, { … } ] }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
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
Date and time as of which the value was calculated. RFC 3339-5, ISO8601 UTC
Entity representing the monetary value by amount and currency.
The requested price quality.
- EOD - End of day prices
- HIGHEST_AVAILABLE - The most recent available prices
Enum"EOD""HIGHEST_AVAILABLE"
- Sandbox environment
https://sandbox.upvest.co/Account valuation events
- Live environment
https://api.upvest.co/Account valuation events
application/json
{ "id": "8962b496-8d42-4560-bfab-10490dd1a721", "created_at": "2023-01-10T00:15:32Z", "type": "ACCOUNT_VALUATION.CREATED", "object": { "id": "404b170a-9042-11ed-9a51-2eabd0c03f8a", "created_at": "2023-01-10T00:15:22Z", "updated_at": "2023-01-10T00:15:22Z", "valuation_time": "2023-01-10T00:15:22Z", "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a", "price_quality": "EOD", "total_security_value": { … }, "security_positions": [ … ] }, "webhook_id": "9df39835-be87-4243-9018-f2500b39cee6" }
Bodyapplication/json
Date and time when the event was created. RFC 3339-5, ISO8601 UTC
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
Date and time as of which the value was calculated. RFC 3339-5, ISO8601 UTC
Entity representing the monetary value by amount and currency.
The requested price quality.
- EOD - End of day prices
- HIGHEST_AVAILABLE - The most recent available prices
Enum"EOD""HIGHEST_AVAILABLE"
- Sandbox environment
https://sandbox.upvest.co/Intraday account valuation events
- Live environment
https://api.upvest.co/Intraday account valuation events
application/json
{ "id": "8962b496-8d42-4560-bfab-10490dd1a722", "created_at": "2023-01-10T14:15:32Z", "type": "INTRADAY_ACCOUNT_VALUATION.CREATED", "object": { "id": "404b170a-9042-11ed-9a51-2eabd0c03f8b", "created_at": "2023-01-10T14:15:22Z", "updated_at": "2023-01-10T14:15:22Z", "valuation_time": "2023-01-10T14:15:22Z", "account_id": "51cdc0cc-9042-11ed-b017-2eabd0c03f8a", "price_quality": "EOD", "total_security_value": { … }, "security_positions": [ … ] }, "webhook_id": "9df39835-be87-4243-9018-f2500b39cee7" }