Create Order

Request an unsigned transaction to create a new order

POST /orders

cURL

cURL

curl --request POST \
  --url https://api.jup.ag/prediction/v1/orders \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "isBuy": true,
  "ownerPubkey": "<string>",
  "marketId": "<string>",
  "positionPubkey": "<string>",
  "isYes": true,
  "contracts": "<string>",
  "depositAmount": "<string>",
  "depositMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
}
'

200

{
  "transaction": "<string>",
  "txMeta": {
    "blockhash": "<string>",
    "lastValidBlockHeight": 1
  },
  "externalOrderId": "<string>",
  "order": {
    "orderPubkey": "<string>",
    "orderAtaPubkey": "<string>",
    "userPubkey": "<string>",
    "marketId": "<string>",
    "marketIdHash": "<string>",
    "positionPubkey": "<string>",
    "isBuy": true,
    "isYes": true,
    "contracts": "<string>",
    "newContracts": "<string>",
    "maxBuyPriceUsd": "<string>",
    "minSellPriceUsd": "<string>",
    "externalOrderId": "<string>",
    "orderCostUsd": "<string>",
    "newAvgPriceUsd": "<string>",
    "newSizeUsd": "<string>",
    "newPayoutUsd": "<string>",
    "estimatedProtocolFeeUsd": "<string>",
    "estimatedVenueFeeUsd": "<string>",
    "estimatedTotalFeeUsd": "<string>"
  }
}

Authorizations

x-api-key · string · header · required

Get API key via https://portal.jup.ag

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 · string number

Number of contracts to sell (only applicable when isBuy is false)

depositAmount · string number

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

200

application/json

Unsigned transaction for creating an order

transaction · string | null · required

Base64 encoded transaction

txMeta · object · required

Transaction metadata

Show child attributes

externalOrderId · string | null · required

order · object · required

Show child attributes