Skip to end of banner
Go to start of banner

Order Entry API - Get Instrument

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »

Request an instrument.
URL/instruments/{id}
HTTP MethodGET
Version1.0.1
Content

Request

Parameters

ParameterNameLocationTypeMulti-pleValuesUsageDescription
CME-Application-NameApplication NameHeaderStringNo
REQUIRED

CME-Application-VendorApplication VendorHeaderStringNo
REQUIRED

CME-Application-VersionApplication VersionHeaderStringNo
REQUIRED

CME-Request-IDRequest IDHeaderStringNo
REQUIRED

CME-Transact-TimeTransaction TimeHeaderDateTimeNoFormat:  yyyy-mm-ddThh:mm:ss.dZ
REQUIRED

idIDPathStringNo
REQUIRED

Response - 200

Body

Instrument Response Message - InstrumentResponseMessage


FieldNameTypeValuesUsageDescription
payload[] PayloadInstrument



Instrument - InstrumentResponseMessage.payload[]

FieldNameTypeValuesUsageDescription
idInstrument IDString


ALWAYS

productTypeProduct Type ProductType
  • COMBO
ALWAYS

symbolInstrument SymbolString


ALWAYS

legs[] LegsInstrument
FieldNameTypeValuesUsageDescription
idInstrument IDString


ALWAYS

productTypeProduct Type ProductType
  • COMBO
ALWAYS

symbolInstrument SymbolString


ALWAYS

legs[] LegsInstrument

Instrument - InstrumentResponseMessage.payload[].legs[]

FieldNameTypeValuesUsageDescription
deltaDeltaDecimal


ALWAYS

referencePriceReference PricePrice


ALWAYS

sideIndSide Indicator MarketSideIndicator
  • BUY
  • SELL
ALWAYS

strategyRatioStrategy RatioInteger


ALWAYS

symbolSymbolString


ALWAYS

Response - 400

Body

Error Response Message - ErrorResponseMessage

FieldNameTypeValuesUsageDescription
errors[] ErrorsError



Error - ErrorResponseMessage.errors[]

FieldNameTypeValuesUsageDescription
codeError CodeString
ALWAYS

instanceError InstanceString


OPTIONAL

messageError MessageString


ALWAYS

referenceIndexError Reference IndexInteger


ALWAYS

Response - 401

Response - 404

Response - 500

Body

Error Response Message - ErrorResponseMessage

FieldNameTypeValuesUsageDescription
errors[] ErrorsError

Error - ErrorResponseMessage.errors[]

FieldNameTypeValuesUsageDescription
codeError CodeString
ALWAYS

instanceError InstanceString


OPTIONAL

messageError MessageString


ALWAYS

referenceIndexError Reference IndexInteger


ALWAYS

  • No labels