Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
hiddenfalse

Request a working order by the CME Globex venue order ID.

Style
.wiki-content .columnLayout .cell.aside {width:500px;}
Panel
borderColorlightgray
URL/orders/{venueOrderId}
HTTP MethodGET
Version1.0.1
Panel
borderColorlightgray
titleContent
Table of Contents
maxLevel2

Request

Parameters

ParameterNameLocationTypeMulti-pleValuesUsageDescription
CME-Application-NameApplication NameHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Name of the customer system that generated the message. Must match the system name as certified in AutoCert+ exactly.

CME-Application-VendorApplication VendorHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Name of the vendor who provided the customer system. For a proprietary system, use the firm name.

CME-Application-VersionApplication VersionHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Version identifier for the customer system.

CME-Request-IDRequest IDHeaderStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Identifier for the customer message.

CME-Transact-TimeTransaction TimeHeaderDateTimeNoFormat:  yyyy-mm-ddThh:mm:ss.dZ
Status
subtletrue
colourGrey
titleOPTIONAL

Timestamp of when the message was sent from customer system.

venueOrderIdVenue Order IDPathStringNo
Status
subtletrue
colourGreen
titleREQUIRED

Response - 200

Body

Anchor
Response200OrderResponseMessage
Response200OrderResponseMessage
Order Response Message - OrderResponseMessage

FieldNameTypeValuesUsageDescription
payload[] PayloadOrder

Anchor
Response200OrderResponseMessage.payload[]
Response200OrderResponseMessage.payload[]
Order - OrderResponseMessage.payload[]

FieldNameTypeValuesUsageDescription
customerOrderIdCustomer Order IDString


Status
subtletrue
colourGreen
titleALWAYS

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.

displayQtyDisplay QuantityQuantity


Status
subtletrue
colourGrey
titleOPTIONAL

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.

durationTypeDuration Type OrderDurationType
  • DAY
  • FILL_AND_KILL
  • FILL_OR_KILL
  • GOOD_TILL_CANCEL
  • GOOD_TILL_DATE
Status
subtletrue
colourGreen
titleALWAYS

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.

expirationDtExpiration DateDate


Status
subtletrue
colourBlue
titleCONDITIONAL

Defines the expiration date of the working order. Expiration Date is required when Duration Type is Good_Till_Date.

  • Always when  DurationType IN (DAY, GOOD_TILL_DATE)
manualIndManual Indicator YesNoIndicator
  • NO
  • YES
Status
subtletrue
colourGreen
titleALWAYS

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.

maxShowQtyMaximum Show QuantityQuantity


Status
subtletrue
colourGrey
titleOPTIONAL

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.

pricePricePrice


Status
subtletrue
colourBlue
titleCONDITIONAL

Price per lot for the order. Required for Limit and Stop_Limit orders.

  • Always when  Type NOT IN (MARKET, MARKET_TO_LIMIT)
qtyOrder QuantityQuantity


Status
subtletrue
colourGreen
titleALWAYS

Total order size.

sideIndSide Indicator MarketSideIndicator
  • BUY
  • SELL
Status
subtletrue
colourGreen
titleALWAYS

Indicates if order is to buy or sell.

statusOrder Status OrderStatus
  • ACTIVE
  • ACTIVE_MODIFIED
  • CANCELED
  • EXPIRED
  • MATCHED
  • PARTIAL
Status
subtletrue
colourGreen
titleALWAYS

Current status of the order.

stopPriceStop PricePrice


Status
subtletrue
colourBlue
titleCONDITIONAL

Required for Stop and Stop_Limit orders. Identifies the stop trigger price for the order.

  • Always when  Type IN (STOP, STOP_LIMIT)
transactionTimeTransaction TimeDateTime


Status
subtletrue
colourGreen
titleALWAYS

typeOrder Type OrderType
  • LIMIT
  • MARKET
  • MARKET_TO_LIMIT
  • STOP
  • STOP_LIMIT
Status
subtletrue
colourGreen
titleALWAYS

Order type. Permitted values are Limit, Market, Market_to_Limit, Stop and Stop_Limit.

venueOrderIdVenue Order IdentifierString


Status
subtletrue
colourGreen
titleALWAYS

CME Globex-assigned assigned order identifier; unique across all iLink sessions and market segments for a trade date.

entities EntitiesOrderEntities
instrument InstrumentInstrument

Anchor
Response200OrderResponseMessage.payload[].entities
Response200OrderResponseMessage.payload[].entities
Order Entities - OrderResponseMessage.payload[].entities

FieldNameTypeValuesUsageDescription
customerAccountIdCustomer Account IdentifierString


Status
subtletrue
colourGreen
titleALWAYS

Customer account identifier.

customerOriginTypeCustomer Origin Type OriginType
  • CUSTOMER
  • HOUSE
Status
subtletrue
colourGreen
titleALWAYS

The Origin Type as defined in the user's CME Direct profile; Customer or House.

customerTypeCustomer Type CustomerType
  • DEFAULT
  • MEMBER_OTHER_INDIVIDUAL
  • MEMBER_OTHER_MEMBER
  • MEMBER_OWN
Status
subtletrue
colourGreen
titleALWAYS

The Customer Type as defined in the user's CME Direct profile; Default, Member Other Individual, Member Other Member or Member Own.

Anchor
Response200OrderResponseMessage.payload[].instrument
Response200OrderResponseMessage.payload[].instrument
Instrument - OrderResponseMessage.payload[].instrument

FieldNameTypeValuesUsageDescription
symbolInstrument Trading SymbolString


Status
subtletrue
colourGreen
titleALWAYS

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

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - ErrorResponseMessage

FieldNameTypeValuesUsageDescription
errors[] ErrorsError

Anchor
Response400ErrorResponseMessage.errors[]
Response400ErrorResponseMessage.errors[]
Error - ErrorResponseMessage.errors[]

FieldNameTypeValuesUsageDescription
codeError CodeString
Status
subtletrue
colourGreen
titleALWAYS

instanceError InstanceString


Status
subtletrue
colourGrey
titleOPTIONAL

messageError MessageString


Status
subtletrue
colourGreen
titleALWAYS

referenceIndexError Reference IndexInteger


Status
subtletrue
colourGreen
titleALWAYS

Response - 401

Response - 404

Response - 500

Body

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - ErrorResponseMessage

FieldNameTypeValuesUsageDescription
errors[] ErrorsError

Anchor
Response500ErrorResponseMessage.errors[]
Response500ErrorResponseMessage.errors[]
Error - ErrorResponseMessage.errors[]

FieldNameTypeValuesUsageDescription
codeError CodeString
Status
subtletrue
colourGreen
titleALWAYS

instanceError InstanceString


Status
subtletrue
colourGrey
titleOPTIONAL

messageError MessageString


Status
subtletrue
colourGreen
titleALWAYS

referenceIndexError Reference IndexInteger


Status
subtletrue
colourGreen
titleALWAYS