API 1 • API 2 • API 3 • API 4 • API 5 • Live Server • Flows • Flows 2 • Assets • Data

API Overview

Access Tokens

  • POST /api/auth/token: Obtain access tokens for API usage.

Users

  • GET /api/users: Get all users.
  • POST /api/users: Create a user.
  • GET /api/users/:id: Get a user by ID.
  • DELETE /api/users/:id: Offboard a user.
  • POST /api/users/:id: Change user data.
  • EVENT /api/users/events: Users events.

User Identifiers

  • GET /api/users/:id/identifiers: Get user identifiers.
  • POST /api/users/:id/identifiers: Create a user identifier.
  • GET /api/users/:id/identifiers/:identifierId: Get a user identifier by ID.
  • PATCH /api/users/:id/identifiers/:identifierId: Update a user identifier by ID.

User Checks

  • GET /api/users/:id/checks: Get checks for a user.
  • POST /api/users/:id/checks: Create a new check for a user.
  • GET /api/users/:id/checks/:checkId: Get a user check by ID.
  • EVENT /api/users/:id/checks/events: User checks events.

Accounts

  • GET /api/users/:id/accounts: Get user accounts.
  • GET /api/accounts/:id: Get account by ID.
  • DELETE /api/accounts/:id: Close account by ID.
  • PATCH /api/accounts/:id: Update account by ID.
  • GET /api/accounts: Get accounts.
  • POST /api/accounts: Create an account.
  • EVENT /api/accounts/events: Account events.

Account Groups

  • GET /api/users/:id/account-groups: Get user account groups.
  • GET /api/account-groups/:id: Get an account group by ID.
  • DELETE /api/account-groups/:id: Close an account group by ID.
  • GET /api/account-groups: Get account groups.
  • POST /api/account-groups: Create an account group.
  • EVENT /api/account-groups/events: Account group events.

Taxes

  • GET /api/users/:id/taxes: Retrieve tax residencies.
  • POST /api/users/:id/taxes: Update tax residencies.

Instruments

  • GET /api/instruments: List instruments.
  • GET /api/instruments/:id: Get instrument.
  • EVENT /api/instruments/events: Instruments events.

Price Data

  • GET /api/instruments/:id/venues: Get instrument venues.
  • GET /api/instruments/:id/price: Get instrument latest price.
  • GET /api/instruments/:id/ohlc: Get instrument OHLC prices.
  • GET /api/accounts/:id/orders: Get orders for an account by ID.
  • POST /api/orders: Place an order.
  • GET /api/orders/:id: Get an order by ID.
  • DELETE /api/orders/:id: Cancel an order by ID.
  • GET /api/orders/:id/executions: Get an order execution by ID.
  • EVENT /api/orders/events: Orders events.
  • EVENT /api/orders/executions/events: Executions events.
  • EVENT /api/orders/cancellations/events: Order Cancellations events.

Portfolios

  • GET /api/portfolios/allocations: List portfolios allocations.
  • POST /api/portfolios/allocations: Create portfolios allocation.
  • GET /api/portfolios/allocations/:id: Retrieve portfolios allocation.
  • PUT /api/portfolios/allocations/:id: Update portfolios allocation.
  • GET /api/portfolios/configurations: List portfolios configurations.
  • POST /api/portfolios/configurations: Create portfolios configuration.
  • GET /api/portfolios/configurations/:id: Retrieve portfolios configuration.
  • PATCH /api/portfolios/configurations/:id: Update portfolios configuration.
  • GET /api/portfolios/orders: List portfolios orders.
  • POST /api/portfolios/orders: Create portfolios order.
  • GET /api/portfolios/orders/:id: Retrieve portfolios order.
  • DELETE /api/portfolios/orders/:id: Cancel portfolios order.
  • GET /api/portfolios/allocation-accounts: List portfolios allocation accounts.
  • EVENT /api/portfolios/orders/events: Portfolios orders events.
  • EVENT /api/portfolios/rebalancing/events: Portfolio rebalancing execution orders events.
  • EVENT /api/portfolios/allocations/events: Portfolios allocations events.

Portfolios Rebalancing

  • POST /api/portfolios/rebalancing: Trigger portfolio rebalancing.
  • GET /api/portfolios/rebalancing/:id: Retrieve portfolios rebalancing execution.
  • GET /api/portfolios/rebalancing/:id/orders: List portfolio rebalancing execution orders.

Savings Plans

  • GET /api/savings-plans: List savings plans.
  • POST /api/savings-plans: Create savings plan.
  • GET /api/savings-plans/:id: Retrieve a savings plan.
  • DELETE /api/savings-plans/:id: Delete a savings plan.
  • GET /api/savings-plans/executions: List savings plan executions.
  • GET /api/savings-plans/executions/:id: Retrieve savings plan execution.
  • DELETE /api/savings-plans/executions/:id: Delete savings plan execution.
  • EVENT /api/savings-plans/events: Savings plan events.
  • EVENT /api/savings-plans/executions/events: Savings plan execution events.

