REST APIPositions

Get positions

GET
/positions

Get data about your positions. Requires JWT authentication.

Authorization

ApiKeyAuthBearerAuth
headerx-api-key<token>

API key authentication via the x-api-key header.

headerAuthorizationBearer <JWT>

Bearer authentication via the Authorization: Bearer <token> header.

Query Parameters

first?integer

Page size, from 1 to 100. Defaults to 20. A value outside that range is clamped.

Formatint32
after?string

The cursor from the previous page, to get the next one.

Lengthlength <= 1024
marketId?integer

Only positions in this market. Cannot be combined with marketIds.

Formatint64
marketIds?array<>

Only positions in these markets (comma-separated or repeated, up to 100). Cannot be combined with marketId.

categoryId?string

Only positions in the category with this slug, which markets return as categorySlug.

Lengthlength <= 256
isResolved?boolean

Set to true for only positions in resolved markets, or false for only those in unresolved markets. Both are listed by default.

includeLost?boolean

Also list positions in outcomes that settled as losing. Off by default, since those need no action from the holder.

sort?string

How to order the positions. Defaults to EVENT_BLOCK_DESC, which lists the most recently changed positions first.

Value in"AMOUNT_DESC""EVENT_BLOCK_ASC""EVENT_BLOCK_DESC""SHARES_VALUE_DESC""RETURN_DESC"

Response Body

application/json; charset=utf-8
  1. response

Response for GET /v1/positions

success*boolean
cursor?string
data*array<>
Example Request
curl -X GET 'https://api.predict.fun/v1/positions'
Example Response
{  "success": true,  "cursor": "string",  "data": [    {      "id": "string",      "market": {        "id": 0,        "imageUrl": "string",        "title": "string",        "question": "string",        "description": "string",        "tradingStatus": "OPEN",        "status": "REGISTERED",        "isVisible": true,        "isNegRisk": true,        "isYieldBearing": true,        "feeRateBps": 0,        "makerFeeBps": 0,        "resolution": {          "name": "string",          "indexSet": 0,          "onChainId": "string",          "status": "WON",          "bestBid": {            "price": 0.1,            "size": 0.1          },          "bestAsk": {            "price": 0.1,            "size": 0.1          },          "team": {            "id": 0,            "name": "string",            "abbreviation": "string",            "alias": "string",            "league": "string"          },          "variantData": {            "type": "ESPORTS_DOTA2",            "provider": "PREDICT_SPORTS",            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "providerTeamId": "string",              "isHome": true,              "record": {                "wins": 0,                "losses": 0,                "draws": 0,                "overtimeLosses": 0              },              "color": "string"            }          },          "variantDetails": {            "sports": {              "provider": "PREDICT_SPORTS",              "team": {                "id": 0,                "name": "string",                "abbreviation": "string",                "providerTeamId": "string",                "isHome": true,                "record": {                  "wins": 0,                  "losses": 0,                  "draws": 0,                  "overtimeLosses": 0                },                "color": "string"              }            }          }        },        "oracleQuestionId": "string",        "conditionId": "string",        "resolverAddress": "string",        "outcomes": [          {            "name": "string",            "indexSet": 0,            "onChainId": "string",            "status": "WON",            "bestBid": {              "price": 0.1,              "size": 0.1            },            "bestAsk": {              "price": 0.1,              "size": 0.1            },            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "alias": "string",              "league": "string"            },            "variantData": {              "type": "ESPORTS_DOTA2",              "provider": "PREDICT_SPORTS",              "team": {                "id": 0,                "name": "string",                "abbreviation": "string",                "providerTeamId": "string",                "isHome": true,                "record": {                  "wins": 0,                  "losses": 0,                  "draws": 0,                  "overtimeLosses": 0                },                "color": "string"              }            },            "variantDetails": {              "sports": {                "provider": "PREDICT_SPORTS",                "team": {                  "id": 0,                  "name": "string",                  "abbreviation": "string",                  "providerTeamId": "string",                  "isHome": true,                  "record": {                    "wins": 0,                    "losses": 0,                    "draws": 0,                    "overtimeLosses": 0                  },                  "color": "string"                }              }            }          }        ],        "questionIndex": 0,        "spreadThreshold": 0.1,        "shareThreshold": 0,        "isBoosted": true,        "boostStartsAt": "string",        "boostEndsAt": "string",        "polymarketConditionIds": [          "string"        ],        "kalshiMarketTicker": "string",        "categorySlug": "string",        "seriesSlug": "string",        "createdAt": "string",        "decimalPrecision": 0,        "marketVariant": "DEFAULT",        "variantData": {          "type": "CRYPTO_UP_DOWN",          "priceFeedProvider": "PYTH",          "startPrice": 0.1,          "endPrice": 0.1,          "priceFeedId": "string",          "priceFeedSymbol": "string"        },        "variantDetails": {          "sports": {            "provider": "PREDICT_SPORTS",            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "providerTeamId": "string",              "isHome": true,              "record": {                "wins": 0,                "losses": 0,                "draws": 0,                "overtimeLosses": 0              },              "color": "string"            },            "line": 0.1,            "gameNumber": 0          }        },        "team": {          "id": 0,          "name": "string",          "abbreviation": "string",          "alias": "string",          "league": "string"        },        "marketType": "SPORTS_MONEYLINE",        "rewards": {          "current": {            "hourlyRate": 0,            "startsAt": "string",            "endsAt": "string"          },          "schedule": [            {              "hourlyRate": 0,              "startsAt": "string",              "endsAt": "string"            }          ]        }      },      "outcome": {        "name": "string",        "indexSet": 0,        "onChainId": "string",        "status": "WON",        "bestBid": {          "price": 0.1,          "size": 0.1        },        "bestAsk": {          "price": 0.1,          "size": 0.1        },        "team": {          "id": 0,          "name": "string",          "abbreviation": "string",          "alias": "string",          "league": "string"        },        "variantData": {          "type": "ESPORTS_DOTA2",          "provider": "PREDICT_SPORTS",          "team": {            "id": 0,            "name": "string",            "abbreviation": "string",            "providerTeamId": "string",            "isHome": true,            "record": {              "wins": 0,              "losses": 0,              "draws": 0,              "overtimeLosses": 0            },            "color": "string"          }        },        "variantDetails": {          "sports": {            "provider": "PREDICT_SPORTS",            "team": {              "id": 0,              "name": "string",              "abbreviation": "string",              "providerTeamId": "string",              "isHome": true,              "record": {                "wins": 0,                "losses": 0,                "draws": 0,                "overtimeLosses": 0              },              "color": "string"            }          }        }      },      "amount": "string",      "valueUsd": "string",      "averageBuyPriceUsd": "string",      "pnlUsd": "string"    }  ]}