Skip to content

Trading:Transactions

Announces the recent Transactions (completed Trades) for a Trading Account

Controller: Trading
Topic: Transactions or Transactions![ID]
Action: Sub
Permissions: Zenith/Trading
Server-side Unsubscribe: Yes

FormatDescriptionExample
TransactionsReceive all data available on this login.Transactions
Transactions![ID]Receive data for a specific Trading Account.Transactions!OM1234
NameDescription
IDThe Trading Account identifier to announce Transactions for.

An ordered array of zero or more Transaction Change objects, to be applied in sequence.

NameTypeExpectDescription
OStringAlwaysThe operation being performed. One of:
A: Adding a new Transaction.
U: Updating an existing Transaction.
I: Initialise the transaction list.
AccountStringOptionalThe target account. Will be provided when initialising.
TransactionObjectOptionalThe Transaction Details object. Will be omitted when initialising. Will always be provided in all other situations.
NameTypeExpectDescription
IDStringAlwaysThe unique transaction identifier assigned by the system.
ExchangeStringAlwaysThe Exchange the target Symbol is issued by.
CodeStringAlwaysThe code of the target Symbol.
TradingMarketStringAlwaysThe market the target Symbol was traded on.
AccountStringAlwaysThe account the Transaction belongs to
StyleStringAlwaysThe style of Transaction, which should correspond to the Class for the associated Symbol. One of the following values:
Market
ManagedFund
TradeDateDateTimeAlwaysThe date the transaction occurred.
SettlementDateDateTimeAlwaysThe date the trade settles/settled.
GrossAmountDecimalAlwaysThe gross amount of the trade.
NetAmountDecimalAlwaysThe net amount of the trade (not including brokerage, fees, etc)
SettlementAmountDecimalAlwaysThe settlement amount.
CurrencyStringOptionalThe currency code the trade was executed in, if available.
OrderIDStringAlwaysThe Order ID that generated this trade. Will correspond to a value in Orders.

Extra fields depend on the Style of Transaction.

When Style is Market, the Transaction Details can have these additional fields:

NameTypeExpectDescription
TotalQuantityDecimalAlwaysThe total shares traded.
AveragePriceDecimalAlwaysThe average price as calculated for this trade.

When Style is ManagedFund, the Transaction Details can have these additional fields:

NameTypeExpectDescription
TotalUnitsDecimalAlwaysThe total number of units traded.
UnitValueDecimalAlwaysThe average value of each unit traded.

Send:

{"Controller":"Trading","Topic":"Transactions!OM12345","Action":"Sub","Confirm":true}

Receive:

{"Controller":"Trading","Topic":"Transactions!OM12345","Data":[{"O":"I","Account":"OM12345[Demo]"}]}
{"Controller":"Trading","Topic":"Transactions!OM12345","Action":"Sub","Confirm":true}