Skip to main content
POST
Create order

Authorizations

Authorization
string
header
required

An API key from your account: Authorization: Bearer udk_<live|test>_<id>_<secret>.

Body

application/json
market_ticker
string
required

Market ticker (one window of a series), e.g. "btc-15m-261002-1400-1415". Opaque.

Pattern: ^[a-z0-9][a-z0-9-]{0,63}-\d{6}-\d{4}-\d{4}(d\d{1,2})?$
outcome
enum<string>
required
Available options:
up,
down
action
enum<string>
required
Available options:
buy,
sell
price
string
required

Contract price in dollars, "0.01"–"0.99" (v1: whole cents).

Pattern: ^0\.(0[1-9]|[1-9]\d)$
count
string
required

Contracts, as a string (v1: whole contracts).

Pattern: ^(0|[1-9]\d*)$
client_order_id
string
required

Your id for the order, unique per account. Retrying with the same id never places a second order.

Pattern: ^[A-Za-z0-9._:-]{1,64}$
time_in_force
enum<string>
default:good_till_canceled

good_till_canceled: what doesn't fill rests on the book until it fills, you cancel it or the window closes. immediate_or_cancel: fills what it can now; the rest is cancelled.

Available options:
good_till_canceled,
immediate_or_cancel
post_only
boolean
default:false

Response

The order, as the book holds it after this call.

order
object
required