Use this search bar to search topics within the Portfolio Manager API.
The PM API supports the following information in Trade Capture Report messages:
- Cleared Trade Notifications and Trade Cancellations
- Allocations. See the message flow for this function.
- Allocation Notifications (single trade allocations are treated as group allocations, where the group has just one trade
- Allocation Release/ Reversal Notifications
- Spread and Leg level messages.
- Change of Trading Firm. When the Trading Firm is changed on the transaction, a Cancel Notification is sent to the previous Trading Firm and a New Trade Notification is sent to the new Trading Firm. See the message flow for this function.
- MOS Allocations: The Mutual Offset System allows foreign exchanges to allocate to a CME Firm and vice versa.
Subscriptions and Queries
Retrieve data using subscriptions and queries. Queries return trade messages only up to the date and time that the query request was received by the API. Subscriptions continue to send trade messages to the customer as long as this information becomes available; there is no end date time.
Continuing a Subscription or Query
The PM API sends a token to a customer for as long as information is available for the subscription or query. The subscription or query response continues as long as the customer returns the token to the API.
Sending a subscription or query response without the token results in the API returning a complete set of unfiltered trade messages.
See the message flow for this function.
API Input | API Output |
---|---|
Subscription/Query Request for all Data |
Successful Subscription Response for all data Subscription Error Response – Inappropriate Permission |
Subscription/Query Request with Filters |
Successful Subscription Response with Filtered Messages Subscription Error Response – Inappropriate Permission |
Subscription/Query Continuation with Token | Subscription Response with Token |
Subscription and Query Parameters
Use the following parameters to filter the query and/ or subscription results.
- Party Role (R) <<Broker, Asset Manager, Trading Firm>>
- Trade Date (TrdDt)
- Venue (InptSrc)
- Product (Instrmt.ID)
- Product Type <<SecTyp eg. FUT, OPT, MLEG>>
- Exchange (Exch)