Get Transactions API
The Get Transactions API allows you to retrieve a history of all transactions in your account. You can filter transactions by type (orders, portfolio activities, or copy/mirror operations) and apply additional filters like status and date range. The API supports pagination for handling large transaction datasets.
Endpoint
GET /user/transactions
Authentication
All requests require the IdToken obtained from the authentication flow:
Authorization: Bearer <ID_TOKEN>
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | Transaction type: "ORDER", "PORTFOLIO", or "MIRROR" |
| limit | number | No | Number of results per page (default: 20, max: 100) |
| nextPage | string | No | Pagination cursor from previous response for fetching next page |
| filters | object | No | Additional filter parameters (e.g., status, date range, ticker symbol) |
Transaction Types
The API returns different transaction objects based on the type parameter. Choose the appropriate type for your use case:
- ORDER - Buy, sell, and dividend reinvestment transactions
- PORTFOLIO - Deposits, withdrawals, dividends, and cash adjustments
- MIRROR - Copy/mirror portfolio transactions
Response Format
| Field | Type | Description |
|---|---|---|
| results | array | Array of transaction objects (type depends on query parameter) |
| nextPage | string | Cursor for pagination - use in next request to fetch more results |
Transaction Status Values:
| Status | Description |
|---|---|
| CREATED | Transaction has been created but not yet processed |
| PENDING | Transaction is waiting for processing or execution |
| PENDING_FLEX_QUERY | Transaction is pending and querying flexible/fractional share availability |
| SUCCESS | Transaction has been successfully completed |
| CANCELLED | Transaction has been cancelled |
| FAILED | Transaction failed to process or execute |
| PENDING_CANCEL | Transaction cancellation is in progress |
| SCHEDULED | Transaction is scheduled for future execution |
| IN_PROGRESS | Transaction is currently being processed or executed |