Excerpt

hidden	false

Request an instrument.

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

Panel

borderColor	lightgray

URL	`/instruments/{id}`
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

CME-Application-Vendor

Application Vendor

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Application-Version

Application Version

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Request-ID

Request ID

Header

String

No

Status

subtle	true
colour	Green
title	REQUIRED

CME-Transact-Time

Transaction Time

Header

DateTime

No

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

Status

subtle	true
colour	Green
title	REQUIRED

id

ID

Path

String

No

Status

subtle	true
colour	Green
title	REQUIRED

Response - 200

Body

Anchor
Response200InstrumentResponseMessage
Response200InstrumentResponseMessage
Instrument Response Message - `InstrumentResponseMessage`

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

Anchor
Response200InstrumentResponseMessage.payload[]
Response200InstrumentResponseMessage.payload[]
Instrument - `InstrumentResponseMessage.payload[]`

Field Name Type Values Usage Description

id

Instrument ID

String

Status

subtle	true
colour	Green
title	ALWAYS

productType

Product Type

ProductType

COMBO

Status

subtle	true
colour	Green
title	ALWAYS

symbol

Instrument Symbol

String

Status

subtle	true
colour	Green
title	ALWAYS

legs[] Legs Instrument

Field Name Type Values Usage Description

id

Instrument ID

String

Status

subtle	true
colour	Green
title	ALWAYS

productType

Product Type

ProductType

COMBO

Status

subtle	true
colour	Green
title	ALWAYS

symbol

Instrument Symbol

String

Status

subtle	true
colour	Green
title	ALWAYS

legs[] Legs Instrument

Anchor
Response200InstrumentResponseMessage.payload[].legs[]
Response200InstrumentResponseMessage.payload[].legs[]
Instrument - `InstrumentResponseMessage.payload[].legs[]`

Field Name Type Values Usage Description

delta

Delta

Decimal

Status

subtle	true
colour	Green
title	ALWAYS

referencePrice

Reference Price

Price

Status

subtle	true
colour	Green
title	ALWAYS

sideInd

Side Indicator

MarketSideIndicator

BUY
SELL

Status

subtle	true
colour	Green
title	ALWAYS

strategyRatio

Strategy Ratio

Integer

Status

subtle	true
colour	Green
title	ALWAYS

symbol

Symbol

String

Status

subtle	true
colour	Green
title	ALWAYS

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
101
102
103
1003
2048
2051
7024
7027
7029

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
100
101
102
103
1003
2048
2051
7024
7027
7029

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
Response200InstrumentResponseMessage
Response200InstrumentResponseMessage
Instrument Response Message - `InstrumentResponseMessage`

Anchor
Response200InstrumentResponseMessage.payload[]
Response200InstrumentResponseMessage.payload[]
Instrument - `InstrumentResponseMessage.payload[]`

Anchor
Response200InstrumentResponseMessage.payload[].legs[]
Response200InstrumentResponseMessage.payload[].legs[]
Instrument - `InstrumentResponseMessage.payload[].legs[]`

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

AnchorResponse200InstrumentResponseMessageResponse200InstrumentResponseMessageInstrument Response Message - InstrumentResponseMessage

AnchorResponse200InstrumentResponseMessage.payload[]Response200InstrumentResponseMessage.payload[]Instrument - InstrumentResponseMessage.payload[]

AnchorResponse200InstrumentResponseMessage.payload[].legs[]Response200InstrumentResponseMessage.payload[].legs[]Instrument - InstrumentResponseMessage.payload[].legs[]

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
Response200InstrumentResponseMessage
Response200InstrumentResponseMessage
Instrument Response Message - `InstrumentResponseMessage`

Anchor
Response200InstrumentResponseMessage.payload[]
Response200InstrumentResponseMessage.payload[]
Instrument - `InstrumentResponseMessage.payload[]`

Anchor
Response200InstrumentResponseMessage.payload[].legs[]
Response200InstrumentResponseMessage.payload[].legs[]
Instrument - `InstrumentResponseMessage.payload[].legs[]`

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[]`