Skip to main content
POST

Body

application/json
outcomeId
string
required

The server-generated UUID of the outcome for which the order will increase exposure

Example:

"123e4567-e89b-12d3-a456-426614174000"

price
number
required

The price of the order in decimal probability, up to 3 decimal places

Example:

0.667

qty
number
required

The number of minimal currency units for the order. Note that this must be a positive integer. For CASH orders, 1 unit = 0.01 Novig Cash (e.g., 100 units = 1.00 Cash). For COIN orders, 1 unit = 1 Novig Coin

Example:

110

currency
string
required

Denomination of the order, i.e. CASH or COIN

Example:

"CASH"

tif
string
required

GTC, GTT, IOC, FOK, or PO (default is GTC). PO (post only) rejects the order instead of matching it immediately as a taker, so it only ever rests as a maker order.

Example:

"GTC"

ttl
number

Time to live for the order (milliseconds) after which the order will be automatically canceled if not totally filled. Required under GTT time-in-force; optional under PO, where it self-expires if provided and otherwise rests until canceled

Example:

2400

flags
string

Custom 8-character string field for storing trader-specified flags or metadata about the order

Maximum string length: 8
Example:

"ABC12345"

Response

We booked every order.

id
string

The unique identifier of the order

Example:

"123e4567-e89b-12d3-a456-426614174002"

outcomeId
string

The ID of the outcome associated with this order

Example:

"123e4567-e89b-12d3-a456-426614174000"

marketId
string

The ID of the market associated with this order

Example:

"123e4567-e89b-12d3-a456-426614174003"

price
number

The limit price at which the order is placed

Example:

0.125

qty
number

The remaining quantity of the order, denominated in Minimum Currency Units

Example:

4200

originalQty
number

The original quantity of the order, denominated in Minimum Currency Units

Example:

4200

currency
string

The currency in which the order is denominated

Example:

"COIN"

timestamp
string

The timestamp when the order was placed

Example:

"2023-10-05T12:00:00Z"

status
string

The current status of the order

Example:

"FILLED"

flags
string

The trader-specified metadata associated with the order

Example:

"ABC12345"