Transactions
The single feed for all member investment activity — orders, dividends, and IRA cash movements.
Transactions are the one feed for everything that moves money or assets in a member's investment accounts. Every record carries a type telling you what kind of activity it is:
type | What it covers |
|---|---|
order | A buy or sell the member placed — one-off or recurring |
dividend | Dividend income credited to the member |
ira | An IRA cash movement — a contribution or a distribution |
There are no separate orders, dividends, or IRA endpoints — pull /transactions/ and filter by type when you only want one category.
Each record also carries a transaction_name (buy, sell, dividend, contribution, distribution) saying what it actually did. Reach for it whenever direction matters: amount is unsigned, and type: "ira" alone cannot tell a contribution from a distribution. See Enumerated types for how the two fields pair up.
- Get transaction list — paginated activity with
type,user_account_id,trading_period_id, andtransacted_atdate-window filters. - Get transaction detail — a single transaction by id.
Every transaction also carries a trading_period_id linking it to the trading period it settles in — filter the list by it to see exactly what a settlement batch contains.
New to the API? Start with the Overview for the authentication, data format, and pagination conventions that apply across every endpoint.
Get User List
Returns a paginated list of users matching the given filters. Scoped to the API key's financial institution. Each item's per-product KYC status, approval timestamp, and market value are read from the indexed user document.
Get Transaction List
Returns a paginated list of transactions across orders, dividends, and IRA movements.

