Sign in

v1

latestOpenAPI 3.0.12026-07-2683220192.3 KB
Orders

Create Order

Create a new order to enter into a market

post/v1/orders

Request body

marketSlugstring required

Unique market slug into which the order should be entered

type'ORDER_TYPE_MARKET_TO_LIMIT' | 'ORDER_TYPE_LIMIT' | 'ORDER_TYPE_STOP' | 'ORDER_TYPE_STOP_LIMIT'

OrderType indicates the type of an order.

quantitynumber double

Order quantity in contracts. Supports decimal quantities on markets whose minimumTradeQty is less than 1.

tif'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'

TimeInForce specifies how long the order remains in effect.

participateDontInitiateboolean

If true, order must rest on the book prior to matching (maker only). Order will be rejected if it would immediately match.

goodTillTimestring

Expiration time for orders with TIME_IN_FORCE_GOOD_TILL_DATE

intent'ORDER_INTENT_BUY_LONG' | 'ORDER_INTENT_SELL_LONG' | 'ORDER_INTENT_BUY_SHORT' | 'ORDER_INTENT_SELL_SHORT'

Intent of the order. ORDER_INTENT_BUY_LONG = Buy YES contracts, ORDER_INTENT_SELL_LONG = Sell YES contracts, ORDER_INTENT_BUY_SHORT = Buy NO contracts, ORDER_INTENT_SELL_SHORT = Sell NO contracts.

outcomeSide'OUTCOME_SIDE_YES' | 'OUTCOME_SIDE_NO'

Outcome side of the market (YES = long, NO = short).

action'ORDER_ACTION_BUY' | 'ORDER_ACTION_SELL'

Order action (BUY or SELL).

manualOrderIndicator'MANUAL_ORDER_INDICATOR_MANUAL' | 'MANUAL_ORDER_INDICATOR_AUTOMATED'

ManualOrderIndicator designates the manual or automated nature of an order.

synchronousExecutionboolean

If true, will block until the order is filled, rejected, canceled, or expired, up to maxBlockTime seconds

maxBlockTimestring int64

Maximum block time in seconds if synchronous execution is requested

Example request

{
  "price": {
    "value": "123.45"
  },
  "cashOrderQty": {
    "value": "123.45"
  },
  "slippageTolerance": {
    "currentPrice": {
      "value": "123.45"
    }
  }
}

Response

Order created successfully

idstring

Exchange-assigned order ID