EXT Upvest Investment API BYOL Omnibus

Getting Started-Retrieve User

OPT/DIAG Retrieve a user

Getting Started-Retrieve Account

OPT/DIAG List user account groups OPT/DIAG List user accounts

Getting Started-Retrieve Instruments

List instruments Retrieve an instrument Get instrument latest price

Getting Started-Place Order

Place a buy order (nominal buy)OPT/DIAG List account orders

Getting Started-Check Position

List positions Get Current Account Valuation

Advanced-Instruments

List instruments Retrieve an instrument Get instrument OHLC prices Get instrument latest price

Advanced-Orders

List account orders Retrieve an order Retrieve an order execution Cancel an order

Advanced-Positions

List positions Retrieve position Retrieve a cash balance Get Current Account Valuation List Account Valuations

Advanced-Transactions

List Cash Transactions List Securities Transactions

Advanced-Webhooks

Create un-enabled webhook subscription Update a webhook subscription List all webhooks Retrieve a webhook subscription Test a webhook Get signing keys Delete a webhook subscription

Advanced-Simulations

Trigger a bank transaction

EXT Upvest Investment API BYOL Single account

Getting Started-Onboard User

Create a user OPT/DIAG Retrieve a user

Getting Started-Create Account

Create account group OPT/DIAG List user account groups Create PORTFOLIO account OPT/DIAG List user accounts

Getting Started-Fund with Cash

Create a mandate OPT/DIAG List mandates Trigger a top-up OPT/DIAG List top-ups Retrieve cash balance

Getting Started-Retrieve Instruments

List instruments Retrieve an instrument Get instrument latest price

Getting Started-Place Order-TRADING account type

Create user report (order ex-ante cost)Place a buy order (nominal buy)OPT/DIAG List account orders

Getting Started-Place Order-PORTFOLIO account type

Create allocation Create configuration Create order Retrieve order

Getting Started-Check Position

List positions Get Current Account Valuation

Getting Started-Retrieve Report

List user reports Retrieve a user report (PDF)

Advanced-Users-User Data Change

Update without proof

Advanced-Users-Creation and update of Identifiers

Create an Identifier for a user Retrieve Identifiers Retrieve an Identifier Update an Identifier

Advanced-Users-User creation and off-boarding

Create a user (hit PEP/Sanctions)List users Retrieve a user Offboard a user

Advanced-Accounts-Account groups data fetching

List user account groups Retrieve an account group List account groups

Advanced-Accounts-Accounts creation, update and liquidation

Create account List user accounts Retrieve an account Update an account Account closure List accounts

Advanced-Portfolios

Create allocation Retrieve allocation List allocations List configurations Retrieve configuration Update portfolio configuration Create order Retrieve order List orders Trigger rebalancing on account(s)Retrieve rebalancing execution Retrieve rebalancing execution orders

Advanced-Instruments

List instruments Retrieve an instrument Get instrument OHLC prices Get instrument latest price

Advanced-Orders

List account orders Retrieve an order Retrieve an order execution Cancel an order

Advanced-Savings plan

Create Instrument based savings plan Get savings plan List savings plans List executions Get execution Delete execution Delete savings plan

Advanced-Positions

List positions Retrieve position Retrieve a cash balance Get Current Account Valuation List Account Valuations

Advanced-Reports

List user reports (BUY orders only)Retrieve a user report (PDF)Create user report (order ex-ante cost)

Advanced-Payments-Reference Accounts

Create reference account List reference accounts Retrieve reference account Delete reference account

Advanced-Payments

Trigger withdrawal payment List withdrawal payments Retrieve withdrawal payment

Advanced-Returns

Advanced-Transactions

List Cash Transactions List Securities Transactions

Advanced-Account liquidation

Liquidate an account Retrieve a account liquidation Account group closure Account closure Offboard a user

Advanced-Webhooks

Create un-enabled webhook subscription Update a webhook subscription List all webhooks Retrieve a webhook subscription Test a webhook Get signing keys Delete a webhook subscription

Advanced-Simulations

Trigger a bank transaction

EXT Upvest Investment API TOL

Getting Started-Onboard User

Create a user Create INTRUMENT_FIT check OPT/DIAG List all checks for a user OPT/DIAG Retrieve a user

Getting Started-Create Account

Create account group OPT/DIAG List user account groups Create PORTFOLIO account OPT/DIAG List user accounts

Getting Started-Fund with Cash

Create a mandate OPT/DIAG List mandates Trigger funding payment OPT/DIAG List direct debit funding Retrieve cash balance

Getting Started-Retrieve Instruments

List instruments Retrieve an instrument Get instrument latest price

Getting Started-Place Order-TRADING account type

Create user report (order ex-ante cost)Place a buy order (nominal buy)OPT/DIAG List account orders

Getting Started-Place Order-PORTFOLIO account type

Create allocation Create configuration Create order Retrieve order

Getting Started-Check Position

List positions Get Current Account Valuation

Getting Started-Retrieve Report

List user reports Retrieve a user report (PDF)