Liquidations

  • GET /api/liquidations: List accounts liquidations.
  • POST /api/liquidations: Create account liquidation request.
  • GET /api/liquidations/:id: Retrieve account liquidation.
  • DELETE /api/liquidations/:id: Cancel account liquidation.
  • EVENT /api/liquidations/events: Account liquidation events.

Payments

  • GET /api/payments/direct-debits: List direct debits.
  • POST /api/payments/direct-debits: Trigger a direct debit.
  • GET /api/payments/direct-debits/:id: Retrieve a direct debit.
  • GET /api/payments/top-ups: List top-ups.
  • POST /api/payments/top-ups: Create a top-up.
  • GET /api/payments/top-ups/:id: Get a top-up by ID.
  • DELETE /api/payments/top-ups/:id: Cancel a top-up by ID.
  • POST /api/payments/withdrawals: Trigger a withdrawal.
  • GET /api/payments/withdrawals/:id: Retrieve withdrawal.
  • DELETE /api/payments/withdrawals/:id: Cancel withdrawal by ID.
  • GET /api/payments/withdrawals: List withdrawals.
  • EVENT /api/payments/direct-debits/events: Direct Debit events.
  • EVENT /api/payments/top-ups/events: Top-up events.
  • EVENT /api/payments/withdrawals/events: Withdrawals events.

Reference Accounts

  • GET /api/reference-accounts: Get reference accounts of a user.
  • POST /api/reference-accounts: Create a reference account.
  • GET /api/reference-accounts/:id: Get a reference account by ID.
  • DELETE /api/reference-accounts/:id: Delete a reference account by ID.

Mandates

  • GET /api/mandates: List mandates.
  • POST /api/mandates: Create a mandate.
  • GET /api/mandates/:id: Retrieve a direct debit mandate.
  • DELETE /api/mandates/:id: Delete mandate.

Cash Balances

  • GET /api/account-groups/:id/cash-balances: Retrieve an account group's cash balance.
  • EVENT /api/cash-balances/events: Cash Balance events.

Positions

  • GET /api/positions: List positions.
  • GET /api/positions/:id: Retrieve position.
  • EVENT /api/positions/events: Positions events.

Valuations

  • GET /api/accounts/:id/valuations: Get current valuation for an account.
  • GET /api/accounts/:id/valuations/history: List valuation history for an account.
  • EVENT /api/valuations/events: Account valuation events.
  • EVENT /api/valuations/intraday-events: Intraday account valuation events.

Returns

  • GET /api/accounts/:id/returns: List account returns.
  • EVENT /api/returns/events: Account returns event.

Virtual Cash Balances

  • POST /api/virtual-cash/increase: Trigger a virtual cash increase.
  • POST /api/virtual-cash/decrease: Trigger a virtual cash decrease.
  • DELETE /api/virtual-cash/decrease/:id: Cancel virtual cash decrease by ID.
  • EVENT /api/virtual-cash/increase/events: Virtual cash increase events.
  • EVENT /api/virtual-cash/decrease/events: Virtual cash decrease events.

Fees

  • GET /api/fees/collections: Get fee collections.
  • POST /api/fees/collections: Create a fee collection.
  • GET /api/fees/collections/:id: Get a fee collection by ID.
  • EVENT /api/fees/collections/events: Fee collection events.

Fees Configurations

  • POST /api/fees/configurations: Create a fee configuration.
  • GET /api/fees/configurations/:id: Get fee configuration.
  • PATCH /api/fees/configurations/:id: Update fee configuration.

Reports

  • GET /api/reports: List user reports.
  • POST /api/reports: Create a user report.
  • GET /api/reports/:id: Retrieve a user report.
  • EVENT /api/reports/events: User reports events.

Treasury Reports

  • EVENT /api/treasury-reports/events: Treasury reports events.

Transactions

  • GET /api/transactions/cash: List cash transactions.
  • GET /api/transactions/securities: List securities transactions.
  • EVENT /api/transactions/cash/events: Cash transactions events.
  • EVENT /api/transactions/securities/events: Security transactions events.

Files

  • GET /api/files/:id/metadata: Retrieve a file metadata.

Webhooks

  • GET /api/webhooks/signing-keys: Get signing keys.
  • GET /api/webhooks: List all webhooks.
  • POST /api/webhooks: Create a webhook subscription.
  • GET /api/webhooks/:id: Retrieve a webhook subscription.
  • DELETE /api/webhooks/:id: Delete a webhook subscription.
  • PATCH /api/webhooks/:id: Update a webhook subscription.
  • POST /api/webhooks/test: Test a webhook.

Tests

  • POST /api/tests/bank-transaction: Trigger a bank transaction for testing.