Transactions

This endpoint allows to retrieve transaction data for a particular date range.

A caller may specify an explicit date range for transaction data.

It returns a list of transactions for a given account and a particular date range. By default it returns transactions for a past month including the current date.

Transactions Headers
Authorization requiredThe access token.
Transactions Parameters
account_id string, requiredID of the account.
date_from queryDate from (YYYY-MM-DD) for which transactions should be retrieved (defaults to current date minus a month). Example: 2022-03-31
date_to queryDate to (YYYY-MM-DD) for which transactions should be retrieved (defaults to the current date). Example: 2022-01-01
page integerDesired page number, default is 0.
page_size integerDesired number of entries per page, defaults is 100, max value is 500.
Transactions Response Object Fields
id string, requiredThe ID of the transaction.
cusipstring, requiredCUSIP identifier
symbolstring, requiredSymbol
security_type stringSecurity Type.
Possible values
ETF
FI
OPTION
TBILL
INDEX
EQ
WARRANT
CASH
MBS
MUTUAL
CD
EQUITY
UNIT
OTHER
quantitynumber, requiredThe total quantity of the security in the transaction.
price number, requiredThe price of the security.
amountnumber, requiredThe transaction amount.
interest number, requiredThe transaction interest.
currency_codestring, requiredThe international 3-digit currency code (upon ISO 4217). For example, USD.
transaction_typestring, requiredType of the transaction. For example, BUY.
transaction_subtypestringDetailed transaction subtype.
transaction_description string, requiredDescription of the transaction.
cancellation_reversal_flag string, requiredCancellation/reversal flag.
transaction_fees number, requiredThe transactions fees.
broker_fees number, requiredThe broker fees.
other_fees numberOther fees.
TEFRA_withheld numberTax Equity and Fiscal Responsibility Act withholding (a specific type of tax withholding). It refers to the withholding of tax on certain investment income.
state_tax_withheld numberState tax withholding.
as_of_datestring, requiredDate of the record.
transaction_date string, requiredThe transaction date.
settle_date string, requiredThe settlement date.

Transaction Type Possible Values
Detailed Transaction TypeTransaction TypeDescriptionPosition EffectCash Effect
BTCbuyBuy to CloseIncreaseDecrease
BTObuyBuy to OpenIncreaseDecrease
BUYbuyBuyIncreaseDecrease
COVERbuyCovering a ShortIncreaseDecrease
DEPdepositCash DepositIncrease
DIVIdividendDividend IncomingIncrease
DIVOdividendDividend OutgoingDecrease
EXPIpositionOption Expiration - ShortIncrease
EXPOpositionOption Expiration - LongDecrease
FEEIfeesFee IncomingIncrease
FEEOfeesFee OutgoingDecrease
IGNOREn/aIgnored Transaction (not presented to UI)
INTIinterestInterest IncomingIncrease
INTOinterestInterest OutgoingDecrease
JOURIjournalJournal IncomingIncrease
JOUROjournalJournal OutgoingDecrease
OTHWITHHOwithholdOTHER WITHHOLDING OUT (NO PERF IMPACT)Decrease
OTHWITHHIwithholdOTHER WITHHOLDING IN (NO PERF IMPACT)Increase
POSIpositionPosition IncomingIncrease
POSOpositionPosition OutgoingDecrease
PRINIprincipalPrincipal IncomingIncrease
PRINOprincipalPrincipal OutgoingDecrease
REDIVIdividend_reinvestmentReinvested Dividend InIncrease
REDIVOdividend_reinvestmentReinvested Dividend OutDecrease
SELLsaleSellDecreaseIncrease
SHORTsaleShortDecrease
SPLITIsplitSplit IncomingIncrease
SPLITOsplitSplit OutgoingDecrease
STCsaleSell to CloseDecreaseIncrease
STOsaleSell to OpenDecreaseIncrease
UNKNOWNUnknownUnknown Transaction Type
WITHDwithdrawalCash WithdrawalDecrease
WITHHIwithholdWithholding IncomingIncrease
WITHHOwithholdWithholding OutgoingDecrease
XBUYtrade_canceled_buyCancel BuyDecreaseIncrease
XFERItransferSecurities Transfer IncomingIncrease
XFEROtransferSecurities Transfer OutgoingDecrease
XFERMItransferMoney Transfer Incoming (specific to intra-account money movement activity)
XFERMOtransferMoney Transfer Outgoing (specific to intra-account money movement activity)
XSELLtrade_canceled_sellCancel SellIncreaseDecrease

What’s Next
Did this page help you?