Open API

The portfolio service group provides access to information about the user, client, their accounts, balances as well as open positions and orders.

Overview

The portfolio endpoints are grouped into several service groups, divided as follows:

GroupUse for...Supports Subscriptions
Accounts

Account details for one or more accounts as well as endpoints to change selected settings. This includes:

  • Get details for an account.
  • Get a list of accounts for a client or for underlying clients.
  • Subscribe to account changes.
  • Update account information - set a user defined account name.
  • Reset Trial Account. (Simulation only)
X
Balances

Current cash, profit/loss, credit line and margin balances on an client, account or group of accounts.

  • Get a real-time snapshot for a given entity.
  • Subscribe to balance changes in real-time.
  • Get detailed margin exposure breakdown per netposition.
X
Clients

Client details and settings for one or more clients as well as endpoints to change selected settings. 

  • Get details, including netting mode, for a client.
  • Get a list of clients for a specified owner.
  • Update client settings - change a client's trade netting mode.
 
Closed Positions

Position execution details on positions that have been netted on the day of trade. (Real-time netting clients only).

    • Get advanced details of a specific closed position.
    • Get a current snapshot of all intraday closed positions.
    • Subscribe to new closed positions.

(info) Intraday closed positions are removed daily post settlement. This list represents trades closed after the last EOD processing.

X
ExposuresAggregate currency and market exposure details based on instrument, currency, etc. across accounts. X
NetPositions

Aggregated/summarized position details by instrument on a given client, account or group of accounts.

  • Get advanced details of a specific netposition.
  • Get a current snapshot of all netpositions.
  • Subscribe to streaming updates of net position current price and profit/loss.

(info) Click here for details on the definition of a netposition

X
Orders

Open order details on a specific or all open active orders on a given client, account or group of accounts.

  • Get advanced details of a specific order.
  • Get a current snapshot of all active open orders.
  • Subscribe to new closed positions.
X
Positions

Posltion details on all active non-settled open positions on a given client, account or group of accounts. 

  • Get advanced details of a specific open position, including details such as Greeks on opitions.
  • Get a current snapshot of all open positions.
  • Subscribe to streaming updates of position current price and profit/loss.
X
Users

 User details for one or more users on a given client, as well as endpoints to change selected user preferences. 

  • Get details for a specific user.
  • Get a list of users under a specified owner.
  • Update user preferences - change a users preferred language, timezone and regional settings.
 
Profit/Loss values reflect user exchange data subscriptions. 

Subscription Refresh Rate

This is generally covered in OpenAPI Streaming. However, specific for Portfolio services keep the following in mind:

  • Some subscription services, such as Accounts, may have longer minimum refresh rates since updates are relatively infrequent.
  • Your refresh rate is often rounded up to the nearest refresh rate interval, so to allow efficient handling of updates.
  • Regardless of your refresh rate opening/closing orders and positions will be published immediately. Thus refresh rate in most instance regulates the speed of price and profit/loss updates.

The subscriptions are goverened by the following restrictions:

  • If the list includes less than 200 records, then you will receive updates at the refresh rate requested (rounded down to nearest standard refresh rate).
  • If the list includes more than 200 records, you will receive updates at the refresh rate requested (rounded down to the nearst standard refresh rate), but no less than 10 s.
  • If the list includes more than 2000 records, your subscription request will be rejected, and you can only access the data via the request/response interfaces.