Skip to main content

An OrderWithMarket, plus original_buy on an executed, filled sell.

id
string
required

The order id (prefix ord_), as order_id was returned when you placed it.

Example:

"ord_6aedec658f3a61c2d94e07b5a1c6e2d9"

side
enum<string>
required

The side as Splash routes the order to the exchange. Every order is recorded against the YES contract, so this is yes; read splash_side for the side you traded. See Order sides.

Available options:
yes,
no
Example:

"yes"

yes_price
number
required

Price per contract in YES terms, up to 4 decimal places. Until the order fills it is your limit price expressed as a YES price; once it fills, the average fill price. Always yes_price + no_price = 1.

Example:

0.585

no_price
number
required

The same price in NO terms: 1 - yes_price. On a NO buy this is what you paid per contract, before fees.

Example:

0.415

quantity
integer
required

Contracts requested.

Example:

10

status
enum<string>
required

pending while queued or in flight, then executed (filled) or cancelled (not filled, or refused). A fill-or-kill order is never resting. See Order statuses.

Available options:
pending,
executed,
cancelled,
resting
Example:

"executed"

fill_cost
number
required

Buys: dollars paid for the filled contracts, before fees, up to 4 decimal places. 0 on a sell and until the order fills.

Example:

5.85

updated_at
integer<int64>
required

When the order last changed. Epoch milliseconds.

Example:

1793977446412

created_at
integer<int64>
required

When the order was recorded. Epoch milliseconds.

Example:

1793977445000

remaining_quantity
integer
required

Contracts not filled. Equals quantity until the exchange reports on the order.

Example:

0

fill_quantity
integer
required

Contracts filled. 0 until the order fills; equal to quantity on an executed fill-or-kill order.

Example:

10

fees
number
required

Total fees on the order, Splash's and the exchange provider's, in dollars rounded to cents. Charged on top of a buy and out of a sell's proceeds. Before the fill it holds only Splash's quoted fee.

Example:

0.12

action
enum<string>
required

Buy or sell of the YES contract, as routed to the exchange: a YES buy or a NO close is buy, a NO buy or a YES close is sell. Read splash_action for what you did. See Order actions.

Available options:
buy,
sell
Example:

"buy"

splash_action
enum<string>
required

What you did: buy opens or adds to a position, sell closes it. See Order actions.

Available options:
buy,
sell
Example:

"buy"

proceeds
number
required

Sells: dollars received for the filled contracts, before fees, up to 4 decimal places. 0 on a buy and until the order fills.

Example:

0

splash_side
enum<string>
required

The side you traded: the side you bought on a buy, the side you sold on a sell. See Order sides.

Available options:
yes,
no
Example:

"yes"

trade_price
number
required

Your all-in price per contract, up to 4 decimal places: on a buy (fill_cost + fees) / fill_quantity, on a sell (proceeds - fees) / fill_quantity. 0 until the order fills.

Example:

0.597

proceeds_minus_fees
number
required

Sells: proceeds - fees, the dollars credited to you, rounded to cents. 0 on a buy.

Example:

0

fill_cost_plus_fees
number
required

Buys: fill_cost + fees, the dollars debited from you, rounded to cents. 0 on a sell.

Example:

5.97

request_id
string
required

The request_id the order was placed with.

Example:

"3f1c2a9e-5b7d-4e0a-9c1d-8a6b2e4f7d10"

time_in_force
enum<string>
required

FOK (fill or kill). Every order today is fill-or-kill. See Time in force.

Available options:
FOK,
IOC
Example:

"FOK"

realized_pnl
number
required

Profit or loss this order locked in, in dollars after all fees, rounded to cents. Only an executed sell realizes any: its proceeds net of fees minus the cost plus fees of the bought contracts it closed, oldest first. 0 on a buy and on an order that did not execute.

Example:

0

market_id
string
required

The market the order is on.

Example:

"pm_6ae1e3c09e1d4c7a2b5f80e3d6a9c412"

market
Market · object
required

The market as it stands now (current prices and status), not as it was when you ordered.

Example:
market_title
string
required

A one-line description of the bet from your side: game, then the pick, e.g. KC @ BUF • Chiefs to win or KC @ BUF • Under 47.5 points. Empty when it cannot be built.

Example:

"KC @ BUF • Chiefs to win"

executed_at
integer<int64>

When the order executed. Epoch milliseconds. Absent until it does.

Example:

1793977446412

original_buy
OriginalBuy · object

Executed, filled sells only: the opening buys of the position cycle this sell closed. Absent otherwise. It covers the whole opening buys, while realized_pnl covers only the contracts this sell closed.

Example: