GET api/bfg/v1/holdings

Lists holdings for clients (<c>SH_GetClientHoldings</c>).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientIds

Collection of integer

None.

AfterDateTimeUpdated

date

None.

AfterHoldingID

integer

None.

AfterIsDMLHolding

boolean

None.

SecurityTypes

string

None.

IsGetAll

boolean

None.

PageNumber

integer

None.

PageSize

integer

None.

SortBy

string

None.

SortColumn

string

None.

SortDirection

string

None.

AfterId

integer

None.

Search

string

None.

SearchKeyword

string

None.

FromDate

date

None.

StartDate

date

None.

ToDate

date

None.

EndDate

date

None.

Body Parameters

None.

Response Information

Resource Description

GetClientHoldingsResponse
NameDescriptionTypeAdditional information
Holdings

Collection of HoldingListItem

None.

Pagination

HoldingPaginationInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "Holdings": [
    {
      "HoldingID": 1,
      "ClientID": "sample string 2",
      "SecurityID": 3,
      "SecurityCode": "sample string 4",
      "SecurityShortName": "sample string 5",
      "SecurityLongName": "sample string 6",
      "SecurityExchange": 64,
      "SecurityType": 64,
      "SharesPerContractMultiplier": 9,
      "Quantity": 10.0,
      "DateTimeCreated": "2026-11-17T11:17:44.5311113+11:00",
      "DateTimeUpdated": "2026-11-17T11:17:44.5311113+11:00",
      "IsDMLHolding": true,
      "GearRatio": 14.0
    },
    {
      "HoldingID": 1,
      "ClientID": "sample string 2",
      "SecurityID": 3,
      "SecurityCode": "sample string 4",
      "SecurityShortName": "sample string 5",
      "SecurityLongName": "sample string 6",
      "SecurityExchange": 64,
      "SecurityType": 64,
      "SharesPerContractMultiplier": 9,
      "Quantity": 10.0,
      "DateTimeCreated": "2026-11-17T11:17:44.5311113+11:00",
      "DateTimeUpdated": "2026-11-17T11:17:44.5311113+11:00",
      "IsDMLHolding": true,
      "GearRatio": 14.0
    }
  ],
  "Pagination": {
    "PageNumber": 1,
    "PageSize": 2,
    "TotalCount": 3,
    "TotalPages": 4,
    "HasNext": true
  }
}

application/xml, text/xml

Sample:
<GetClientHoldingsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
  <Holdings>
    <HoldingListItem>
      <ClientID>sample string 2</ClientID>
      <DateTimeCreated>2026-11-17T11:17:44.5311113+11:00</DateTimeCreated>
      <DateTimeUpdated>2026-11-17T11:17:44.5311113+11:00</DateTimeUpdated>
      <GearRatio>14</GearRatio>
      <HoldingID>1</HoldingID>
      <IsDMLHolding>true</IsDMLHolding>
      <Quantity>10</Quantity>
      <SecurityCode>sample string 4</SecurityCode>
      <SecurityExchange>64</SecurityExchange>
      <SecurityID>3</SecurityID>
      <SecurityLongName>sample string 6</SecurityLongName>
      <SecurityShortName>sample string 5</SecurityShortName>
      <SecurityType>64</SecurityType>
      <SharesPerContractMultiplier>9</SharesPerContractMultiplier>
    </HoldingListItem>
    <HoldingListItem>
      <ClientID>sample string 2</ClientID>
      <DateTimeCreated>2026-11-17T11:17:44.5311113+11:00</DateTimeCreated>
      <DateTimeUpdated>2026-11-17T11:17:44.5311113+11:00</DateTimeUpdated>
      <GearRatio>14</GearRatio>
      <HoldingID>1</HoldingID>
      <IsDMLHolding>true</IsDMLHolding>
      <Quantity>10</Quantity>
      <SecurityCode>sample string 4</SecurityCode>
      <SecurityExchange>64</SecurityExchange>
      <SecurityID>3</SecurityID>
      <SecurityLongName>sample string 6</SecurityLongName>
      <SecurityShortName>sample string 5</SecurityShortName>
      <SecurityType>64</SecurityType>
      <SharesPerContractMultiplier>9</SharesPerContractMultiplier>
    </HoldingListItem>
  </Holdings>
  <Pagination>
    <HasNext>true</HasNext>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <TotalCount>3</TotalCount>
    <TotalPages>4</TotalPages>
  </Pagination>
</GetClientHoldingsResponse>