Advanced-Users-All User checks

Create INTRUMENT_FIT check List all checks for a user Retrieve a check for a user

Advanced-Users-User Data Change

Advanced-Users-Creation and update of Identifiers

Create an Identifier for a user Retrieve Identifiers Retrieve an Identifier Update an Identifier

Advanced-Users-Creating and updating Tax residencies

Update a tax residency Retrieve a tax residency

Advanced-Users-User creation and off-boarding

Create a user (hit PEP/Sanctions)List users Retrieve a user Offboard a user

Advanced-Accounts-Account groups data fetching

List user account groups Retrieve an account group List account groups

Advanced-Accounts-Accounts creation, update and liquidation

Create account List user accounts Retrieve an account Update an account Account closure List accounts

Advanced-Portfolios

Create allocation Retrieve allocation List allocations List configurations Retrieve configuration Update portfolio configuration Create order Retrieve order List orders Trigger rebalancing on account(s)Retrieve rebalancing execution Retrieve rebalancing execution orders

Advanced-Instruments

List instruments Retrieve an instrument Get instrument OHLC prices Get instrument latest price

Advanced-Orders

List account orders Retrieve an order Retrieve an order execution Cancel an order

Advanced-Savings plan

Create Instrument based savings plan Get savings plan List savings plans List executions Get execution Delete execution Delete savings plan

Advanced-Positions

List positions Retrieve position Retrieve a cash balance Get Current Account Valuation List Account Valuations

Advanced-Reports

List user reports (BUY orders only)Retrieve a user report (PDF)Create user report (order ex-ante cost)

Advanced-Payments-Reference Accounts

Create reference account List reference accounts Retrieve reference account Delete reference account

Advanced-Payments-Mandates

Create a mandate List mandates Retrieve a direct debit mandate Delete mandate

Advanced-Payments

Trigger funding payment List direct debit funding Retrieve direct debit funding Trigger withdrawal payment List withdrawal payments Retrieve withdrawal payment

Advanced-Returns

Advanced-Transactions

List Cash Transactions List Securities Transactions

Advanced-Account liquidation

Liquidate an account Retrieve a account liquidation Account group closure Account closure Offboard a user

Advanced-Webhooks

Create un-enabled webhook subscription Update a webhook subscription List all webhooks Retrieve a webhook subscription Test a webhook Get signing keys Delete a webhook subscription

Advanced-Simulations

Trigger a bank transaction

EXT Upvest Investment API BYOL Omnibus

Getting Started-Retrieve User

OPT/DIAG Retrieve a user

Getting Started-Retrieve Account

OPT/DIAG List user account groups OPT/DIAG List user accounts

Getting Started-Retrieve Instruments

List instruments Retrieve an instrument Get instrument latest price

Getting Started-Place Order

Place a buy order (nominal buy)OPT/DIAG List account orders

Getting Started-Check Position

List positions Get Current Account Valuation

Advanced-Instruments

List instruments Retrieve an instrument Get instrument OHLC prices Get instrument latest price

Advanced-Orders

List account orders Retrieve an order Retrieve an order execution Cancel an order

Advanced-Positions

List positions Retrieve position Retrieve a cash balance Get Current Account Valuation List Account Valuations

Advanced-Transactions

List Cash Transactions List Securities Transactions

Advanced-Webhooks

Create un-enabled webhook subscription Update a webhook subscription List all webhooks Retrieve a webhook subscription Test a webhook Get signing keys Delete a webhook subscription

Advanced-Simulations

Trigger a bank transaction

EXT Upvest Investment API BYOL Single account

Getting Started-Onboard User

Create a user OPT/DIAG Retrieve a user

Getting Started-Create Account

Create account group OPT/DIAG List user account groups Create PORTFOLIO account OPT/DIAG List user accounts

Getting Started-Fund with Cash

Create a mandate OPT/DIAG List mandates Trigger a top-up OPT/DIAG List top-ups Retrieve cash balance

Getting Started-Retrieve Instruments

List instruments Retrieve an instrument Get instrument latest price

Getting Started-Place Order-TRADING account type

Create user report (order ex-ante cost)Place a buy order (nominal buy)OPT/DIAG List account orders

Getting Started-Place Order-PORTFOLIO account type

Create allocation Create configuration Create order Retrieve order

Getting Started-Check Position

List positions Get Current Account Valuation

Getting Started-Retrieve Report

List user reports Retrieve a user report (PDF)

Advanced-Users-User Data Change

Update without proof

Advanced-Users-Creation and update of Identifiers

Create an Identifier for a user Retrieve Identifiers Retrieve an Identifier Update an Identifier

Advanced-Users-User creation and off-boarding

Create a user (hit PEP/Sanctions)List users Retrieve a user Offboard a user

Advanced-Accounts-Account groups data fetching

List user account groups Retrieve an account group List account groups

Advanced-Accounts-Accounts creation, update and liquidation

Create account List user accounts Retrieve an account Update an account Account closure List accounts

Advanced-Portfolios

