Order Status API - Search for Orders
Search for orders using custom criteria. Supported criteria include Customer Account, Customer Order ID, order Status and Symbol. 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 | ||
| Status | Query | Yes |
| OPTIONAL | ||
| Symbol | Query |
| Yes | OPTIONAL |
Response - 200
Body
Order Response Message - OrderResponseMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Payload |
|
Order - OrderResponseMessage.payload[]
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. | |
| Display Quantity |
| OPTIONAL | Maximum amount of quantity to be displayed in the order book at any given time. Default is the full order quantity. Can be any number between 1 and the value in Quantity. | |
| Duration Type |
| ALWAYS | Defines how long the order will remain working. Day (current trading session) is the default. Customers may also use Good_Till_Cancel, Good_Till_Date, Fill_And_Kill and Fill_Or_Kill. | |
| Expiration Date |
| CONDITIONAL | Defines the expiration date of the working order. Expiration Date is required when Duration Type is Good_Till_Date.
| |
| Manual Indicator |
| ALWAYS | Indicates if the message was generated by manual or automated trading logic. This tag is subject to Rule 536.B.2 Electronic Audit Trail Requirements for Electronic Order Routing/Front-End Systems. | |
| Maximum Show Quantity |
| OPTIONAL | Maximum amount of quantity to be displayed in the order book at any given time. Default is the full order quantity. Can be any number between 1 and the value in Quantity. | |
| Price |
| CONDITIONAL | Price per lot for the order. Required for Limit and Stop_Limit orders.
| |
| Order Quantity |
| ALWAYS | Total order size. | |
| Side Indicator |
| ALWAYS | Indicates if order is to buy or sell. | |
| Order Status |
| ALWAYS | Current status of the order. | |
| Stop Price |
| CONDITIONAL | Required for Stop and Stop_Limit orders. Identifies the stop trigger price for the order.
| |
| Transaction Time |
| ALWAYS | ||
| Order Type |
| ALWAYS | Order type. Permitted values are Limit, Market, Market_to_Limit, Stop and Stop_Limit. | |
| Venue Order Identifier |
| ALWAYS | CME Globex-assigned assigned order identifier; unique across all iLink sessions and market segments for a trade date. | |
Entities |
| ||||
Instrument |
|
Order Entities - OrderResponseMessage.payload[].entities
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Customer Account Identifier |
| ALWAYS | Customer account identifier. | |
| Customer Origin Type |
| ALWAYS | The Origin Type as defined in the user's CME Direct profile; Customer or House. | |
| Customer Type |
| ALWAYS | The Customer Type as defined in the user's CME Direct profile; Default, Member Other Individual, Member Other Member or Member Own. |
Instrument - OrderResponseMessage.payload[].instrument
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Instrument Trading 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. |
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.