GET Household/{householdId}/Activity?FromDate={FromDate}&ToDate={ToDate}&TradeTypeId={TradeTypeId}&MaxRecords={MaxRecords}

Retrieve activity for the specified household with the given request parameters

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
householdId

Household to get activity for

string

Required

FromDate

The beginning date to pull activities for

date

None.

ToDate

The end date to pull activities for

date

None.

TradeTypeId

The specific type of trade requested. Leave null to retrieve activities of all trade types.

integer

None.

MaxRecords

Max records. Leaving null to retrieve all records up to the system limit.

integer

None.

Body Parameters

None.

Response Information

Resource Description

Returns activities information in an ActivitiesModel object.

Type: ActivitiesModel
NameDescriptionTypeAdditional information
AsOfDate

The date that the values were calculated as of

date

None.

ExceedsMaxRecords

Indicates whether there were additional results that were not returned

boolean

None.

Activities

Gets or sets the collection of activities.

Collection of ActivityModel

None.

Response Formats

application/json, text/json

Sample:
{
  "AsOfDate": "2018-07-22T02:15:17.1916418-04:00",
  "ExceedsMaxRecords": false,
  "Activities": [
    {
      "TradeType": "Sell",
      "Security": {
        "Ticker": "SAMPLETCKR1",
        "USCode": "SMPL1",
        "Name": "Sample Security Name 1",
        "Type": "mf"
      },
      "Amount": 200.0,
      "Units": 20.0,
      "AccountId": "1234567",
      "TradeDate": "2018-07-20T02:15:17.1916418-04:00",
      "SettlementDate": "2018-07-21T02:15:17.1916418-04:00",
      "Commissions": 1.0,
      "Fees": 2.0,
      "SecFee": 3.0,
      "WithTax": 4.0
    },
    {
      "TradeType": "Buy",
      "Security": {
        "Ticker": "SAMPLETCKR2",
        "USCode": "SMPL2",
        "Name": "Sample Security Name 2",
        "Type": "an"
      },
      "Amount": 100.0,
      "Units": 10.0,
      "AccountId": "9876543",
      "TradeDate": "2018-07-20T02:15:17.1916418-04:00",
      "SettlementDate": "2018-07-21T02:15:17.1916418-04:00",
      "Commissions": 2.0,
      "Fees": 3.0,
      "SecFee": 2.0,
      "WithTax": 1.0
    }
  ]
}

application/xml, text/xml

Sample:
<ActivitiesModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PP.Contracts.WebApi.Client">
  <Activities>
    <ActivityModel>
      <AccountId>1234567</AccountId>
      <Amount>200</Amount>
      <Commissions>1</Commissions>
      <Fees>2</Fees>
      <SecFee>3</SecFee>
      <Security>
        <Name>Sample Security Name 1</Name>
        <Ticker>SAMPLETCKR1</Ticker>
        <Type>mf</Type>
        <USCode>SMPL1</USCode>
      </Security>
      <SettlementDate>2018-07-21T02:15:17.1916418-04:00</SettlementDate>
      <TradeDate>2018-07-20T02:15:17.1916418-04:00</TradeDate>
      <TradeType>Sell</TradeType>
      <Units>20</Units>
      <WithTax>4</WithTax>
    </ActivityModel>
    <ActivityModel>
      <AccountId>9876543</AccountId>
      <Amount>100</Amount>
      <Commissions>2</Commissions>
      <Fees>3</Fees>
      <SecFee>2</SecFee>
      <Security>
        <Name>Sample Security Name 2</Name>
        <Ticker>SAMPLETCKR2</Ticker>
        <Type>an</Type>
        <USCode>SMPL2</USCode>
      </Security>
      <SettlementDate>2018-07-21T02:15:17.1916418-04:00</SettlementDate>
      <TradeDate>2018-07-20T02:15:17.1916418-04:00</TradeDate>
      <TradeType>Buy</TradeType>
      <Units>10</Units>
      <WithTax>1</WithTax>
    </ActivityModel>
  </Activities>
  <AsOfDate>2018-07-22T02:15:17.1916418-04:00</AsOfDate>
  <ExceedsMaxRecords>false</ExceedsMaxRecords>
</ActivitiesModel>