Skip to main content
POST
Create Boost

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
stake
string
required

Dollars, as a string — up to two decimals.

Pattern: ^(0|[1-9]\d*)(\.\d{1,2})?$
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}$
kind
string
default:boost
Allowed value: "boost"
expected_max_payout
string

Dollars, as a string — up to two decimals.

Pattern: ^(0|[1-9]\d*)(\.\d{1,2})?$
expected_price
string

Contract price in dollars: "0.01"–"0.99" (whole cents), or "0.001"–"0.099" / "0.901"–"0.999" on a tapered_deci_cent market (see price_ranges).

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

Response

The order.

boost
object
required