Get Positions

Get a list of positions with optional filtering

GET /positions

cURL

cURL

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

200

{
  "data": [
    {
      "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>",
        "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>"
      },
      "settlementDate": 123,
      "claimable": true
    }
  ],
  "pagination": {
    "start": 1,
    "end": 1,
    "total": 1,
    "hasNext": true
  }
}

Authorizations

x-api-key · string · header · required

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

Query Parameters

start · integer | null

Required range: x >= 0

end · integer | null

Required range: x >= 0

ownerPubkey · string

Position owner public key

Minimum string length: 1

marketPubkey · string

Minimum string length: 1

marketId · string

Minimum string length: 1

isYes · enum<string>

Filter by position side (true = YES, false = NO)

Available options: true, false

Response

200

application/json

List of on-chain positions

data · object[] · required

Show child attributes

pagination · object · required

Show child attributes