Excerpt

hidden	false

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.

Style
.wiki-content .columnLayout .cell.aside {width:500px;}

Panel

borderColor	lightgray

URL	`/trades/search`
HTTP Method	`GET`
Version	1.0.1

Panel

borderColor	lightgray
title	Content

Table of Contents

maxLevel	2

Request

Parameters

Parameter Name Location Type Multi-ple Values Usage Description

CME-Application-Name

Application Name

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

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

CME-Application-Vendor

Application Vendor

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

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

CME-Application-Version

Application Version

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Version identifier for the customer system.

CME-Request-ID

Request ID

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Identifier for the customer message.

CME-Transact-Time

Transaction Time

Header

DateTime

No

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Grey
title	OPTIONAL

Timestamp of when the message was sent from customer system.

customerAccountId

Customer Account Identifier

Query

String

Yes

Status

subtle	true
colour	Grey
title	OPTIONAL

customerOrderId

Customer Order Identifier

Query

String

Yes

Status

subtle	true
colour	Grey
title	OPTIONAL

endTime

End Time

Query

DateTime

No

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Grey
title	OPTIONAL

startTime

Start Time

Query

DateTime

No

Format: yyyy-mm-ddThh:mm:ss.dZ

Status

subtle	true
colour	Grey
title	OPTIONAL

symbol

Symbol

Query

String

Yes

Status

subtle	true
colour	Grey
title	OPTIONAL

venueOrderId

Venue Order Identifier

Query

String

Yes

Status

subtle	true
colour	Grey
title	OPTIONAL

Response - 200

Body

Anchor
Response200TradeResponseMessage
Response200TradeResponseMessage
Trade Response Message - `TradeResponseMessage`

Field	Name	Type	Values	Usage	Description
`payload[]`	Payload	`Trade`

Anchor
Response200TradeResponseMessage.payload[]
Response200TradeResponseMessage.payload[]
Trade - `TradeResponseMessage.payload[]`

Field Name Type Values Usage Description

executionTime

Execution Time

DateTime

Status

subtle	true
colour	Green
title	ALWAYS

tradeDt

Trade Date

Date

Status

subtle	true
colour	Green
title	ALWAYS

Business trade date.

venueTradeSeq

Venue Trade Sequence

String

Status

subtle	true
colour	Green
title	ALWAYS

CME Globex trade sequence number??

instrument Instrument Instrument

sides[] Sides TradeSide

Anchor
Response200TradeResponseMessage.payload[].instrument
Response200TradeResponseMessage.payload[].instrument
Instrument - `TradeResponseMessage.payload[].instrument`

Field Name Type Values Usage Description

exchangeMic

Exchange MIC

String

Status

subtle	true
colour	Green
title	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

ID

String

Status

subtle	true
colour	Green
title	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

Symbol

String

Status

subtle	true
colour	Green
title	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

Anchor
Response200TradeResponseMessage.payload[].sides[]
Response200TradeResponseMessage.payload[].sides[]
Trade Side - `TradeResponseMessage.payload[].sides[]`

Field Name Type Values Usage Description

price

Price

Price

Status

subtle	true
colour	Green
title	ALWAYS

Price per lot for the order.

qty

Quantity

Quantity

Status

subtle	true
colour	Green
title	ALWAYS

Total order size.

sideInd

Side Indicator

MarketSideIndicator

BUY
SELL

Status

subtle	true
colour	Green
title	ALWAYS

Indicates if order is to buy or sell.

spreadType

Spread Type

SpreadType

IMPLIED
LEG_OF_SPREAD
OUTRIGHT
SPREAD
UNKNOWN

Status

subtle	true
colour	Green
title	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.

venueExecutionId

Venue Execution ID

String

Status

subtle	true
colour	Green
title	ALWAYS

CME Globex execution ID for traded orders.

entities Entities TradeSideEntities

order Order Order

Anchor
Response200TradeResponseMessage.payload[].sides[].entities
Response200TradeResponseMessage.payload[].sides[].entities
Trade Side Entities - `TradeResponseMessage.payload[].sides[].entities`

Field Name Type Values Usage Description

executingFirmId

Executing Firm ID

String

Status

subtle	true
colour	Green
title	ALWAYS

CME Globex executing firm identifier.

Anchor
Response200TradeResponseMessage.payload[].sides[].order
Response200TradeResponseMessage.payload[].sides[].order
Order - `TradeResponseMessage.payload[].sides[].order`

Field Name Type Values Usage Description

customerOrderId

Customer Order ID

String

Status

subtle	true
colour	Green
title	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.

remainingQty

Remaining Quantity

Quantity

Status

subtle	true
colour	Green
title	ALWAYS

Order quantity currently resting on the book.

status

Status

OrderStatus

ACTIVE
ACTIVE_MODIFIED
CANCELED
EXPIRED
MATCHED
PARTIAL

Status

subtle	true
colour	Green
title	ALWAYS

Current status of the order.

venueOrderId

Venue Order ID

String

Status

