price to a value between 0 and 1 for a limit order, or leave it null to execute at the current market price.
Endpoint
Authentication
This endpoint requires HMAC authentication. Include the
Key, Timestamp, and HMAC headers on every request. See the authentication guide for signing instructions.Headers
string
Optional. A unique value chosen by the client for a logical operation. Replaying the same
POST with the same key and the same JSON body returns the stored response without creating a duplicate order. A different body (for example, a new price) produces a different fingerprint, so requoting is not blocked.Request
integer
required
The market (outcome) ID to place the order on.
string
required
Order side. Use
bid to purchase shares or ask to sell shares.string
required
Currency for the order. One of
USDC, USDT, USD, or OOM.number
Limit price expressed as a probability between 0 and 1. Set to
null to place a market order that executes immediately at the best available price.Number of shares to buy or sell.
number
Total cost of the order in currency units. Used for validation against
shares and price. Optional if shares is provided.string
Position direction. Use
long to bet in favor of the outcome, or short to bet against it.string
ISO 8601 datetime at which an unfilled or partially filled limit order is automatically canceled. Set to
null for no expiration.boolean
default:"false"
When
true, any existing open orders that conflict with this order are canceled before the new order is placed.Response
Returns201 Created with the newly created order object.
integer
required
Unique ID of the created order.
integer
required
Market (outcome) ID the order is placed on.
string
required
Order side:
bid or ask.string
required
Currency used:
USDC, USDT, USD, or OOM.number
Limit price between 0 and 1, or
null for a market order.Number of shares in the order.
number
Cost of the order in currency units.
string
Position direction:
long or short.string
required
Initial order status. Typically
open or processing immediately after creation.string
Expiration datetime, or
null if no expiration is set.string
required
ISO 8601 datetime when the order was created.
Error codes
Example
Sample response (201 Created)