Create allocation Retrieve allocation List allocations List configurations Retrieve configuration Update portfolio configuration Create order Retrieve order List orders Trigger rebalancing on account(s)Retrieve rebalancing execution Retrieve rebalancing execution orders

Advanced-Instruments

List instruments Retrieve an instrument Get instrument OHLC prices Get instrument latest price

Advanced-Orders

List account orders Retrieve an order Retrieve an order execution Cancel an order

Advanced-Savings plan

Create Instrument based savings plan Get savings plan List savings plans List executions Get execution Delete execution Delete savings plan

Advanced-Positions

List positions Retrieve position Retrieve a cash balance Get Current Account Valuation List Account Valuations

Advanced-Reports

List user reports (BUY orders only)Retrieve a user report (PDF)Create user report (order ex-ante cost)

Advanced-Payments-Reference Accounts

Create reference account List reference accounts Retrieve reference account Delete reference account

Advanced-Payments

Trigger withdrawal payment List withdrawal payments Retrieve withdrawal payment

Advanced-Returns

Advanced-Transactions

List Cash Transactions List Securities Transactions

Advanced-Account liquidation

Liquidate an account Retrieve a account liquidation Account group closure Account closure Offboard a user

Advanced-Webhooks

Create un-enabled webhook subscription Update a webhook subscription List all webhooks Retrieve a webhook subscription Test a webhook Get signing keys Delete a webhook subscription

Advanced-Simulations

Trigger a bank transaction

EXT Upvest Investment API TOL

Getting Started-Onboard User

Create a user Create INTRUMENT_FIT check OPT/DIAG List all checks for a user OPT/DIAG Retrieve a user

Getting Started-Create Account

Create account group OPT/DIAG List user account groups Create PORTFOLIO account OPT/DIAG List user accounts

Getting Started-Fund with Cash

Create a mandate OPT/DIAG List mandates Trigger funding payment OPT/DIAG List direct debit funding Retrieve cash balance

Getting Started-Retrieve Instruments

List instruments Retrieve an instrument Get instrument latest price

Getting Started-Place Order-TRADING account type

Create user report (order ex-ante cost)Place a buy order (nominal buy)OPT/DIAG List account orders

Getting Started-Place Order-PORTFOLIO account type

Create allocation Create configuration Create order Retrieve order

Getting Started-Check Position

List positions Get Current Account Valuation

Getting Started-Retrieve Report

List user reports Retrieve a user report (PDF)

Advanced-Users-All User checks

Create INTRUMENT_FIT check List all checks for a user Retrieve a check for a user

Advanced-Users-User Data Change

Advanced-Users-Creation and update of Identifiers

Create an Identifier for a user Retrieve Identifiers Retrieve an Identifier Update an Identifier

Advanced-Users-Creating and updating Tax residencies

Update a tax residency Retrieve a tax residency

Advanced-Users-User creation and off-boarding

Create a user (hit PEP/Sanctions)List users Retrieve a user Offboard a user

Advanced-Accounts-Account groups data fetching

List user account groups Retrieve an account group List account groups

Advanced-Accounts-Accounts creation, update and liquidation

Create account List user accounts Retrieve an account Update an account Account closure List accounts

Advanced-Portfolios

Create allocation Retrieve allocation List allocations List configurations Retrieve configuration Update portfolio configuration Create order Retrieve order List orders Trigger rebalancing on account(s)Retrieve rebalancing execution Retrieve rebalancing execution orders

Advanced-Instruments

List instruments Retrieve an instrument Get instrument OHLC prices Get instrument latest price

Advanced-Orders

List account orders Retrieve an order Retrieve an order execution Cancel an order

Advanced-Savings plan

Create Instrument based savings plan Get savings plan List savings plans List executions Get execution Delete execution Delete savings plan

Advanced-Positions

List positions Retrieve position Retrieve a cash balance Get Current Account Valuation List Account Valuations

Advanced-Reports

List user reports (BUY orders only)Retrieve a user report (PDF)Create user report (order ex-ante cost)

Advanced-Payments-Reference Accounts

Create reference account List reference accounts Retrieve reference account Delete reference account

Advanced-Payments-Mandates

Create a mandate List mandates Retrieve a direct debit mandate Delete mandate

Advanced-Payments

Trigger funding payment List direct debit funding Retrieve direct debit funding Trigger withdrawal payment List withdrawal payments Retrieve withdrawal payment

Advanced-Returns

Advanced-Transactions

List Cash Transactions List Securities Transactions

Advanced-Account liquidation

Liquidate an account Retrieve a account liquidation Account group closure Account closure Offboard a user

Advanced-Webhooks

Create un-enabled webhook subscription Update a webhook subscription List all webhooks Retrieve a webhook subscription Test a webhook Get signing keys Delete a webhook subscription

Advanced-Simulations

Trigger a bank transaction

Home EXT Upvest Investment API BYOL Single accountAdvanced-Returns

Advanced-Returns

Number of APIs: 1

List Returns GET {{proxiedPublicURL}}/accounts/{{latestAccountID}}/returns

Retrieve withdrawal payment