subtle	true
colour	Green
title	ALWAYS

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

Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Field	Name	Type	Values	Usage	Description
`errors[]`	Errors	`Error`

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

Field Name Type Values Usage Description

code

Error Code

String

1
100
2045

Status

subtle	true
colour	Green
title	ALWAYS

instance

Error Instance

String

Status

subtle	true
colour	Grey
title	OPTIONAL

message

Error Message

String

Status

subtle	true
colour	Green
title	ALWAYS

referenceIndex

Error Reference Index

Integer

Status

subtle	true
colour	Green
title	ALWAYS

Response - 401

Response - 404

Response - 500

Body

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

Field	Name	Type	Values	Usage	Description
`errors[]`	Errors	`Error`

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

Field Name Type Values Usage Description

code

Error Code

String

1

Status

subtle	true
colour	Green
title	ALWAYS

instance

Error Instance

String

Status

subtle	true
colour	Grey
title	OPTIONAL

message

Error Message

String

Status

subtle	true
colour	Green
title	ALWAYS

referenceIndex

Error Reference Index

Integer

Status

subtle	true
colour	Green
title	ALWAYS

Versions Compared

Old Version 1

New Version Current

Key

Request

Parameters

Response - 200

Body

Anchor
Response200TradeResponseMessage
Response200TradeResponseMessage
Trade Response Message - `TradeResponseMessage`

Anchor
Response200TradeResponseMessage.payload[]
Response200TradeResponseMessage.payload[]
Trade - `TradeResponseMessage.payload[]`

Anchor
Response200TradeResponseMessage.payload[].instrument
Response200TradeResponseMessage.payload[].instrument
Instrument - `TradeResponseMessage.payload[].instrument`

Anchor
Response200TradeResponseMessage.payload[].sides[]
Response200TradeResponseMessage.payload[].sides[]
Trade Side - `TradeResponseMessage.payload[].sides[]`

Anchor
Response200TradeResponseMessage.payload[].sides[].entities
Response200TradeResponseMessage.payload[].sides[].entities
Trade Side Entities - `TradeResponseMessage.payload[].sides[].entities`

Anchor
Response200TradeResponseMessage.payload[].sides[].order
Response200TradeResponseMessage.payload[].sides[].order
Order - `TradeResponseMessage.payload[].sides[].order`

Response - 400

Body

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

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

Response - 401

Response - 404

Response - 500

Body

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

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

Page Comparison

Versions Compared

Old Version 1

New Version Current

Key

Request

Parameters

Response - 200

Body

AnchorResponse200TradeResponseMessageResponse200TradeResponseMessageTrade Response Message - TradeResponseMessage

AnchorResponse200TradeResponseMessage.payload[]Response200TradeResponseMessage.payload[]Trade - TradeResponseMessage.payload[]

AnchorResponse200TradeResponseMessage.payload[].instrumentResponse200TradeResponseMessage.payload[].instrumentInstrument - TradeResponseMessage.payload[].instrument

AnchorResponse200TradeResponseMessage.payload[].sides[]Response200TradeResponseMessage.payload[].sides[]Trade Side - TradeResponseMessage.payload[].sides[]

AnchorResponse200TradeResponseMessage.payload[].sides[].entitiesResponse200TradeResponseMessage.payload[].sides[].entitiesTrade Side Entities - TradeResponseMessage.payload[].sides[].entities

AnchorResponse200TradeResponseMessage.payload[].sides[].orderResponse200TradeResponseMessage.payload[].sides[].orderOrder - TradeResponseMessage.payload[].sides[].order

Response - 400

Body

AnchorResponse400ErrorResponseMessageResponse400ErrorResponseMessageError Response Message - ErrorResponseMessage

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

Response - 401

Response - 404

Response - 500

Body

AnchorResponse500ErrorResponseMessageResponse500ErrorResponseMessageError Response Message - ErrorResponseMessage

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

Anchor
Response200TradeResponseMessage
Response200TradeResponseMessage
Trade Response Message - `TradeResponseMessage`

Anchor
Response200TradeResponseMessage.payload[]
Response200TradeResponseMessage.payload[]
Trade - `TradeResponseMessage.payload[]`

Anchor
Response200TradeResponseMessage.payload[].instrument
Response200TradeResponseMessage.payload[].instrument
Instrument - `TradeResponseMessage.payload[].instrument`

Anchor
Response200TradeResponseMessage.payload[].sides[]
Response200TradeResponseMessage.payload[].sides[]
Trade Side - `TradeResponseMessage.payload[].sides[]`

Anchor
Response200TradeResponseMessage.payload[].sides[].entities
Response200TradeResponseMessage.payload[].sides[].entities
Trade Side Entities - `TradeResponseMessage.payload[].sides[].entities`

Anchor
Response200TradeResponseMessage.payload[].sides[].order
Response200TradeResponseMessage.payload[].sides[].order
Order - `TradeResponseMessage.payload[].sides[].order`

Anchor
Response400ErrorResponseMessage
Response400ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

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

Anchor
Response500ErrorResponseMessage
Response500ErrorResponseMessage
Error Response Message - `ErrorResponseMessage`

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