Developers

REST APISeries

Get series by slug

GET
/series/{slug}

Get one recurring up/down series by its slug, e.g. btc-updown-5m.

Authorization

ApiKeyAuth
headerx-api-key<token>

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

Path Parameters

slug*string

The series' slug, for example btc-updown-5m.

Lengthlength <= 256

Response Body

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

Response for GET /v1/series/{slug}

success*boolean
data*

A recurring up/down series: one asset at one cadence, rolling over from one round to the next. Each round is a category, listed by GET /v1/series/{slug}/rounds. A retired series stays listed, with its past rounds still readable, and simply has no active rounds.

Example Request
curl -X GET 'https://api.predict.fun/v1/series/string'
Example Response
{  "success": true,  "data": {    "slug": "string",    "symbol": "string",    "marketVariant": "DEFAULT",    "intervalSeconds": 0  }}

Get series GET

Get every recurring up/down series, active or retired, sorted by slug. marketVariant keeps the series whose rounds are of that variant, as it does on GET /v1/categories.

Get series rounds GET

Get the rounds of a series, each one a category with its markets. ACTIVE, the default, lists the rounds that have not ended yet in start order, so the first is the live round, and the rest are the rounds it rolls over to. Rounds are created ahead of time, so one page is enough to follow a series through several rollovers. ENDED lists the rounds that have ended, newest first. Pages are cached for a few seconds, so a round can still be listed as active for a moment after its endsAt.