Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

Body

application/json
isBuy
boolean
required
ownerPubkey
string

Order owner public key

marketId
string

Hashed or canonical market ID for buys

Minimum string length: 1
positionPubkey
string

Required for sells

Minimum string length: 32
isYes
boolean
contracts

Legacy whole-contract sell quantity (only when isBuy is false). Cannot express fractions; prefer contractsMicro or contractsDecimal. Provide only one of contracts, contractsMicro, or contractsDecimal.

contractsMicro

Exact sell quantity in micro-contract units (1000000 = 1 contract). Provide only one of contracts, contractsMicro, or contractsDecimal.

contractsDecimal

Exact sell quantity as a decimal (e.g. 5.777773). Provide only one of contracts, contractsMicro, or contractsDecimal.

depositAmount

Amount must conform to the token decimals used by the token mint in depositMint

depositMint
string
default:EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v

Mint address for the deposit token

Response

Unsigned transaction for creating an order

transaction
string | null
required

Base64 encoded transaction

txMeta
object | null
required

Transaction metadata

externalOrderId
string | null
required
order
object
required
requiredSigners
string[]

Public keys that must sign the returned transaction

execution
object

Execution details returned with an order build. Sign the build's transaction, then pass context unchanged to POST /execute.

executionModel
string | null

Execution model for the order. atomic_swap for Jupiter Forecast (bisonfi) orders, which execute as a single atomic swap through POST /execute. null for keeper-filled prediction orders.

settlement
string | null

Settlement mode. auto for Jupiter Forecast orders, which settle automatically. null for keeper-filled prediction orders.

jupiterSwapRequestId
string | null

Jupiter swap request id when the order executes as a swap (Jupiter Forecast). null otherwise.