Skip to end of banner
Go to start of banner

Order Entry API V2 - Definitions

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 »

Enumerations

Currency - Currency

ValueNameDescription
AUDAustralian Dollar
BRLBrazilian Real
GBPBritish Pound
CADCanadian Dollar
CLPChilean Peso
CNHChinese Offshore
CNYChinese Yuan
COPColombian Peso
CZKCzech Koruna
DKKDanish Krone
EUREuro
GLDGold
HKDHong Kong Dollar
HUFHungarian Forint
ISKIcelandic Krona
INRIndian Rupee
IDRIndonesian Rupiah
ILSIsraeli Shekel
JPYJapanese Yen
KRWKorean Won
MYRMalaysian Ringgit
MXNMexican Peso
NZDNew Zealand Dollar
NOKNorwegian Krone
PENPeruvian Neuvo Sol
PHPPhilippine Peso
PLNPolish Zloty
RONRomanian Leu
RUBRussian Ruble
SARSaudi Riyal
SGDSingapore Dollar
ZARSouth African Rand
SEKSwedish Krona
CHFSwiss Franc
TWDTaiwan New Dollar
THBThai Baht
TRYTurkish Lira
UAHUkrainian Hryvnia
USDUS Dollar

Customer Order Handling Instruction - CustomerOrderHandlingInstruction

ValueNameDescription
ALGORITHM_ENGINEAlgorithm Engine
CLIENT_ELECTRONICClient Electronic
CLIENT_PITClient Pit
CLIENT_PLATFORM_DIRECTClient Provided Platform Direct to Exchange
CLIENT_PLATFORM_FCMClient Provided Platform Controlled by FCM
DESK_ELECTRONICDesk Electronic
DESK_PITDesk Pit
FCM_APIFCM API or FIX
FCM_PROVIDED_SCREENFCM Provided Screen
OTHER_PROVIDED_SCREENOther Provided Screen
PHONE_COMPLEXPhone Complex
PHONE_SIMPLEPhone Simple
PRICE_AT_EXECUTIONPrice at Execution

Customer Type - CustomerType

ValueNameDescription
MEMBER_OWNMember Own

Applies to orders entered or trades executed by an individual member for their own account, for an account they controls, or for an account in which they have an ownership or financial interest. However, transactions initiated and executed by a member for the proprietary account of a member firm must be designated as Member Other Member transactions.

MEMBER_PROPRIETARYMember Proprietary

Applies to orders entered or trades executed for the proprietary accounts of a member firm, including Rule 106.H., I., N., R. and S. firms.

ON_BEHALF_INDIVIDUALOn-Behalf Individual

Applies to orders entered by a member or a nonmember terminal operator for the account of another individual member or an account controlled by such individual member.

OTHEROther

Applies to all orders and transactions not included in any of the defined categories. These typically are orders entered by or on behalf of nonmember entities.

Heartbeat Status - HeartbeatStatus

ValueNameDescription
CONNECTEDConnected
DISCONNECTEDDisconnected
MISSED_HEARTBEATMissed Heartbeat

Market Side Indicator - MarketSideIndicator

ValueNameDescription
BUYBuy

Identifies a buy side order

CROSSCross
SELLSell

Identifies a sell side order

Message Type - MessageType

ValueNameDescription
BIZRJBusiness Reject
HEARTBEATHeartbeat
INSTNEWInstrument New
INSTNEWRJInstrument New
INSTSTSInstrument Status
ORDCXLOrder Cancel
ORDCXLMMass Order Cancel
ORDCXLMRJMass Order Cancel Reject
ORDCXLRJOrder Cancel Reject
ORDMODOrder Modify
ORDMODRJOrder Modify Reject
ORDNEWOrder New
ORDNEWRJOrder New Reject
ORDSTSOrder Status
ORDSTSRJOrder Status Reject
QTENEWQuote New
QTERJQuote Reject
QTESTSQuote Status
TRDRJTrade Search
TRDQTrade Search
TRDRTrade Response

Order Action - OrderAction

ValueNameDescription
CANCELCancel
CANCEL_MASSMass Cancel
EXPIREDExpired
MODIFYModify
NEWNew
STATUSStatus
TRADETrade

