Get Order (Prediction API)

Get order

curl --request GET \
  --url https://api.jup.ag/prediction/v1/orders/{orderPubkey} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jup.ag/prediction/v1/orders/{orderPubkey}', 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/{orderPubkey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "pubkey": "<string>",
  "owner": "<string>",
  "ownerPubkey": "<string>",
  "market": "<string>",
  "marketId": "<string>",
  "marketIdHash": "<string>",
  "eventId": "<string>",
  "position": "<string>",
  "status": "pending",
  "isYes": true,
  "isBuy": true,
  "createdAt": 123,
  "updatedAt": 123,
  "contracts": "<string>",
  "maxFillPriceUsd": "<string>",
  "maxBuyPriceUsd": "<string>",
  "minSellPriceUsd": "<string>",
  "filledAt": 123,
  "filledContracts": "<string>",
  "avgFillPriceUsd": "<string>",
  "settled": true,
  "orderId": "<string>",
  "sizeUsd": "<string>",
  "eventMetadata": {
    "eventId": "<string>",
    "title": "<string>",
    "subtitle": "<string>",
    "slug": "<string>",
    "series": "<string>",
    "closeTime": "<string>",
    "imageUrl": "<string>",
    "isLive": true
  },
  "marketMetadata": {
    "marketId": "<string>",
    "eventId": "<string>",
    "title": "<string>",
    "subtitle": "<string>",
    "description": "<string>",
    "provider": "<string>",
    "status": "<string>",
    "result": "<string>",
    "closeTime": 123,
    "openTime": 123,
    "isTeamMarket": true,
    "marketOptions": [
      {
        "label": "<string>",
        "buyYes": true
      }
    ],
    "rulesPrimary": "<string>",
    "rulesSecondary": "<string>"
  },
  "externalOrderId": "<string>",
  "bump": 1
}

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

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

GET

orders

{orderPubkey}

Get order

curl --request GET \
  --url https://api.jup.ag/prediction/v1/orders/{orderPubkey} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.jup.ag/prediction/v1/orders/{orderPubkey}', 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/{orderPubkey}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

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

{
  "pubkey": "<string>",
  "owner": "<string>",
  "ownerPubkey": "<string>",
  "market": "<string>",
  "marketId": "<string>",
  "marketIdHash": "<string>",
  "eventId": "<string>",
  "position": "<string>",
  "status": "pending",
  "isYes": true,
  "isBuy": true,
  "createdAt": 123,
  "updatedAt": 123,
  "contracts": "<string>",
  "maxFillPriceUsd": "<string>",
  "maxBuyPriceUsd": "<string>",
  "minSellPriceUsd": "<string>",
  "filledAt": 123,
  "filledContracts": "<string>",
  "avgFillPriceUsd": "<string>",
  "settled": true,
  "orderId": "<string>",
  "sizeUsd": "<string>",
  "eventMetadata": {
    "eventId": "<string>",
    "title": "<string>",
    "subtitle": "<string>",
    "slug": "<string>",
    "series": "<string>",
    "closeTime": "<string>",
    "imageUrl": "<string>",
    "isLive": true
  },
  "marketMetadata": {
    "marketId": "<string>",
    "eventId": "<string>",
    "title": "<string>",
    "subtitle": "<string>",
    "description": "<string>",
    "provider": "<string>",
    "status": "<string>",
    "result": "<string>",
    "closeTime": 123,
    "openTime": 123,
    "isTeamMarket": true,
    "marketOptions": [
      {
        "label": "<string>",
        "buyYes": true
      }
    ],
    "rulesPrimary": "<string>",
    "rulesSecondary": "<string>"
  },
  "externalOrderId": "<string>",
  "bump": 1
}

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

{
  "type": "invalid_request_error",
  "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

Path Parameters

orderPubkey

string

required

Order account public key

Minimum string length: 1

Response

Order data

pubkey

string

required

Order account public key

owner

string

required

Order owner public key

ownerPubkey

string

required

Order owner public key (alias of owner, use ownerPubkey when available)

market

string

required

Associated market public key

marketId

string

required

External market identifier used to derive the PDA

marketIdHash

string

required

Hashed market identifier used for on-chain PDAs

eventId

string

required

External event identifier

position

string

required

Associated position public key

status

enum<string>

required

Current order status

Available options:

pending,

filled,

failed

isYes

boolean

required

True when order is for the YES side

isBuy

boolean

required

True when order is a buy order

createdAt

integer

required

Unix timestamp (seconds) when the order was created

updatedAt

integer

required

Unix timestamp (seconds) when the order last changed on-chain

contracts

string

required

Number of contracts (u64 as string)

maxFillPriceUsd

string

required

Maximum fill price in micro USD (u64 as string)

maxBuyPriceUsd

string | null

required

Buyer-specified max fill price (micro USD)

minSellPriceUsd

string | null

required

Seller-specified min fill price (micro USD)

filledAt

integer

required

Unix timestamp (seconds) when the order was filled (0 when pending)

filledContracts

string

required

Number of filled contracts (u64 as string)

avgFillPriceUsd

string

required

Average fill price in micro USD (u64 as string)

settled

boolean

required

Whether the order has been settled on-chain

orderId

string

required

External order identifier from the venue

sizeUsd

string

required

Order notional in micro USD (u128 as string)

eventMetadata

object

required

Show child attributes

marketMetadata

object

required

Show child attributes

externalOrderId

string

required

Client-provided order identifier

bump

integer

required

Required range: x >= 0

Prediction

Data & Analytics

Guides

API Reference

Authorizations

Path Parameters

Response