Skip to main content
POST
Insert order

Body

application/json
type
enum<string>

OrderType indicates the type of an order.

Available options:
ORDER_TYPE_MARKET_TO_LIMIT,
ORDER_TYPE_LIMIT,
ORDER_TYPE_STOP,
ORDER_TYPE_STOP_LIMIT
side
enum<string>

Side indicates the side of an Order.

Available options:
SIDE_BUY,
SIDE_SELL
orderQty
string<int64>
symbol
string
price
string<int64>
timeInForce
enum<string>

TimeInForce specifies how long the order remains in effect.

Available options:
TIME_IN_FORCE_DAY,
TIME_IN_FORCE_GOOD_TILL_CANCEL,
TIME_IN_FORCE_IMMEDIATE_OR_CANCEL,
TIME_IN_FORCE_GOOD_TILL_TIME,
TIME_IN_FORCE_FILL_OR_KILL
clordId
string
account
string
stopPrice
string<int64>
minQty
string<int64>
selfMatchPreventionId
string
quote
string
allOrNone
boolean
sessionId
string
user
string
clientAccountId
string
clientParticipantId
string
participateDontInitiate
boolean
cashOrderQty
string<int64>
strictLimit
boolean

Set if this particular order must be filled at the exact limit price.

goodTillTime
string<date-time>
bestLimit
boolean

A flag for best limit pricing. Sets the limit order's price to the top of the book on the same side as the order.

immediatelyExecutableLimit
boolean

A flag for immediately executable limit pricing. Sets the price to the top of the book on the opposing side, so it can immediately match.

selfMatchPreventionInstruction
enum<string>

SelfMatchPreventionInstruction is the methodology used to handle self match prevention.

Available options:
SELF_MATCH_PREVENTION_INSTRUCTION_REJECT_AGGRESSOR,
SELF_MATCH_PREVENTION_INSTRUCTION_CANCEL_RESTING,
SELF_MATCH_PREVENTION_INSTRUCTION_REMOVE_BOTH
orderCapacity
enum<string>

OrderCapacity designates the capacity of the party placing an order.

Available options:
ORDER_CAPACITY_AGENCY,
ORDER_CAPACITY_PRINCIPAL,
ORDER_CAPACITY_PROPRIETARY,
ORDER_CAPACITY_INDIVIDUAL,
ORDER_CAPACITY_RISKLESS_PRINCIPAL,
ORDER_CAPACITY_AGENT_FOR_OTHER_MEMBER
ignorePriceValidityChecks
boolean
manualOrderIndicator
enum<string>

ManualOrderIndicator designates the manual or automated nature of an order.

Available options:
MANUAL_ORDER_INDICATOR_MANUAL,
MANUAL_ORDER_INDICATOR_AUTOMATED

Response

200 - application/json

A successful response.

orderId
string