Order Status API - Search for Trades
Request a trade record using custom criteria. Supported criteria include Customer Account, Customer Order ID, all trades that occured during a particular time period, order Status, Symbol or CME Globex order ID. Based on query parameters, one or more orders may be returned.
URL |
|
---|---|
HTTP Method |
|
Version | 1.0.1 |
Request
Parameters
Parameter | Name | Location | Type | Multi-ple | Values | Usage | Description |
---|---|---|---|---|---|---|---|
| Application Name | Header |
| No | Â | REQUIRED | Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly. |
| Application Vendor | Header |
| No | Â | REQUIRED | Name of the vendor who provided the customer system. For a proprietary system, use the firm name. |
| Application Version | Header |
| No | Â | REQUIRED | Version identifier for the customer system. |
| Request ID | Header |
| No | Â | REQUIRED | Identifier for the customer message. |
| Transaction Time | Header |
| No | Format:Â | OPTIONAL | Timestamp of when the message was sent from customer system. |
| Customer Account Identifier | Query |
| Yes | Â | OPTIONAL | Â |
| Customer Order Identifier | Query |
| Yes | Â | OPTIONAL | Â |
| End Time | Query |
| No | Format:Â | OPTIONAL | Â |
| Start Time | Query |
| No | Format:Â | OPTIONAL | Â |
| Symbol | Query |
| Yes | Â | OPTIONAL | Â |
| Venue Order Identifier | Query |
| Yes | Â | OPTIONAL | Â |
Response - 200
Body
Trade Response Message - TradeResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Payload |
| Â |
Trade - TradeResponseMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Execution Time |
| Â | ALWAYS | Â |
| Trade Date |
| Â | ALWAYS | Business trade date. |
| Venue Trade Sequence |
| Â | ALWAYS | CME Globex trade sequence number?? |
Instrument |
| Â | |||
Sides |
| Â |
Instrument - TradeResponseMessage.payload[].instrument
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Exchange MIC |
| Â | ALWAYS | CME Globex exchange identifier as defined in the CME Reference Data API in "exchangeGlobex" and reflected in MDP 3.0 Security Definition messages in tag 207-SecurityExchange. |
| ID |
| Â | ALWAYS | ? Unique integer identifier for instrument on CME Globex as defined in CME Reference Data API in "globexSecurityId"" and reflected in MDP 3.0 Security Definition messages in tag 48-SecurityID. ? |
| Symbol |
| Â | ALWAYS | CME Globex symbol for the instrument as defined in the Reference Data API in globexSymbol, and reflected in MDP3.0 tag 55-Symbol and iLink tag 107-SecurityDesc |
Trade Side - TradeResponseMessage.payload[].sides[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Price |
| Â | ALWAYS | Price per lot for the order. |
| Quantity |
| Â | ALWAYS | Total order size. |
| Side Indicator |
| ALWAYS | Indicates if order is to buy or sell. | |
| Spread Type |
| ALWAYS | Spread type indicator as defined in CME Reference Data API in "strategyType" and reflected in the MDP 3.0 Security Definition messages in tag 762-SecuritySubType. | |
| Venue Execution ID |
| Â | ALWAYS | CME Globex execution ID for traded orders. |
Entities |
| Â | |||
Order |
| Â |
Trade Side Entities - TradeResponseMessage.payload[].sides[].entities
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Executing Firm ID |
| Â | ALWAYS | CME Globex executing firm identifier. |
Order - TradeResponseMessage.payload[].sides[].order
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Customer Order ID |
| Â | ALWAYS | Unique customer-assigned order identifier. Client system must maintain uniqueness of this value across all orders for the trading week (Sunday through Friday). Maximum allowed value is 20bytes. |
| Remaining Quantity |
| Â | ALWAYS | Order quantity currently resting on the book. |
| Status |
| ALWAYS | Current status of the order. | |
| Venue Order ID |
| Â | ALWAYS | CME Globex-assigned assigned order identifier; unique across all iLink sessions and market segments. |
Response - 400
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
| Â |
Error - ErrorResponseMessage.errors[]
Response - 401
Response - 404
Response - 500
Body
Error Response Message - ErrorResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Errors |
| Â |
Error - ErrorResponseMessage.errors[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Error Code |
| ALWAYS | Â | |
| Error Instance |
| Â | OPTIONAL | Â |
| Error Message |
| Â | ALWAYS | Â |
| Error Reference Index |
| Â | ALWAYS | Â |
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.