Order Entry API - Get Instrument

Owned by
CME Group
Apr 26, 2024
5 min read

Request an instrument.

URL

/instruments/{id}

HTTP Method

GET

Version

1.0.1

Content

Request

Parameters

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

Parameter

Name

Location

Type

Multi-ple

Values

Usage

Description

CME-Application-Name

Application Name

Header

String

No



REQUIRED



CME-Application-Vendor

Application Vendor

Header

String

No



REQUIRED



CME-Application-Version

Application Version

Header

String

No



REQUIRED



CME-Request-ID

Request ID

Header

String

No



REQUIRED



CME-Transact-Time

Transaction Time

Header

DateTime

No

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

REQUIRED



id

ID

Path

String

No



REQUIRED



Response - 200

Body

Instrument Response Message - InstrumentResponseMessage



Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

payload[]

Payload

Instrument









Instrument - InstrumentResponseMessage.payload[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

id

Instrument ID

String



ALWAYS



productType

Product Type

ProductType

  • COMBO

ALWAYS



symbol

Instrument Symbol

String



ALWAYS



legs[]

Legs

Instrument



Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

id

Instrument ID

String



ALWAYS



productType

Product Type

ProductType

  • COMBO

ALWAYS



symbol

Instrument Symbol

String



ALWAYS



legs[]

Legs

Instrument



Instrument - InstrumentResponseMessage.payload[].legs[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

delta

Delta

Decimal



ALWAYS



referencePrice

Reference Price

Price



ALWAYS



sideInd

Side Indicator

MarketSideIndicator

  • BUY

  • SELL

ALWAYS



strategyRatio

Strategy Ratio

Integer



ALWAYS



symbol

Symbol

String



ALWAYS



Response - 400

Body

Error Response Message - ErrorResponseMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error








Error - ErrorResponseMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Error Code

String

ALWAYS



instance

Error Instance

String



OPTIONAL



message

Error Message

String



ALWAYS



referenceIndex

Error Reference Index

Integer



ALWAYS



Response - 401

Response - 404

Response - 500

Body

Error Response Message - ErrorResponseMessage

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

errors[]

Errors

Error



Error - ErrorResponseMessage.errors[]

Field

Name

Type

Values

Usage

Description

Field

Name

Type

Values

Usage

Description

code

Error Code

String

ALWAYS



instance

Error Instance

String



OPTIONAL



message

Error Message

String



ALWAYS



referenceIndex

Error Reference Index

Integer



ALWAYS





How was your Client Systems Wiki Experience? Submit Feedback

Copyright © 2024 CME Group Inc. All rights reserved.