Sign in

v3

OpenAPI 3.0.02026-07-31103181312.8 KB
orders

Create Order (V2)

Endpoint for submitting event-market orders using the V2 request/response shape (single-book bid/ask side and fixed-point dollar prices). The legacy /portfolio/orders endpoint will be deprecated no earlier than May 6, 2026 — clients should migrate to this path.

post/portfolio/events/orders

Request body

tickerstring required
client_order_idstring
side'bid' | 'ask' required

Side of the book for an order or trade. For event markets, this refers to the YES leg only: bid means buy YES, ask means sell YES. (Selling YES is economically equivalent to buying NO at 1 - price, but this endpoint quotes everything from the YES side.)

countstring required

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

pricestring required

US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market's price level structure.

expiration_timeinteger

Optional Unix timestamp in seconds for when the order expires. To place an expiring order, set time_in_force to good_till_canceled and provide this expiration_time. GTT is an internal execution type and is not a valid API value for time_in_force. The immediate_or_cancel time-in-force value cannot be combined with expiration_time.

time_in_force'fill_or_kill' | 'good_till_canceled' | 'immediate_or_cancel' required

Specifies how long the order remains active. Use good_till_canceled with expiration_time for an order that should rest until a specific expiration time; without expiration_time, good_till_canceled is a true good-till-canceled order. GTT is not a valid API value.

post_onlyboolean
self_trade_prevention_type'taker_at_cross' | 'maker' required

The self-trade prevention type for orders. taker_at_cross cancels the taker order when it would trade against another order from the same user; execution stops and any partial fills already matched are executed. maker cancels the resting maker order and continues matching.

cancel_order_on_pauseboolean

If this flag is set to true, the order will be canceled if the order is open and trading on the exchange is paused for any reason.

reduce_onlyboolean

Specifies whether the order place count should be capped by the member's current position.

subaccountinteger

The subaccount number to use for this order. 0 is the primary subaccount. Subaccount-restricted API keys must omit this field or pass their locked subaccount.

order_group_idstring

The order group this order is part of

exchange_indexinteger

Identifier for an exchange shard. Defaults to 0 if unspecified.

Example request

{
  "ticker": "HIGHNY-24JAN01-T60",
  "client_order_id": "8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1",
  "side": "bid",
  "count": "10.00",
  "price": "0.5600",
  "time_in_force": "good_till_canceled",
  "self_trade_prevention_type": "taker_at_cross",
  "post_only": false,
  "cancel_order_on_pause": false,
  "reduce_only": false,
  "subaccount": 0,
  "exchange_index": 0
}

Response

Order created successfully

order_idstring required
client_order_idstring
fill_countstring required

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

remaining_countstring required

Fixed-point contract count string (2 decimals, e.g., "10.00"; referred to as "fp" in field names). Requests accept 0-2 decimal places (e.g., "10", "10.0", "10.00"); responses always emit 2 decimals. Fractional contract values (e.g., "2.50") are supported; the minimum granularity is 0.01 contracts.

average_fill_pricestring

US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market's price level structure.

average_fee_paidstring

US dollar amount as a fixed-point decimal string with up to 6 decimal places of precision. This is the maximum supported precision; valid quote intervals for a given market are constrained by that market's price level structure.

ts_msinteger required

Matching engine timestamp at which the order was processed, as Unix epoch milliseconds.

Example response

{
  "order_id": "3b23c1c7-f4ef-4f0d-8b9a-9e53c61f1a0d",
  "client_order_id": "8c35ecb3-328f-4f52-8c7c-0f4b9862f8d1",
  "fill_count": "0.00",
  "remaining_count": "10.00",
  "ts_ms": 1715793600123
}