Get API keys
Dark
Light
System
Home
News
Documentation
API Reference
API Status
Legal
Get API keys
Dark
Light
System
Home
News
Documentation
API Reference
API Status
Legal
Home
Home
Operating Models
TOL - Single Accounts
BYOL - Single Accounts
BYOL - Omnibus
News
News
Release Notes
Changelogs
Tutorials
Overview
Getting Started
Preparing Cryptographic Keys
Cloud Storage Buckets
Setup Messaage Signing
Implementing HTTP Signatures
Choosing HTTP Signature Versions
Signature Code Examples
Signatures v15
Signatures v6
Upgrading v6 to v15
Implementing Webhooks
Guides
Overview
Users
User Onboarding
User Identifiers
User Tax Onboarding
User Data Change
User Offboarding
Accounts
Accounts
Account Closure
Orders
Introduction
Placing an Order
Block Orders
Cancelling an Order
Handling Order Errors
Sandbox Mock ISINs
Positions
Positions
Account Valuations
Treasury
Settlement Reports
Retrieving Settlement Reports
Treasury Report Samples
Payments
Mandate Setup
Direct Debit
Cash Balances
Reference Bank Accounts
Cash Balance Withdrawal
Virtual Cash
Introduction
Use Cases
Implementing Virtual Cash
Portfolios
Introduction
Enabling Portfolio Investments
Understanding Portfolio Orders
Triggering a Rebalancing
Portfolio Sandbox Testing
Liquidations
Savings Plans
Introduction
Execution Flow
Implementing Savings Plans
Instruments
Introduction
Use Cases
Implementing Instruments
Fees
Fee Collections
Files
Retrieving data
Reporting
Overview
User Reports
User Reports Overview
User Report Types
Accessing User Reports
Account Reports
Transactions Reports
Accessing Transactions Reports
Time-weighted Returns
Regulatory Reports
Ex-ante Reports Overview
Data Submission
Accessing Ex-ante Reports
Concepts
Overview
API Concepts
Authentication
Errors
HTTP
Idempotency
Pagination, Sorting, and Meta Information
Permissions
Searching
Signature
v15
Overview
Content Digest
Signature Components
Calculating the Signature
v6
Overview
Content Digest
Signature Components
Calculating the Signature
Signing Algorithms
Base64 Encoding
Throttling and Quotas
Versioning
Webhooks
Secure communication
API Reference
Overview
Authentication
Access Tokens
Get an access token for requested scopes
post
Users & Accounts Management
Users
Get all users
get
Create a user
post
Get a user by ID
get
Offboard a user
del
Change user data
post
Users events
webhook
User Identifiers
Get user identifiers
get
Create a user identifier
post
Get a user identifier by ID
get
Update a user identifier by ID
patch
User Checks
Get checks for a user
get
Create a new check for a user
post
Get a user check by ID
get
User checks events
webhook
Accounts
Get user accounts
get
Get account by ID
get
Close account by ID
del
Update account by ID
patch
Get accounts
get
Create an account
post
Account events
webhook
Account Groups
Get user account groups
get
Get an account group by ID
get
Close an account group by ID
del
Get account groups
get
Create an account group
post
Account group events
webhook
Taxes
Retrieve tax residencies
get
Update tax residencies
post
Instruments & Price Data
Instruments
List instruments
get
Get instrument
get
Get instrument venues
get
Get instrument latest price
get
Get instrument OHLC prices
get
Instruments events
webhook
Orders
Orders
Get orders for an account by ID
get
Place an order
post
Get an order by ID
get
Cancel an order by ID
del
Get an order execution by ID
get
Orders events
webhook
Executions events
webhook
Order Cancellations events
webhook
Investments Solutions
Portfolios
List portfolios allocations
get
Create portfolios allocation
post
Retrieve portfolios allocation
get
Update portfolios allocation
put
List portfolios configurations
get
Create portfolios configuration
post
Retrieve portfolios configuration
get
Update portfolios configuration
patch
List portfolios orders
get
Create portfolios order
post
Retrieve portfolios order
get
Cancel portfolios order
del
List portfolios allocation accounts
get
Portfolios orders events
webhook
Portfolio rebalancing execution orders events
webhook
Portfolios allocations events
webhook
Portfolios Rebalancing
Trigger portfolio rebalancing
post
Retrieve portfolios rebalancing execution
get
List portfolio rebalancing execution orders
get
Savings Plans
Retrieve a savings plan
get
Delete a savings plan
del
List savings plans
get
Create savings plan
post
Retrieve savings plan execution
get
Delete savings plan execution
del
List savings plan executions
get
Savings plan execution events
webhook
Savings plan events
webhook
Liquidations
List accounts liquidations
get
Create account liquidation request
post
Retrieve account liquidation
get
Cancel account liquidation
del
Account liquidation events
webhook
Payments
Payments
List direct debits
get
Trigger a direct debit
post
Retrieve a direct debit
get
List top-ups
get
Create a top-up
post
Get a top-up by ID
get
Trigger a withdrawal
post
Retrieve withdrawal
get
Cancel withdrawal by ID
del
List withdrawals
get
Direct Debit events
webhook
Top-up events
webhook
Withdrawals events
webhook
Reference Accounts
Get reference accounts of a user
get
Create a reference account
post
Get a reference account by ID
get
Delete a reference account by ID
del
Mandates
List mandates
get
Create a mandate
post
Retrieve a direct debit mandate
get
Delete mandate
del
Balances
Cash Balances
Retrieve an account group's cash balance
get
Cash Balance events
webhook
Positions
List positions
get
Retrieve position
get
Positions events
webhook
Valuations
Get current valuation for an account
get
List valuation history for an account
get
Account valuation events
webhook
Intraday account valuation events
webhook
Returns
List account returns
get
Account returns event
webhook
Virtual Cash Balances
Trigger a virtual cash increase
post
Trigger a virtual cash decrease
post
Cancel virtual cash decrease by ID
del
Virtual cash increase events
webhook
Virtual cash decrease events
webhook
Fees
Fees
Get fee collections
get
Create a fee collection
post
Get a fee collection by ID
get
Fee collection events
webhook
Reporting
Reports
List user reports
get
Create a user report
post
Retrieve a user report
get
User reports events
webhook
Treasury Reports
Treasury reports events
webhook
Transactions
List cash transactions
get
List securities transactions
get
Cash transactions events
webhook
Security transactions events
webhook
Files
Retrieve a file metadata
get
Webhooks
Webhooks
Get signing keys
get
List all webhooks
get
Create a webhook subscription
post
Retrieve a webhook subscription
get
Delete a webhook subscription
del
Update a webhook subscription
patch
Test a webhook
post
Tests
Tests
Trigger a bank transaction
post
API Errors
Overview
Conflict
Forbidden
Internal
Invalid Request
Missing Client Id
Missing Idempotency Key
Not Found
Unauthorised
API Status
API Status Page
Legal
Imprint
Disclaimer
404
We can't find the page you're looking for.
Take me back home