GET api/v2/advisor/investors/{investorId}/brokeragetransactions?startDate={startDate}&endDate={endDate}&ignoreOrion={ignoreOrion}
Returns a list of brokerage transactions for a given investor. Investor is specified by the investorId returned from the advisor/investors endpoint.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
investorId |
Investor is specified by the investorId returned from the advisor/investors endpoint. |
integer |
Required |
startDate |
Optional: Set the first date for the date range to filter transactions. Defaults to lowest possible value. |
date |
None. |
endDate |
Optional: Set the last date for the date range to filter transactions. Defaults to today. |
date |
None. |
ignoreOrion |
Optional: Allows endpoint to return all accounts except for Orion accounts. |
boolean |
Default value is False |
Body Parameters
None.
Response Information
Resource Description
InvestorBrokerageTransactionsListResponseName | Description | Type | Additional information |
---|---|---|---|
Records | Collection of InvestorBrokerageTransactionModel |
None. |
|
TotalLength | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "Records": [ { "WealthAccountTransactionId": 1, "WealthAccountId": 2, "WealthAccountName": "sample string 3", "InstitutionName": "sample string 4", "InstitutionId": 5, "CategoryName": "sample string 6", "Description": "sample string 7", "Amount": 8.0, "Price": 1.0, "Quantity": 1.0, "CUSIP": "sample string 9", "Symbol": "sample string 10", "TransactionDate": "2025-01-02T12:11:22.7047513-06:00", "TypeManuallyChanged": true, "TypeChangedByRule": true }, { "WealthAccountTransactionId": 1, "WealthAccountId": 2, "WealthAccountName": "sample string 3", "InstitutionName": "sample string 4", "InstitutionId": 5, "CategoryName": "sample string 6", "Description": "sample string 7", "Amount": 8.0, "Price": 1.0, "Quantity": 1.0, "CUSIP": "sample string 9", "Symbol": "sample string 10", "TransactionDate": "2025-01-02T12:11:22.7047513-06:00", "TypeManuallyChanged": true, "TypeChangedByRule": true } ], "TotalLength": 1 }
application/xml, text/xml
Sample:
<InvestorBrokerageTransactionsListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Responses"> <Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Investors.Models"> <d2p1:InvestorBrokerageTransactionModel> <d2p1:Amount>8</d2p1:Amount> <d2p1:CUSIP>sample string 9</d2p1:CUSIP> <d2p1:CategoryName>sample string 6</d2p1:CategoryName> <d2p1:Description>sample string 7</d2p1:Description> <d2p1:InstitutionId>5</d2p1:InstitutionId> <d2p1:InstitutionName>sample string 4</d2p1:InstitutionName> <d2p1:Price>1</d2p1:Price> <d2p1:Quantity>1</d2p1:Quantity> <d2p1:Symbol>sample string 10</d2p1:Symbol> <d2p1:TransactionDate>2025-01-02T12:11:22.7047513-06:00</d2p1:TransactionDate> <d2p1:TypeChangedByRule>true</d2p1:TypeChangedByRule> <d2p1:TypeManuallyChanged>true</d2p1:TypeManuallyChanged> <d2p1:WealthAccountId>2</d2p1:WealthAccountId> <d2p1:WealthAccountName>sample string 3</d2p1:WealthAccountName> <d2p1:WealthAccountTransactionId>1</d2p1:WealthAccountTransactionId> </d2p1:InvestorBrokerageTransactionModel> <d2p1:InvestorBrokerageTransactionModel> <d2p1:Amount>8</d2p1:Amount> <d2p1:CUSIP>sample string 9</d2p1:CUSIP> <d2p1:CategoryName>sample string 6</d2p1:CategoryName> <d2p1:Description>sample string 7</d2p1:Description> <d2p1:InstitutionId>5</d2p1:InstitutionId> <d2p1:InstitutionName>sample string 4</d2p1:InstitutionName> <d2p1:Price>1</d2p1:Price> <d2p1:Quantity>1</d2p1:Quantity> <d2p1:Symbol>sample string 10</d2p1:Symbol> <d2p1:TransactionDate>2025-01-02T12:11:22.7047513-06:00</d2p1:TransactionDate> <d2p1:TypeChangedByRule>true</d2p1:TypeChangedByRule> <d2p1:TypeManuallyChanged>true</d2p1:TypeManuallyChanged> <d2p1:WealthAccountId>2</d2p1:WealthAccountId> <d2p1:WealthAccountName>sample string 3</d2p1:WealthAccountName> <d2p1:WealthAccountTransactionId>1</d2p1:WealthAccountTransactionId> </d2p1:InvestorBrokerageTransactionModel> </Records> <TotalLength>1</TotalLength> </InvestorBrokerageTransactionsListResponse>