Response Structure

{
  "statusCode": "101",
  "statusDesc": "Ok",
  "ppex_trade": {
    "memberId": "777",
    "askId": "180",
    "bidId": "126",
    "offeringId": "549119",
    "accountId": "ACCpiyiqzn0",
    "partyType": "SELLER",
    "tradeId": "81",
    "transactionType": "BUY",
    "amount": "2906.113302",
    "sharePrice": "83.307155",
    "shares": "564.183958",
    "status": "PENDING",
    "reportingStatus": "FAILED",
    "createdDate": "2024-12-10 00:00:00",
    "deleted": "0",
    "executionTime": "485",
    "updatedDate": "2022-02-13 00:00:00"
  }
}

Response Object

Field	Type	Description
`statusCode`	String	Response status code. "101" indicates success.
`statusDesc`	String	Description of the status code. "Ok" indicates a successful operation.
`ppex_trade`	Object	Trade details.

PPEX Trade Object

Field	Type	Description
`memberId`	String	Unique identifier for the member involved in the trade.
`askId`	String	Identifier for the ask (sell) order.
`bidId`	String	Identifier for the bid (buy) order.
`offeringId`	String	Identifier for the offering being traded.
`accountId`	String	Unique identifier for the account involved in the trade.
`partyType`	String	Role of the party in the transaction (e.g., "SELLER", "BUYER").
`tradeId`	String	Unique identifier for the trade.
`transactionType`	String	Type of transaction (e.g., "BUY", "SELL").
`amount`	String	Total monetary value of the trade (shares × sharePrice).
`sharePrice`	String	Price per share for the trade.
`shares`	String	Number of shares involved in the trade.
`status`	String	Current status of the trade (e.g., "PENDING", "COMPLETED").
`reportingStatus`	String	Status of trade reporting (e.g., "FAILED", "SUCCESS").
`createdDate`	String	Date and time when the trade was created (format: "YYYY-MM-DD HH:MM:SS").
`deleted`	String	Flag indicating if the trade has been deleted ("0" = not deleted, "1" = deleted).
`executionTime`	String	Time taken to execute the trade (in milliseconds).
`updatedDate`	String	Date and time when the trade was last updated (format: "YYYY-MM-DD HH:MM:SS").

📘
Calculating the monetary value of a trade
Multiplyshares by sharePrice to determine amount of trade in dollars.
The amount field represents the balance of the sell-side order after the trade. For example, if an order was originally for 30 shares at $5.00 per share ($150 total), and 2 shares were traded at $5.00, the remaining balance would be 28 shares at $5.00, equaling $140. amount would report $140, not $10.

Examples

Basic query (fetch the resource in the example above):

GET /v3/ppex/trades/81

Permissions

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

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