GET api/v2/investor/accounts/holdings?clientIdentifier={clientIdentifier}&accountNumber={accountNumber}&request={request}
Returns a list of holdings for a given account and user.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientIdentifier |
source system client identifier for end-user |
string |
Required |
| accountNumber |
unique identifier for account |
string |
Required |
| Sort | Collection of SortConfiguation |
None. |
|
| Limit | integer |
None. |
|
| SearchTerm | string |
None. |
|
| Page | integer |
None. |
|
| Sum | Collection of string |
None. |
|
| Group | GroupConfiguation |
None. |
Body Parameters
None.
Response Information
Resource Description
List of holdings models
ApiListResponseOfInvestorHoldingModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Records | Collection of InvestorHoldingModel |
None. |
|
| TotalLength | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"Records": [
{
"HoldingId": 1,
"Name": "sample string 2",
"AccountName": "sample string 3",
"AccountId": 4,
"InstitutionName": "sample string 5",
"InstitutionId": 6,
"Balance": 7.0,
"Quantity": 8.0,
"Price": 9.0,
"CostBasis": 1.0,
"PercentOfAccount": 10.0,
"CUSIP": "sample string 11",
"Symbol": "sample string 12",
"Investors": [
{
"InvestorId": 1,
"InvestorName": "sample string 2",
"EstateId": 1,
"UserId": 1,
"InvestorHHId": 1
},
{
"InvestorId": 1,
"InvestorName": "sample string 2",
"EstateId": 1,
"UserId": 1,
"InvestorHHId": 1
}
],
"IsCusipOverridden": true,
"Classifications": "sample string 14",
"DiversificationId": 1,
"DiversificationName": "sample string 15",
"WealthHoldingType": "sample string 16",
"PrimaryAdvisorId": 17.0,
"UpdatedDate": "2025-01-02T16:24:46.0189154-06:00",
"CreatedDate": "2025-01-02T16:24:46.0189154-06:00",
"HasTaxLots": true,
"CanEditCostBasis": true,
"WealthType": 22,
"EstimatedIncome": 1.0,
"SecurityDescription": "sample string 23",
"IsHome": true,
"IsHomeDisplay": "sample string 25"
},
{
"HoldingId": 1,
"Name": "sample string 2",
"AccountName": "sample string 3",
"AccountId": 4,
"InstitutionName": "sample string 5",
"InstitutionId": 6,
"Balance": 7.0,
"Quantity": 8.0,
"Price": 9.0,
"CostBasis": 1.0,
"PercentOfAccount": 10.0,
"CUSIP": "sample string 11",
"Symbol": "sample string 12",
"Investors": [
{
"InvestorId": 1,
"InvestorName": "sample string 2",
"EstateId": 1,
"UserId": 1,
"InvestorHHId": 1
},
{
"InvestorId": 1,
"InvestorName": "sample string 2",
"EstateId": 1,
"UserId": 1,
"InvestorHHId": 1
}
],
"IsCusipOverridden": true,
"Classifications": "sample string 14",
"DiversificationId": 1,
"DiversificationName": "sample string 15",
"WealthHoldingType": "sample string 16",
"PrimaryAdvisorId": 17.0,
"UpdatedDate": "2025-01-02T16:24:46.0189154-06:00",
"CreatedDate": "2025-01-02T16:24:46.0189154-06:00",
"HasTaxLots": true,
"CanEditCostBasis": true,
"WealthType": 22,
"EstimatedIncome": 1.0,
"SecurityDescription": "sample string 23",
"IsHome": true,
"IsHomeDisplay": "sample string 25"
}
],
"TotalLength": 1
}
application/xml, text/xml
Sample:
<ApiListResponseOfInvestorHoldingModelZBR5H09s xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ExternalAPI.Models">
<Records xmlns:d2p1="http://schemas.datacontract.org/2004/07/ExternalAPI.Models.Investor">
<d2p1:InvestorHoldingModel>
<d2p1:AccountId>4</d2p1:AccountId>
<d2p1:AccountName>sample string 3</d2p1:AccountName>
<d2p1:Balance>7</d2p1:Balance>
<d2p1:CUSIP>sample string 11</d2p1:CUSIP>
<d2p1:CanEditCostBasis>true</d2p1:CanEditCostBasis>
<d2p1:Classifications>sample string 14</d2p1:Classifications>
<d2p1:CostBasis>1</d2p1:CostBasis>
<d2p1:CreatedDate>2025-01-02T16:24:46.0189154-06:00</d2p1:CreatedDate>
<d2p1:DiversificationId>1</d2p1:DiversificationId>
<d2p1:DiversificationName>sample string 15</d2p1:DiversificationName>
<d2p1:EstimatedIncome>1</d2p1:EstimatedIncome>
<d2p1:HasTaxLots>true</d2p1:HasTaxLots>
<d2p1:HoldingId>1</d2p1:HoldingId>
<d2p1:InstitutionId>6</d2p1:InstitutionId>
<d2p1:InstitutionName>sample string 5</d2p1:InstitutionName>
<d2p1:Investors xmlns:d4p1="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Advisor.Models">
<d4p1:AdvisorSimpleInvestorModel>
<d4p1:EstateId>1</d4p1:EstateId>
<d4p1:InvestorHHId>1</d4p1:InvestorHHId>
<d4p1:InvestorId>1</d4p1:InvestorId>
<d4p1:InvestorName>sample string 2</d4p1:InvestorName>
<d4p1:UserId>1</d4p1:UserId>
</d4p1:AdvisorSimpleInvestorModel>
<d4p1:AdvisorSimpleInvestorModel>
<d4p1:EstateId>1</d4p1:EstateId>
<d4p1:InvestorHHId>1</d4p1:InvestorHHId>
<d4p1:InvestorId>1</d4p1:InvestorId>
<d4p1:InvestorName>sample string 2</d4p1:InvestorName>
<d4p1:UserId>1</d4p1:UserId>
</d4p1:AdvisorSimpleInvestorModel>
</d2p1:Investors>
<d2p1:IsCusipOverridden>true</d2p1:IsCusipOverridden>
<d2p1:IsHome>true</d2p1:IsHome>
<d2p1:IsHomeDisplay>sample string 25</d2p1:IsHomeDisplay>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:PercentOfAccount>10</d2p1:PercentOfAccount>
<d2p1:Price>9</d2p1:Price>
<d2p1:PrimaryAdvisorId>17</d2p1:PrimaryAdvisorId>
<d2p1:Quantity>8</d2p1:Quantity>
<d2p1:SecurityDescription>sample string 23</d2p1:SecurityDescription>
<d2p1:Symbol>sample string 12</d2p1:Symbol>
<d2p1:UpdatedDate>2025-01-02T16:24:46.0189154-06:00</d2p1:UpdatedDate>
<d2p1:WealthHoldingType>sample string 16</d2p1:WealthHoldingType>
<d2p1:WealthType>22</d2p1:WealthType>
</d2p1:InvestorHoldingModel>
<d2p1:InvestorHoldingModel>
<d2p1:AccountId>4</d2p1:AccountId>
<d2p1:AccountName>sample string 3</d2p1:AccountName>
<d2p1:Balance>7</d2p1:Balance>
<d2p1:CUSIP>sample string 11</d2p1:CUSIP>
<d2p1:CanEditCostBasis>true</d2p1:CanEditCostBasis>
<d2p1:Classifications>sample string 14</d2p1:Classifications>
<d2p1:CostBasis>1</d2p1:CostBasis>
<d2p1:CreatedDate>2025-01-02T16:24:46.0189154-06:00</d2p1:CreatedDate>
<d2p1:DiversificationId>1</d2p1:DiversificationId>
<d2p1:DiversificationName>sample string 15</d2p1:DiversificationName>
<d2p1:EstimatedIncome>1</d2p1:EstimatedIncome>
<d2p1:HasTaxLots>true</d2p1:HasTaxLots>
<d2p1:HoldingId>1</d2p1:HoldingId>
<d2p1:InstitutionId>6</d2p1:InstitutionId>
<d2p1:InstitutionName>sample string 5</d2p1:InstitutionName>
<d2p1:Investors xmlns:d4p1="http://schemas.datacontract.org/2004/07/WealthAccessDataModels.Advisor.Models">
<d4p1:AdvisorSimpleInvestorModel>
<d4p1:EstateId>1</d4p1:EstateId>
<d4p1:InvestorHHId>1</d4p1:InvestorHHId>
<d4p1:InvestorId>1</d4p1:InvestorId>
<d4p1:InvestorName>sample string 2</d4p1:InvestorName>
<d4p1:UserId>1</d4p1:UserId>
</d4p1:AdvisorSimpleInvestorModel>
<d4p1:AdvisorSimpleInvestorModel>
<d4p1:EstateId>1</d4p1:EstateId>
<d4p1:InvestorHHId>1</d4p1:InvestorHHId>
<d4p1:InvestorId>1</d4p1:InvestorId>
<d4p1:InvestorName>sample string 2</d4p1:InvestorName>
<d4p1:UserId>1</d4p1:UserId>
</d4p1:AdvisorSimpleInvestorModel>
</d2p1:Investors>
<d2p1:IsCusipOverridden>true</d2p1:IsCusipOverridden>
<d2p1:IsHome>true</d2p1:IsHome>
<d2p1:IsHomeDisplay>sample string 25</d2p1:IsHomeDisplay>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:PercentOfAccount>10</d2p1:PercentOfAccount>
<d2p1:Price>9</d2p1:Price>
<d2p1:PrimaryAdvisorId>17</d2p1:PrimaryAdvisorId>
<d2p1:Quantity>8</d2p1:Quantity>
<d2p1:SecurityDescription>sample string 23</d2p1:SecurityDescription>
<d2p1:Symbol>sample string 12</d2p1:Symbol>
<d2p1:UpdatedDate>2025-01-02T16:24:46.0189154-06:00</d2p1:UpdatedDate>
<d2p1:WealthHoldingType>sample string 16</d2p1:WealthHoldingType>
<d2p1:WealthType>22</d2p1:WealthType>
</d2p1:InvestorHoldingModel>
</Records>
<TotalLength>1</TotalLength>
</ApiListResponseOfInvestorHoldingModelZBR5H09s>