Skip to main content
POST
Create order

Body

application/json

Request to create a new order

market_slug
string
required

Market slug to place order in

intent
enum<integer>
required

Intent of the order: 1 = BUY_YES, 2 = SELL_YES, 3 = BUY_NO, 4 = SELL_NO

Available options:
1,
2,
3,
4
type
enum<integer>

Type of order: 1 = LIMIT, 2 = MARKET

Available options:
1,
2
price
object

Order price (required for limit orders)

quantity
number<double>

Order quantity in shares

tif
enum<integer>

Time in force: 1 = GTC (Good Till Cancel), 2 = GTD (Good Till Date), 3 = IOC (Immediate or Cancel), 4 = FOK (Fill or Kill)

Available options:
1,
2,
3,
4
participateDontInitiate
boolean

If true, order must rest on book (maker only)

goodTillTime
string

Expiration time for GTD orders

cashOrderQty
object

Order quantity in cash (for market orders)

manualOrderIndicator
enum<integer>

Indicates whether the order was placed manually or automatically: 1 = MANUAL, 2 = AUTOMATIC

Available options:
1,
2
synchronousExecution
boolean

If true, wait for order execution before returning

maxBlockTime
string<int64>

Max wait time in seconds for synchronous execution

Response

Order created successfully

id
string

Created order ID

executions
object[]

Executions if synchronous execution was requested