GetAccountTransactions

GetAccountTransactions

Category: User Permissions: Trading, AccountReadOnly Call Type: Synchronous

Returns a list of transactions for a specific account on an Order Management System. The owner of the trading venue determines how long to retain order history before archiving. The caller must be associated with the account named in AccountId.

Note: In this call, “Depth” refers not to the depth of the order book, but to the count of trades to report.

Request

{
  "omsId" : 0,
  "accountId" : 0,
  "depth" : 0,
  "startIndex" : 0,
  "transactionId" : 0,
  "referenceId" : 0,
  "counterParty" : 0,
  "productId" : 0,
  "userId" : 0,
  "startTimestamp" : 0,
  "endTimestamp" : 0,
  "transactionTypes" : [],
  "transactionReferenceTypes" : []
}

Key	Value
OMSId	integer. The ID of the Order Management System from which the account’s transactions will be returned.
AccountId	integer. The ID of the account for which transactions will be returned. If not specified, the call returns transactions for the default account for the logged-in user.
Depth	integer. The number of transactions that will be returned, starting with the most recent transaction.
start Index	integer. The starting index for the transaction records to retrieve. This is useful for pagination, allowing you to retrieve subsequent batches of transactions.
transaction Id	integer. The specific transaction ID to retrieve details for. A value of 0 typically means that all transactions should be retrieved, not just a specific one.
reference Id	integer. The reference ID associated with the transactions to be retrieved. This can be used to filter transactions based on a specific reference.
counterParty	integer. The ID of the counterparty involved in the transactions to be retrieved.
product Id	integer. The ID of the product involved in the transactions to be retrieved.
user Id	integer. The ID of the user who owns the account for which transaction history is being retrieved.
start Timestamp	integer. The starting timestamp (in seconds since the epoch) for the period over which transactions should be retrieved.
end Timestamp	integer. The ending timestamp (in seconds since the epoch) for the period over which transactions should be retrieved.
transaction types	integer. A list of transaction types to filter by. This allows for retrieval of transactions that match specific types.
transaction reference types	integer. A list of transaction reference types to filter by. This allows for retrieval of transactions that match specific reference types.

Response

[
  {
    "transactionId":0,
    "omsId":0,
    "accountId":0,
    "cr":0.0,
    "dr":0.0,
    "counterparty":0,
    "transactionType":0,
    "referenceId":0,
    "referenceType":0,
    "productId":0,
    "balance":0.0,
    "timeStamp":0
    },
]

The response returns an array of transaction objects. Note capitalization changes from the request.

Key	Value
transactionId	Integer. The ID of the transaction.
omsId	Integer. The ID of the Order Management System under which the requested transactions took place.
accountId	Integer. The single account under which the transactions took place.
cr	real. Credit entry for the account on the order book. Funds entering an account.
dr	real. Debit entry for the account on the order book. Funds leaving an account.
counterparty	long integer. The corresponding party in a trade.
transactionType	integer. A number representing the type of transaction: 1 Fee 2 Trade 3 Other 4 Reverse 5 Hold 6 Rebate 7 MarginAcquisition 8 MarginRelinquish
referenceId	long integer. The ID of the action or event that triggered this transaction.
referenceType	integer. A number representing the type of action or event that triggered this transaction. One of: 1 Trade 2 Deposit 3 Withdraw 4 Transfer 5 OrderHold 6 WithdrawHold 7 DepositHold 8 MarginHold 9 ManualHold 10 ManualEntry 11 MarginAcquisition 12 MarginRelinquish 13 MarginQuoteHold
productId	integer. The ID of the product on this account’s side of the transaction. For example, in a dollars-for-BitCoin transaction, one side will have the product Dollar and the other side will have the product BitCoin. Use GetProduct to return information about a product based on its ID.
balance	real. The balance in the account after the transaction.
timeStamp	long integer. Time at which the transaction took place, in POSIX format.