Order Entry API - Submit Order
Submit a new order.
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:Â | REQUIRED | Timestamp of when the message was sent from customer system. |
Body
Order Request Message - OrderRequestMessage
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
Payload |
| Â |
Order - OrderRequestMessage.payload[]
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Customer Order ID |
| Â | REQUIRED | 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 |
| OPTIONAL | 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 |
| Format:Â | CONDITIONAL | Defines the expiration date of the working order. Expiration Date is required when Duration Type is Good_Till_Date.
|
| Manual Indicator |
| REQUIRED | 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. | |
| Price |
| Â | CONDITIONAL | Price per lot for the order. Required for Limit and Stop_Limit orders
|
| Order Quantity |
| Â | REQUIRED | Total order size. |
| Side Indicator |
| REQUIRED | Indicates if message is for a buy or sell order. | |
| Stop Price |
| Â | CONDITIONAL | Required for Stop and Stop_Limit orders. Designates the stop trigger price for the order.
|
| Order Type |
| REQUIRED | Order type. Permitted values are Limit, Market, Market_to_Limit, Stop and Stop_Limit. | |
Entities |
| Â | |||
Instrument |
| Â |
Order Entities - OrderRequestMessage.payload[].entities
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Customer Account Identifier |
| Â | REQUIRED | Customer account identifier. |
| Executing Firm Identifier |
| Â | REQUIRED | Executing firm identifier. |
Instrument - OrderRequestMessage.payload[].instrument
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| Instrument Trading Symbol |
| Â | REQUIRED | 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 - 201
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. |
| Status |
| ALWAYS | Status of the submitted order. | |
| Venue Order ID |
| Â | ALWAYS | CME Globex-assigned assigned order identifier; unique across all iLink sessions and market segments. |
Entities |
| Â |
Order Entities - OrderResponseMessage.payload[].entities
Field | Name | Type | Values | Usage | Description |
---|---|---|---|---|---|
| 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. |
Response - 400
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 | Â |
Response - 401
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.