Upvest Investment API.
Upvest Investment API (1.75.0)
Overview
Languages
Servers
Sandbox environment
https://sandbox.upvest.co/
Live environment
https://api.upvest.co/
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/orders/{order_id}
- Live environment
https://api.upvest.co/orders/{order_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/orders/{order_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
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.
The type of the ID used in the request.
- ISIN -
Default "ISIN"
Value"ISIN"
The execution status of the order.
- NEW -
- PROCESSING -
- FILLED -
- CANCELLED -
Enum"NEW""PROCESSING""FILLED""CANCELLED"
Initiation flow used during order creation, i.e. what triggered the order.
- API -
- PORTFOLIO -
- CASH_DIVIDEND_REINVESTMENT -
- PORTFOLIO_REBALANCING -
- SELL_TO_COVER_FEES -
- SELL_TO_COVER_TAXES -
- ACCOUNT_LIQUIDATION -
- UPVEST_OPERATIONS -
- SAVINGS_PLAN -
Enum"API""PORTFOLIO""CASH_DIVIDEND_REINVESTMENT""PORTFOLIO_REBALANCING""SELL_TO_COVER_FEES""SELL_TO_COVER_TAXES""ACCOUNT_LIQUIDATION""UPVEST_OPERATIONS""SAVINGS_PLAN"
Order executions associated with this order
Execution status of the Execution.
- FILLED -
- SETTLED -
- CANCELLED -
Enum"FILLED""SETTLED""CANCELLED"
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- GBP - British Pound
Enum"EUR""GBP"
Immutable reference to the API flow that initiated the order. For client initiated API flows, this is a client provided ID. For internal initiations, it is set to the ID of the related object.
Only applicable if the user has failed the instrument fit check for the instrument type being ordered. True if the user has acknowledged their willingness to trade.
Reason for Order cancellation. The field is present in case the Order has a status of CANCELLED.
- CANCELLED_BY_CLIENT -
- CANCELLED_BY_UPVEST_OPERATIONS -
- CANCELLED_BY_TRADING_PARTNER -
- CANCELLED_BY_UPVEST_PLATFORM -
Enum"CANCELLED_BY_CLIENT""CANCELLED_BY_UPVEST_OPERATIONS""CANCELLED_BY_TRADING_PARTNER""CANCELLED_BY_UPVEST_PLATFORM"
Execution flow that the order processing goes through. If no value is specified, the default value is assumed - STRAIGHT_THROUGH.
- STRAIGHT_THROUGH -
- BLOCK -
Enum"STRAIGHT_THROUGH""BLOCK"
Response
application/json
{ "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c", "created_at": "2021-07-21T14:10:00.00Z", "updated_at": "2021-07-21T14:10:00.00Z", "user_id": "2dedfeb0-58cd-44f2-ae08-0e41fe0413d9", "account_id": "debf2026-f2da-4ff0-bb84-92e45babb1e3", "cash_amount": "56.65", "currency": "EUR", "side": "BUY", "instrument_id": "US0378331005", "instrument_id_type": "ISIN", "order_type": "MARKET", "quantity": "0.05", "user_instrument_fit_acknowledgement": true, "limit_price": "", "stop_price": "", "status": "NEW", "fee": "0.5", "executions": [], "client_reference": "", "initiation_flow": "API", "execution_flow": "STRAIGHT_THROUGH" }
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/orders/{order_id}
- Live environment
https://api.upvest.co/orders/{order_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X DELETE \
'https://sandbox.upvest.co/orders/{order_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'Response
application/json
{ "id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c" }
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/orders/{order_id}/executions/{execution_id}
- Live environment
https://api.upvest.co/orders/{order_id}/executions/{execution_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://sandbox.upvest.co/orders/{order_id}/executions/{execution_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
Execution status of the Execution.
- FILLED -
- SETTLED -
- CANCELLED -
Enum"FILLED""SETTLED""CANCELLED"
Alphabetic three-letter ISO 4217 currency code.
- EUR - Euro
- GBP - British Pound
Enum"EUR""GBP"
Response
application/json
{ "id": "b9dc0676-8a7d-412d-802a-3b325eefd15e", "side": "BUY", "currency": "EUR", "status": "SETTLED", "order_id": "eb5ba93f-5dfe-4bf1-8571-4da0caacc80c", "cash_amount": "56.65", "share_quantity": "0.05", "price": "130.65", "transaction_time": "2021-07-21T14:10:00.00Z", "taxes": [ { … } ], "settlement_date": "2021-07-23", "venue_id": "20d6024b-2df4-41ae-8d42-62e4744e455b" }