Order Cancel Reason - OrderCancelReason

ValueNameDescription
AGGRESSIVE_SELF_MATCHAggressive Self-Match
CREDIT_CONTROLCredit Control
DISCONNECTDisconnect
EXCHANGEExchange
MINIMUM_QUANTITYMinimum Quantity
NOT_BESTNot Best
RESTING_SELF_MATCHResting Self-Match
RISK_MANAGEMENTRisk Management

Order Duration Type - OrderDurationType

ValueNameDescription
DAYDay

Order expires at the end of the trading day.

FILL_AND_KILLFill and Kill

Order is immediately executed against any available quantity and any remaining quantity is eliminated

FILL_OR_KILLFill or Kill

Order is filled completely or else eliminated

GOOD_TILL_CANCELGood till Cancel

Order remains working until cancelled

GOOD_TILL_DATEGood till Date

Order remains working until the end of the trading session of the local market date specified in the ExpirationDate field.

Order Entity Scope - OrderEntityScope

ValueNameDescription
CUSTOMER_ACCOUNTCustomer Account
OPERATOROperator

Order Duration Type - OrderFillReason

ValueNameDescription
AGGRESSORAggressor
COVERINGCovering
CROSS_BPMCross Better PRice Match
CROSS_BMGCross Broker Match Guarantee
FIFOFirst In First Out
FIFO_PERCENTFirst In First Out Percent
FUTURE_HEDGEFuture Hedge
IMPLIED_OPENINGImplied Opening
INSTITUTIONAL_PRIORITIZATIONInstitutional Prioritization
LEAD_MARKET_MAKERLead Market Maker
LEGLeg
LEVELINGLeveling
OPENINGOpening
PRICE_DISCRETIONPrice Discretion
PRO_RATAPro Rata
TOPTop Order Status

Order Instrument Scope - OrderInstrumentScope

ValueNameDescription
ALLAll
INSTRUMENTInstrument
MARKET_SEGMENTMarket Segment
PRODUCT_GROUPProduct Group

Order Status - OrderStatus

ValueNameDescription
CANCELEDCanceled
EXPIREDExpired
FILLEDFilled
NEWNew
PARTIALLY_FILLEDPartially Filled
PARTIALPartial
REJECTEDRejected
REPLACEDReplaced
UNDEFINEDUndefined

Order Type - OrderType

ValueNameDescription
LIMITLimit

A Limit order defines the upper price limit at which to buy an instrument and lower price limit at which to sell an instrument. The price limit is defined in the Price field. If the price is not immediately available, the Limit order will rest until filled or cancelled.

MARKETMarket

A Market order with protection is filled within a pre-defined range of prices referred to as the protected range. For buy orders, protection points are added to the current best offer price to calculate the protection price limit. For sell orders, protection points are subtracted from the current best bid price.

MARKET_TO_LIMITMarket to Limit

A Market-limit order is executed at the best price available in the market. If the market-limit order can only be partially filled, the order becomes a limit order and the remaining quantity remains on the order book at the specified limit price.

STOPStop

A Stop order is an order which, when accepted, does not immediately go on the book, but must be "triggered" by a trade in the market at the price level submitted with the order. A Stop order goes on the book as a Market order once triggered.

STOP_LIMITStop Limit

A Stop order is an order which, when accepted, does not immediately go on the book, but must be "triggered" by a trade in the market at the price level submitted with the order. A Stop-Limit order goes on the book as a Limit order once triggered.

Origin Type - OriginType

ValueNameDescription
CUSTOMERCustomer
HOUSEHouse

Security Type - SecurityType

ValueNameDescription
FUTFuture
MLEGMulti-Leg
OPTOption

Self-Match Prevention Instruction - SelfMatchPreventionInstruction

ValueNameDescription
CANCEL_NEWESTCancel Newest
CANCEL_OLDESTCancel Oldest

Spread Report Type - SpreadReportType

ValueNameDescription
LEGLeg of Spread
OUTRIGHTOutright
SPREADSpread

Strategy Request Type - StrategyRequestType

ValueNameDescription
COMBOCombination
COVEREDCovered

Yes-No Indicator - YesNoIndicator

ValueNameDescription
NONo

No

YESYes

Yes

  • No labels