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 required | The access token. |
Transactions Parameters
account_id string, required | ID of the account. |
date_from query | Date from (YYYY-MM-DD) for which transactions should be retrieved (defaults to current date minus a month). Example: 2022-03-31 |
date_to query | Date to (YYYY-MM-DD) for which transactions should be retrieved (defaults to the current date). Example: 2022-01-01 |
page integer | Desired page number, default is 0. |
page_size integer | Desired number of entries per page, defaults is 100, max value is 500. |
Transactions Response Object Fields
id string, required | The ID of the transaction. |
cusip string, required | CUSIP identifier |
symbol string, required | Symbol |
security_type string | Security Type. Possible valuesETF FI OPTION TBILL INDEX EQ WARRANT CASH MBS MUTUAL CD EQUITY UNIT OTHER |
quantity number, required | The total quantity of the security in the transaction. |
price number, required | The price of the security. |
amount number, required | The transaction amount. |
interest number, required | The transaction interest. |
currency_code string, required | The international 3-digit currency code (upon ISO 4217). For example, USD . |
transaction_type string, required | Type of the transaction. For example, BUY . |
transaction_subtype string | Detailed transaction subtype. |
transaction_description string, required | Description of the transaction. |
cancellation_reversal_flag string, required | Cancellation/reversal flag. |
transaction_fees number, required | The transactions fees. |
broker_fees number, required | The broker fees. |
other_fees number | Other fees. |
TEFRA_withheld number | Tax 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 number | State tax withholding. |
as_of_date string, required | Date of the record. |
transaction_date string, required | The transaction date. |
settle_date string, required | The settlement date. |
Transaction Type Possible Values
Detailed Transaction Type | Transaction Type | Description | Position Effect | Cash Effect |
---|---|---|---|---|
BTC | buy | Buy to Close | Increase | Decrease |
BTO | buy | Buy to Open | Increase | Decrease |
BUY | buy | Buy | Increase | Decrease |
COVER | buy | Covering a Short | Increase | Decrease |
DEP | deposit | Cash Deposit | Increase | |
DIVI | dividend | Dividend Incoming | Increase | |
DIVO | dividend | Dividend Outgoing | Decrease | |
EXPI | position | Option Expiration - Short | Increase | |
EXPO | position | Option Expiration - Long | Decrease | |
FEEI | fees | Fee Incoming | Increase | |
FEEO | fees | Fee Outgoing | Decrease | |
IGNORE | n/a | Ignored Transaction (not presented to UI) | ||
INTI | interest | Interest Incoming | Increase | |
INTO | interest | Interest Outgoing | Decrease | |
JOURI | journal | Journal Incoming | Increase | |
JOURO | journal | Journal Outgoing | Decrease | |
OTHWITHHO | withhold | OTHER WITHHOLDING OUT (NO PERF IMPACT) | Decrease | |
OTHWITHHI | withhold | OTHER WITHHOLDING IN (NO PERF IMPACT) | Increase | |
POSI | position | Position Incoming | Increase | |
POSO | position | Position Outgoing | Decrease | |
PRINI | principal | Principal Incoming | Increase | |
PRINO | principal | Principal Outgoing | Decrease | |
REDIVI | dividend_reinvestment | Reinvested Dividend In | Increase | |
REDIVO | dividend_reinvestment | Reinvested Dividend Out | Decrease | |
SELL | sale | Sell | Decrease | Increase |
SHORT | sale | Short | Decrease | |
SPLITI | split | Split Incoming | Increase | |
SPLITO | split | Split Outgoing | Decrease | |
STC | sale | Sell to Close | Decrease | Increase |
STO | sale | Sell to Open | Decrease | Increase |
UNKNOWN | Unknown | Unknown Transaction Type | ||
WITHD | withdrawal | Cash Withdrawal | Decrease | |
WITHHI | withhold | Withholding Incoming | Increase | |
WITHHO | withhold | Withholding Outgoing | Decrease | |
XBUY | trade_canceled_buy | Cancel Buy | Decrease | Increase |
XFERI | transfer | Securities Transfer Incoming | Increase | |
XFERO | transfer | Securities Transfer Outgoing | Decrease | |
XFERMI | transfer | Money Transfer Incoming (specific to intra-account money movement activity) | ||
XFERMO | transfer | Money Transfer Outgoing (specific to intra-account money movement activity) | ||
XSELL | trade_canceled_sell | Cancel Sell | Increase | Decrease |
Updated 12 months ago
What’s Next
Did this page help you?