REST APICategories
Get categories
GET
Get categories information and their markets. Markets within RESOLVED categories are not tradable.
ApiKeyAuthheader
x-api-key<token>API key authentication via the x-api-key header.
first?integerPage size, from 1 to 100. Defaults to 20. A value outside that range is clamped.
Format
int32after?stringThe cursor from the previous page, to get the next one.
Length
length <= 1024status?stringRESOLVED returns only resolved categories, and any other value only unresolved
ones. Omit it to get both.
Value in
"OPEN""ACTIVE""RESOLVED""REMOVED"sort?stringDefaults to PUBLISHED_AT_DESC, most recently published first. POPULAR sorts like
VOLUME_24H_DESC, and VOLUME like VOLUME_ALL_DESC.
Value in
"POPULAR""VOLUME""VOLUME_24H_DESC""VOLUME_ALL_DESC""PUBLISHED_AT_ASC""PUBLISHED_AT_DESC"tagIds?stringOnly categories with at least one of these tag IDs, comma-separated. Entries that are not numbers are ignored.
marketVariant?stringOnly categories of this variant. Cannot be combined with marketVariants.
Value in
"DEFAULT""SPORTS_MATCH""CRYPTO_UP_DOWN""TWEET_COUNT""SPORTS_TEAM_MATCH""SPORTS_NBA""SPORTS_FIFA_WORLD_CUP""SPORTS_EXACT_SCORE""SPORTS_HALFTIME_RESULT""SPORTS_PROPS""SPORTS_FIFA_FRIENDLIES""ESPORTS_LOL""ESPORTS_CS2""ESPORTS_DOTA2""SPORTS_FIRST_TO_SCORE""SPORTS_TOTAL_CORNERS""SPORTS_SECOND_HALF_RESULT""UP_DOWN"marketVariants?array<>Only categories of any of these variants (comma-separated or
repeated). Cannot be combined with marketVariant.
includeStats?booleanWhether to fill in stats with volume and liquidity figures. Defaults to false,
which leaves stats null.
application/json; charset=utf-8- response
Response for GET /v1/categories
success*booleancursor?stringdata*array<>curl -X GET 'https://api.predict.fun/v1/categories'Example Response
{ "success": true, "cursor": "string", "data": [ { "id": 0, "slug": "string", "title": "string", "shortTitle": "string", "seriesSlug": "string", "description": "string", "imageUrl": "string", "isNegRisk": true, "protocol": "LEGACY", "isYieldBearing": true, "negRiskOnChainId": "string", "marketVariant": "DEFAULT", "variantData": { "type": "CRYPTO_UP_DOWN", "priceFeedProvider": "PYTH", "startPrice": 0.1, "endPrice": 0.1, "priceFeedId": "string", "priceFeedSymbol": "string" }, "variantDetails": { "sports": { "provider": "PREDICT_SPORTS", "providerEventId": "string", "teams": [ { "id": 0, "name": "string", "abbreviation": "string", "providerTeamId": "string", "isHome": true, "record": { "wins": 0, "losses": 0, "draws": 0, "overtimeLosses": 0 }, "color": "string" } ], "scoreboard": { "source": "GRID", "bestOf": 0, "isLive": true, "finished": true, "currentGame": 0, "period": "string", "clock": "string", "score": [ { "teamId": 0, "score": 0 } ], "games": [ { "gameNumber": 0, "isLive": true, "finished": true, "winnerTeamId": 0, "scores": [ { "teamId": 0, "score": 0 } ] } ] } }, "crypto": { "priceFeedProvider": "PYTH", "priceFeedId": "string", "priceFeedSymbol": "string", "startPrice": 0.1, "endPrice": 0.1 }, "upDown": { "priceFeedProvider": "PYTH", "priceFeedId": "string", "priceFeedSymbol": "string", "startPrice": 0.1, "endPrice": 0.1 }, "tweet": { "xAccountUsername": "string", "tweetCount": 0 } }, "createdAt": "string", "publishedAt": "string", "markets": [ { "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" } ] } } ], "startsAt": "string", "endsAt": "string", "tradingSession": { "opensAt": "string", "closesAt": "string" }, "status": "OPEN", "isVisible": true, "resolutionProvider": "PREDICT_DOT_FUN", "tags": [ { "id": "string", "name": "string", "level": 0, "parentId": "string", "makerRebateBps": 0 } ], "teams": [ { "id": 0, "name": "string", "abbreviation": "string", "alias": "string", "league": "string" } ], "parentSlug": "string", "stats": { "totalLiquidityUsd": 0.1, "volumeTotalUsd": 0.1, "volume24hUsd": 0.1, "holdersCount": 0 } } ]}