Response Structure

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "ppex_orders": [
    {
      "securityId": "28365032",
      "securityName": "ABCD",
      "expirationType": "1",
      "expirationDate": "2025-06-14",
      "memberId": "777",
      "orderId": "2482",
      "accountId": "A04834434",
      "accountName": "Retirement A/C",
      "securityType": "Offer",
      "shares": "359.430914",
      "remainingShares": "953.744306",
      "sharePrice": "4.530231",
      "amount": "460186.965273",
      "priceNotDisplayed": "No",
      "allOrNone": "No",
      "status": "Inactive",
      "type": "Yes",
      "tradeStatus": "Pending",
      "orderStatus": "Pending",
      "tradeOrderStatus": "CREATED",
      "negotiationStatus": "Pending",
      "deleted": "Active",
      "createdDate": "2024-12-10 00:00:00",
      "updatedBy": "0",
      "updatedDate": "2022-08-28 00:00:00",
      "executionTime": "5.45",
      "contingencies": "All",
      "solicited": "No",
      "minimumQuantity": "87.741240",
      "operationHrStatus": "1",
      "origination": "platform",
      "cancelDate": "2025-02-10 22:08:45",
      "cancelExecutionTime": "0",
      "token": "b8s0zjstfaf"
    }
  ],
  "pagination": {
    "totalRecords": number,
    "startIndex": number,
    "endIndex": number
  }
}

Examples

Basic query (default behavior):

GET /v3/ppex/orders

Limit the number of results:

GET /v3/ppex/orders?limit=1

Use limit and offset for pagination:

GET /v3/ppex/orders?limit=1&offset=2

Filter by orderId:

GET /v3/ppex/orders?filter[orderId]=123456

Filter by order_Id (alternative format):

GET /v3/ppex/orders?filter[order_Id]=123456

Filter using multiple fields:

GET /v3/ppex/orders?filter[securityId]=789&filter[accountId]=abc123&filter[status]=active

Sort by createdDate in ascending order:

GET /v3/ppex/orders?sort=createdDate:asc

Sort by updatedDate in descending order:

GET /v3/ppex/orders?sort=updatedDate:desc

Filter by date range and sort:

GET /v3/ppex/orders?filter[updatedDate][min]=2020-04-23&filter[updatedDate][max]=2022-11-13&sort=updatedDate:desc

Permissions

This method requires the scopeppex_order.read.pii_mediumto be granted to the calling API key.

This scope can be assigned by system admins through the API or Transact Portal.

Filtering

For more information on filtering see

Working with List Endpoints