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>",
  "contractsMicro": "<string>",
  "contractsDecimal": "<string>",
  "depositAmount": "<string>",
  "depositMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
}
'

import requests

url = "https://api.jup.ag/prediction/v1/orders"

payload = {
    "isBuy": True,
    "ownerPubkey": "<string>",
    "marketId": "<string>",
    "positionPubkey": "<string>",
    "isYes": True,
    "contracts": "<string>",
    "contractsMicro": "<string>",
    "contractsDecimal": "<string>",
    "depositAmount": "<string>",
    "depositMint": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    isBuy: true,
    ownerPubkey: '<string>',
    marketId: '<string>',
    positionPubkey: '<string>',
    isYes: true,
    contracts: '<string>',
    contractsMicro: '<string>',
    contractsDecimal: '<string>',
    depositAmount: '<string>',
    depositMint: 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'
  })
};

fetch('https://api.jup.ag/prediction/v1/orders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.jup.ag/prediction/v1/orders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'isBuy' => true,
    'ownerPubkey' => '<string>',
    'marketId' => '<string>',
    'positionPubkey' => '<string>',
    'isYes' => true,
    'contracts' => '<string>',
    'contractsMicro' => '<string>',
    'contractsDecimal' => '<string>',
    'depositAmount' => '<string>',
    'depositMint' => 'EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.jup.ag/prediction/v1/orders"

	payload := strings.NewReader("{\n  \"isBuy\": true,\n  \"ownerPubkey\": \"<string>\",\n  \"marketId\": \"<string>\",\n  \"positionPubkey\": \"<string>\",\n  \"isYes\": true,\n  \"contracts\": \"<string>\",\n  \"contractsMicro\": \"<string>\",\n  \"contractsDecimal\": \"<string>\",\n  \"depositAmount\": \"<string>\",\n  \"depositMint\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.jup.ag/prediction/v1/orders")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"isBuy\": true,\n  \"ownerPubkey\": \"<string>\",\n  \"marketId\": \"<string>\",\n  \"positionPubkey\": \"<string>\",\n  \"isYes\": true,\n  \"contracts\": \"<string>\",\n  \"contractsMicro\": \"<string>\",\n  \"contractsDecimal\": \"<string>\",\n  \"depositAmount\": \"<string>\",\n  \"depositMint\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.jup.ag/prediction/v1/orders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"isBuy\": true,\n  \"ownerPubkey\": \"<string>\",\n  \"marketId\": \"<string>\",\n  \"positionPubkey\": \"<string>\",\n  \"isYes\": true,\n  \"contracts\": \"<string>\",\n  \"contractsMicro\": \"<string>\",\n  \"contractsDecimal\": \"<string>\",\n  \"depositAmount\": \"<string>\",\n  \"depositMint\": \"EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v\"\n}"

response = http.request(request)
puts response.read_body

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>",
    "contractsMicro": "<string>",
    "contractsDecimal": "<string>",
    "newContractsMicro": "<string>",
    "newContractsDecimal": "<string>",
    "payoutUsd": "<string>",
    "slippageBps": 1,
    "maxSlippageBps": 1
  },
  "requiredSigners": [
    "<string>"
  ],
  "execution": {
    "endpoint": "/api/v1/execute",
    "context": {}
  },
  "executionModel": "<string>",
  "settlement": "<string>",
  "jupiterSwapRequestId": "<string>"
}

{
  "message": "<string>",
  "request_id": "<string>",
  "code": "<string>",
  "param": "<string>",
  "doc_url": "<string>"
}

Authorizations

x-api-key · string · header · required

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

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

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

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

contractsDecimal · string number

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

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 | null · required

Transaction metadata

Show child attributes

externalOrderId · string | null · required

order · object · required

Show child attributes

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.

Show child attributes

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.