ppex/orders/{id}

This endpoint retrieves a single PPEX order.

Log in to see full request history

Response Structure

{ "statusCode": "101", "statusDesc": "Ok", "ppex_order": { "securityId": "28365032", "securityName": "AAPL", "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" } }

Examples

  1. Basic query (fetch the resource in the example above):
GET /v3/ppex/orders/2482

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.

Path Params
string
required

The unique identifier of the order to query

Headers
string
Responses

Language
Request
Click Try It! to start a request and see the response here! Or choose an example:
application/json