GET Account/{accountId}/Holding?asOfDate={asOfDate}&includeLots={includeLots}

Gets the holding for an account.

Request Information

Header Parameters

NameDescriptionTypeAdditional information
Authorization

The authorization token prefixed with 'Bearer'

string

Required

Sample:
Authorization: Bearer gBsdjflsdkj#wsjelKDSDdsdDTjeYYfvikg2cZQIu_ombqpyE7DZgEHClLO06EtHLFV65lelXVwx9JR33gib3nxzzJKLSDFJ-Xrt5ressxjArc3F6hy1J...        

URI Parameters

NameDescriptionTypeAdditional information
accountId

The account identifier.

string

Required

asOfDate

As of date.

date

Required

includeLots

Indicates if lots should be included or not. If set to true include lots.

boolean

Required

Body Parameters

None.

Response Information

Resource Description

Returns holdings information in a HoldingsModel object.

Type: HoldingsModel
NameDescriptionTypeAdditional information
AsOfDate

The date that the values were calculated as of

date

None.

Holdings

A list of holdings

Collection of HoldingModel

None.

Response Formats

application/json, text/json

Sample:
{
  "AsOfDate": "2018-09-22T12:35:17.0966176-04:00",
  "Holdings": [
    {
      "Security": {
        "Ticker": "SAMPLETCKR1",
        "USCode": "SMPL1",
        "Name": "Sample Security Name 1",
        "Type": "mf"
      },
      "Value": 75.0,
      "Units": 20.0,
      "Price": 3.75,
      "AccruedInterest": 1.0,
      "Lots": null
    },
    {
      "Security": {
        "Ticker": "SAMPLETCKR2",
        "USCode": "SMPL2",
        "Name": "Sample Security Name 2",
        "Type": "an"
      },
      "Value": 100.0,
      "Units": 10.0,
      "Price": 10.0,
      "AccruedInterest": 10.0,
      "Lots": null
    }
  ]
}

application/xml, text/xml

Sample:
<HoldingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client">
  <AsOfDate>2018-09-22T12:35:17.0966176-04:00</AsOfDate>
  <Holdings>
    <HoldingModel>
      <AccruedInterest>1</AccruedInterest>
      <Lots i:nil="true" />
      <Price>3.75</Price>
      <Security>
        <Name>Sample Security Name 1</Name>
        <Ticker>SAMPLETCKR1</Ticker>
        <Type>mf</Type>
        <USCode>SMPL1</USCode>
      </Security>
      <Units>20</Units>
      <Value>75</Value>
    </HoldingModel>
    <HoldingModel>
      <AccruedInterest>10</AccruedInterest>
      <Lots i:nil="true" />
      <Price>10</Price>
      <Security>
        <Name>Sample Security Name 2</Name>
        <Ticker>SAMPLETCKR2</Ticker>
        <Type>an</Type>
        <USCode>SMPL2</USCode>
      </Security>
      <Units>10</Units>
      <Value>100</Value>
    </HoldingModel>
  </Holdings>
</HoldingsModel>