Skip to main content
GET
/
positions
/
{positionPubkey}
cURL
curl --request GET \
  --url https://api.jup.ag/prediction/v1/positions/{positionPubkey} \
  --header 'x-api-key: <api-key>'
{
  "pubkey": "<string>",
  "owner": "<string>",
  "ownerPubkey": "<string>",
  "market": "<string>",
  "marketId": "<string>",
  "marketIdHash": "<string>",
  "isYes": true,
  "contracts": "<string>",
  "totalCostUsd": "<string>",
  "sizeUsd": "<string>",
  "valueUsd": "<string>",
  "avgPriceUsd": "<string>",
  "markPriceUsd": "<string>",
  "sellPriceUsd": "<string>",
  "pnlUsd": "<string>",
  "pnlUsdPercent": 123,
  "pnlUsdAfterFees": "<string>",
  "pnlUsdAfterFeesPercent": 123,
  "openOrders": 1,
  "feesPaidUsd": "<string>",
  "realizedPnlUsd": 123,
  "claimed": true,
  "claimedUsd": "<string>",
  "openedAt": 123,
  "updatedAt": 123,
  "claimableAt": 123,
  "payoutUsd": "<string>",
  "bump": 1,
  "eventId": "<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>"
  },
  "settlementDate": 123,
  "claimable": true,
  "contractsMicro": "<string>",
  "contractsDecimal": "<string>",
  "source": "<string>",
  "maxSlippageBps": 1
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
positionPubkey
string
required

Position account public key

Minimum string length: 1

Response

Position data

​
pubkey
string
required

Position account public key

​
owner
string
required

Position owner public key

​
ownerPubkey
string
required

Position owner public key (alias of owner, prefer ownerPubkey going forward)

​
market
string
required

Deterministic market PDA derived from marketId

​
marketId
string
required

External market identifier (ticker)

​
marketIdHash
string
required

Hashed market identifier used for on-chain PDAs

​
isYes
boolean
required

True if this is a YES position

​
contracts
string
required

Legacy whole-contract quantity held. Use contractsMicro or contractsDecimal for the exact fractional quantity.

​
totalCostUsd
string
required

Total cost basis in micro USD (u128 as string)

​
sizeUsd
string
required

Alias of total cost basis in micro USD (u128 as string)

​
valueUsd
string | null
required

Mark-to-market value in micro USD (u128 as string); null once market is closed

​
avgPriceUsd
string
required

Average entry price per contract in micro USD (u64 as string)

​
markPriceUsd
string | null
required

Current mark price per contract in micro USD (u64 as string); null once market is closed

​
sellPriceUsd
string | null
required

Current best exit price for this side (micro USD string), or null when unavailable

​
pnlUsd
string | null
required

Unrealized PnL in micro USD (i128 as string); null once market is closed

​
pnlUsdPercent
number | null
required

Unrealized PnL percentage relative to size; null once market is closed

​
pnlUsdAfterFees
string | null
required

Unrealized PnL after fees in micro USD (i128 as string); null once market is closed

​
pnlUsdAfterFeesPercent
number | null
required

Unrealized PnL after fees percentage relative to size; null once market is closed

​
openOrders
integer
required

Number of open orders

Required range: x >= 0
​
feesPaidUsd
string
required

Total fees paid in micro USD (u64 as string)

​
realizedPnlUsd
number
required

Realized PnL in micro USD (i64 as number)

​
claimed
boolean
required

Whether payout has been claimed

​
claimedUsd
string
required

Amount claimed in micro USD (u64 as string)

​
openedAt
integer
required

Unix timestamp when the position was opened

​
updatedAt
integer
required

Unix timestamp of the last position update

​
claimableAt
integer | null
required

Unix timestamp (seconds) when the position becomes claimable; null when unavailable

​
payoutUsd
string
required

Notional payout if position wins (contracts * $1)

​
bump
integer
required
Required range: x >= 0
​
eventId
string
required

External event identifier if available

​
eventMetadata
object
required
​
marketMetadata
object
required
​
settlementDate
integer | null
required

Unix timestamp (seconds) when the market settles; null when unavailable

​
claimable
boolean
required

True when the position qualifies for payout claim

​
contractsMicro
string

Contracts held in micro-contract units (u64 as string, 1000000 = 1 contract)

​
contractsDecimal
string

Contracts held as a decimal string

​
source
string

Origin of the position (e.g. "program")

​
maxSlippageBps
integer

Maximum slippage recorded for the position, in basis points

Required range: x >= 0