Skip to main content
GET
/
orders
/
{orderPubkey}
cURL
curl --request GET \
  --url https://api.jup.ag/prediction/v1/orders/{orderPubkey} \
  --header 'x-api-key: <api-key>'
{
  "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>",
    "imageUrl": "<string>",
    "isLive": true
  },
  "marketMetadata": {
    "marketId": "<string>",
    "isTradable": true,
    "title": "<string>",
    "subtitle": "<string>",
    "description": "<string>",
    "status": "<string>",
    "result": "<string>",
    "closeTime": 123,
    "openTime": 123,
    "settlementTime": 123,
    "rulesPrimary": "<string>",
    "rulesSecondary": "<string>",
    "eventId": "<string>"
  },
  "externalOrderId": "<string>",
  "bump": 1
}

Authorizations

x-api-key
string
header
required

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

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
marketMetadata
object
required
externalOrderId
string
required

Client-provided order identifier

bump
integer
required
Required range: x >= 0