GET api/bfg/v1/orders

Lists client orders (<c>SH_GetClientOrders</c>).

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ClientIds

Collection of integer

None.

Status

string

None.

SecurityClassType

string

None.

BuySell

byte

None.

AfterCreatedAt

date

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

GetClientOrdersResponse
NameDescriptionTypeAdditional information
Orders

Collection of OrderResponse

None.

Pagination

HoldingPaginationInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "Orders": [
    {
      "OrderID": 1,
      "DomesticFacilityID": 2,
      "SecurityCode": "sample string 3",
      "Exchange": 64,
      "CurrencyCode": "sample string 5",
      "BuySell": 64,
      "Quantity": 7,
      "QuantityBooked": 8,
      "QuantityFilled": 9,
      "Status": 10,
      "DateTimeCreated": "2026-11-17T11:17:31.1845469+11:00",
      "VWAP": 1.0,
      "PriceType": 64,
      "Price": 1.0,
      "TotalCost": 1.0,
      "Brokerage": 1.0,
      "CreatorName": "sample string 13",
      "ExpiryDate": "2026-11-17T11:17:31.1855494+11:00",
      "DateTimeCompleted": "2026-11-17T11:17:31.1855494+11:00",
      "NotesForClient": "sample string 14",
      "OrderGiver": "sample string 15",
      "ContractNoteIds": "sample string 16",
      "LastAmendmentType": 64
    },
    {
      "OrderID": 1,
      "DomesticFacilityID": 2,
      "SecurityCode": "sample string 3",
      "Exchange": 64,
      "CurrencyCode": "sample string 5",
      "BuySell": 64,
      "Quantity": 7,
      "QuantityBooked": 8,
      "QuantityFilled": 9,
      "Status": 10,
      "DateTimeCreated": "2026-11-17T11:17:31.1845469+11:00",
      "VWAP": 1.0,
      "PriceType": 64,
      "Price": 1.0,
      "TotalCost": 1.0,
      "Brokerage": 1.0,
      "CreatorName": "sample string 13",
      "ExpiryDate": "2026-11-17T11:17:31.1855494+11:00",
      "DateTimeCompleted": "2026-11-17T11:17:31.1855494+11:00",
      "NotesForClient": "sample string 14",
      "OrderGiver": "sample string 15",
      "ContractNoteIds": "sample string 16",
      "LastAmendmentType": 64
    }
  ],
  "Pagination": {
    "PageNumber": 1,
    "PageSize": 2,
    "TotalCount": 3,
    "TotalPages": 4,
    "HasNext": true
  }
}

application/xml, text/xml

Sample:
<GetClientOrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Order">
  <Orders>
    <OrderResponse>
      <Brokerage>1</Brokerage>
      <BuySell>64</BuySell>
      <ContractNoteIds>sample string 16</ContractNoteIds>
      <CreatorName>sample string 13</CreatorName>
      <CurrencyCode>sample string 5</CurrencyCode>
      <DateTimeCompleted>2026-11-17T11:17:31.1855494+11:00</DateTimeCompleted>
      <DateTimeCreated>2026-11-17T11:17:31.1845469+11:00</DateTimeCreated>
      <DomesticFacilityID>2</DomesticFacilityID>
      <Exchange>64</Exchange>
      <ExpiryDate>2026-11-17T11:17:31.1855494+11:00</ExpiryDate>
      <LastAmendmentType>64</LastAmendmentType>
      <NotesForClient>sample string 14</NotesForClient>
      <OrderGiver>sample string 15</OrderGiver>
      <OrderID>1</OrderID>
      <Price>1</Price>
      <PriceType>64</PriceType>
      <Quantity>7</Quantity>
      <QuantityBooked>8</QuantityBooked>
      <QuantityFilled>9</QuantityFilled>
      <SecurityCode>sample string 3</SecurityCode>
      <Status>10</Status>
      <TotalCost>1</TotalCost>
      <VWAP>1</VWAP>
    </OrderResponse>
    <OrderResponse>
      <Brokerage>1</Brokerage>
      <BuySell>64</BuySell>
      <ContractNoteIds>sample string 16</ContractNoteIds>
      <CreatorName>sample string 13</CreatorName>
      <CurrencyCode>sample string 5</CurrencyCode>
      <DateTimeCompleted>2026-11-17T11:17:31.1855494+11:00</DateTimeCompleted>
      <DateTimeCreated>2026-11-17T11:17:31.1845469+11:00</DateTimeCreated>
      <DomesticFacilityID>2</DomesticFacilityID>
      <Exchange>64</Exchange>
      <ExpiryDate>2026-11-17T11:17:31.1855494+11:00</ExpiryDate>
      <LastAmendmentType>64</LastAmendmentType>
      <NotesForClient>sample string 14</NotesForClient>
      <OrderGiver>sample string 15</OrderGiver>
      <OrderID>1</OrderID>
      <Price>1</Price>
      <PriceType>64</PriceType>
      <Quantity>7</Quantity>
      <QuantityBooked>8</QuantityBooked>
      <QuantityFilled>9</QuantityFilled>
      <SecurityCode>sample string 3</SecurityCode>
      <Status>10</Status>
      <TotalCost>1</TotalCost>
      <VWAP>1</VWAP>
    </OrderResponse>
  </Orders>
  <Pagination xmlns:d2p1="http://schemas.datacontract.org/2004/07/TPP.B2B.Webservices2.Contracts2.BFG.Holding">
    <d2p1:HasNext>true</d2p1:HasNext>
    <d2p1:PageNumber>1</d2p1:PageNumber>
    <d2p1:PageSize>2</d2p1:PageSize>
    <d2p1:TotalCount>3</d2p1:TotalCount>
    <d2p1:TotalPages>4</d2p1:TotalPages>
  </Pagination>
</GetClientOrdersResponse>