Order Entry API V2 - Create Instrument
Request
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | header | |||||
2 | → applicationName | Application Name | String | REQUIRED | Identifies the application generating the message. | |
3 | → applicationVendor | Application Vendor | String | REQUIRED | Identifies the vendor of the application generating the message. | |
4 | → applicationVersion | Application Version | String | REQUIRED | Identifies the version of the application generating the message. | |
5 | → requestId | Request ID | String | REQUIRED | A unique identifier for the request provided by the client for correlation. | |
6 | → sentTime | Sent Time | DateTime | REQUIRED | Timestamp of the message leaving the producing application. | |
7 | payload | |||||
8 | → customerOrderHandlingInstr | Customer Order Handling Instruction | CustomerOrderHandlingInstruction | REQUIRED | ||
9 | → entities | |||||
10 | → → customerAccountId | Customer Account ID | String |
| REQUIRED | |
11 | → → customerOriginType | Customer Origin Type | OriginType |
| REQUIRED | |
12 | → → customerType | Customer Type | CustomerType |
| REQUIRED | |
13 | → → executingFirmId | Executing Firm ID | String |
| REQUIRED | |
14 | → → operatorId | Operator ID | String |
| REQUIRED | |
15 | → → senderCountry | Sender Country | String |
| REQUIRED | |
16 | → → senderState | Sender State | String |
| OPTIONAL | |
17 | → legs[] | |||||
18 | → → delta | Leg Delta | Decimal | OPTIONAL | ||
19 | → → glbxSecurityId | Leg Globex Security ID | Integer | REQUIRED | ||
20 | → → ratioQtyInt | Leg Ratio Quantity Integer | Integer | OPTIONAL | Criteria
| |
21 | → → referencePrice | Leg Reference Price | Price | OPTIONAL | ||
22 | → → sideInd | Leg Side Indicator | MarketSideIndicator |
| REQUIRED | |
23 | → manualInd | Manual Indicator | YesNoIndicator |
| REQUIRED | Indicates whether the instrument was generated by automated trading logic. |
24 | → strategyRequestType | Strategy Request Type | StrategyRequestType |
| REQUIRED |
Response - 201
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | header | |||||
2 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
3 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. | |
4 | payload | |||||
5 | → autoQuoteInd | Auto-Quote Indicator | yesNoIndicator |
| ALWAYS | |
6 | → contractPeriod | Contract Period | string | OPTIONAL | ||
7 | → entities | |||||
8 | → → operatorId | Operator ID | string | ALWAYS | ||
9 | → → senderCountry | Sender Country | string | ALWAYS | ||
10 | → → senderState | Sender State | string | OPTIONAL | ||
11 | → glbxGoodTillInd | Globex Good Till Indicator | yesNoIndicator |
| OPTIONAL | |
12 | → glbxGroupId | Globex Group ID | string | OPTIONAL | ||
13 | → glbxSecurityId | Globex Security ID | int32 | OPTIONAL | ||
14 | → legs[] | |||||
15 | → → delta | Leg Delta | decimal | OPTIONAL | ||
16 | → → glbxSecurityId | Leg Globex Security ID | int32 | ALWAYS | ||
17 | → → ratioQtyInt | Leg Ratio Quantity Integer | int32 | OPTIONAL | ||
18 | → → referencePrice | Leg Reference Price | price | OPTIONAL | ||
19 | → → sideInd | Leg Side Indicator | marketSideIndicator |
| ALWAYS | |
20 | → manualInd | Manual Indicator | yesNoIndicator |
| ALWAYS | Indicates whether the instrument was generated by automated trading logic. |
21 | → priceQuoteCcy | Price Quote Currency | currency | OPTIONAL | ||
22 | → secType | Security Type | securityType |
| OPTIONAL |
Response - 400
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string | ALWAYS | ||
3 | → message | Message | string | ALWAYS | ||
4 | header | |||||
5 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
6 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. |
Response - 403
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string | ALWAYS | ||
3 | → message | Message | string | ALWAYS | ||
4 | header | |||||
5 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
6 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. |
Response - 500
Body
Ref | Field | Name | Data Type | Values | Usage | Description |
---|---|---|---|---|---|---|
1 | errors[] | |||||
2 | → code | Code | string | ALWAYS | ||
3 | → message | Message | string | ALWAYS | ||
4 | → referenceField | Reference Field | string | OPTIONAL | ||
5 | header | |||||
6 | → requestId | Request ID | string | ALWAYS | A unique identifier for the request provided by the client for correlation. | |
7 | → sentTime | Sent Time | dateTime | ALWAYS | Timestamp of the message leaving the producing application. |
How was your Client Systems Wiki Experience? Submit Feedback
Copyright © 2024 CME Group Inc. All rights reserved.