# List match predictions

List the match predictions in your community, filtered by status, fixture ID or text, one page at a time.

- Endpoint: `GET https://api.returning.ai/v1/match-predictions`
- Section: Gamification / Match predictions
- Authentication: `Authorization: Bearer <API_KEY>` (Community API key)
- Permission: `matchPredictions` (Shown in the dashboard as "Match Prediction")
- Retries: Read-only; exact retries are safe
- Guide: hand-written
- Verified: code, 2026-09-27
- Last updated: 26 Sep 2026
- Web page: https://docs.returning.ai/api-reference/gamification-match-predictions/list-match-predictions

## When to use this

- Find the match prediction for one of your fixtures by its `externalReference`.
- Show which matches are open for predictions right now.
- Find matches that have locked and still need a result.

**Instead:** Use [Get match prediction](https://docs.returning.ai/api-reference/gamification-match-predictions/get-match-prediction.md) instead to read one match, including its settlement totals.

**Availability:** api.returning.ai doesn't serve this route yet: requests return an empty `404`. Ask Returning.AI before you build on it.

## Authentication

- Header: `Authorization: Bearer <API_KEY>`
- Permission: `matchPredictions`

Use a Community API key with `matchPredictions`, shown in the dashboard as Match Prediction, and keep it on your server. The key decides the community: you only see and change match predictions in that community, and an ID from another community returns `404`, the same as an unknown ID. Personal API keys are rejected with `403`.

## Behaviour

api.returning.ai doesn't serve this route yet: requests return an empty `404`. Ask Returning.AI before you build on it.

This read changes nothing. It returns drafts too, and match predictions your team created in the dashboard. `status` is worked out from the clock when you ask, so a published match moves from `scheduled` to `open` to `locked` without any call. Filters combine, and `status` filters on that worked-out status.

`kickoffFrom` and `kickoffTo` currently match no match predictions. Until that changes, sort by `kickoffAt` and filter on your side. Matches with the same sort value come back in the order they were created.

## Request

### Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `status` | `string` | No | Only matches in these statuses. Separate several with commas, or repeat the parameter. (`draft`, `scheduled`, `open`, `locked`, `settlement_in_progress`, `settled`, `settlement_failed`, `void_in_progress`, `voided` or `void_failed`) |
| `externalReference` | `string` | No | Only the match with exactly this fixture ID. |
| `search` | `string` | No | Only matches whose title or team names contain this text, ignoring case. (Up to 128 characters) |
| `kickoffFrom` | `string` | No | Meant to keep matches kicking off at or after this time. It currently matches nothing; see Behaviour. (ISO 8601 in UTC ending in `Z`) |
| `kickoffTo` | `string` | No | Meant to keep matches kicking off at or before this time. It currently matches nothing; see Behaviour. (ISO 8601 in UTC ending in `Z`; not before `kickoffFrom`) |
| `sort` | `string` | No | What to sort by. (`kickoffAt` (default), `createdAt`, `updatedAt` or `title`) |
| `order` | `string` | No | Sort direction. (`asc` (default) or `desc`) |
| `page` | `integer` | No | Page number, starting at 1. (Whole number, 1 or more; default 1) |
| `limit` | `integer` | No | Matches per page. (Default 20; max 100) |

### Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Authorization` | `string` | Yes | Community API key with `matchPredictions`. (`Bearer <API_KEY>`) |
| `X-Request-Id` | `string` | No | Your own ID for this request, returned in `meta.requestId`. Without it, a `req_...` ID is generated. |

### Example request

```bash
curl --request GET \
  --url 'https://api.returning.ai/v1/match-predictions?status=open,locked&limit=20' \
  --header 'Authorization: Bearer <API_KEY>'
```

## Response

A `200` returns the page in `data` and the paging totals in `meta.page`, `meta.limit` and `meta.total`. `settlement` is always `null` in this list; read one match with Get match prediction for its settlement totals.

### Response fields

| Field | Type | Presence | Description |
| --- | --- | --- | --- |
| `meta` | `object` | always | Result details. |
| `meta.status` | `string` | always | Result of the request. (`success`) |
| `meta.statusCode` | `integer` | always | The HTTP status, repeated. |
| `meta.code` | `string` | always | Machine-readable result code. (`MATCH_PREDICTIONS_LISTED`) |
| `meta.requestId` | `string` | always | Your `X-Request-Id` if you sent one, otherwise a generated `req_...` ID. Quote it when you contact support. |
| `meta.page` | `integer` | always | The page you asked for. |
| `meta.limit` | `integer` | always | Items per page. |
| `meta.total` | `integer` | always | Items that match, across all pages. |
| `message` | `string` | always | Human-readable summary. Do not branch on it. |
| `data` | `object[]` | always | This page of matches. Empty when nothing matches. |
| `data.id` | `string` | always | The match prediction ID. Use it in every other call. (`mp_` and 24 hex characters) |
| `data.externalReference` | `string` | - | Your own fixture ID. Left out when not set. |
| `data.title` | `string` | always | The match title traders see. |
| `data.description` | `string` | - | Longer text for traders. Left out when not set. |
| `data.teamA` | `object` | always | The first team. |
| `data.teamA.name` | `string` | always | Team name. |
| `data.teamA.imageUrl` | `string` | - | Team logo URL. Left out when not set. |
| `data.teamB` | `object` | always | The second team. |
| `data.teamB.name` | `string` | always | Team name. |
| `data.teamB.imageUrl` | `string` | - | Team logo URL. Left out when not set. |
| `data.predictionStartAt` | `string` | always | When traders can start predicting, in UTC. Milliseconds always read `.000`. |
| `data.lockAt` | `string` | always | When predictions close, in UTC. |
| `data.kickoffAt` | `string` | always | When the match starts, in UTC. |
| `data.scoreBasis` | `string` | always | Which score you settle on. Settlement uses the score you send either way. (`regulation` or `extra_time`) |
| `data.viewPermission` | `object` | always | Who can see the match once it is published. |
| `data.viewPermission.roleIds` | `string[]` | always | Role IDs. Traders with any of these roles can see it. |
| `data.viewPermission.userIds` | `string[]` | always | Platform user IDs, as strings, of traders who can see it. |
| `data.rewards` | `object` | always | What winners earn. |
| `data.rewards.correctResult` | `object` | always | Paid for picking the right result: team A, team B or a draw. |
| `data.rewards.correctResult.coins` | `integer` | always | Coins. |
| `data.rewards.correctResult.xp` | `integer` | always | XP. |
| `data.rewards.exactScoreBonus` | `object` | always | Paid on top of `correctResult` when the called score is also exact. |
| `data.rewards.exactScoreBonus.coins` | `integer` | always | Coins. |
| `data.rewards.exactScoreBonus.xp` | `integer` | always | XP. |
| `data.entryCost` | `object` | always | What a trader pays to predict. |
| `data.entryCost.enabled` | `boolean` | always | `true` when predicting costs coins. |
| `data.entryCost.coins` | `integer` | always | Coins per prediction. `0` when `enabled` is `false`. |
| `data.status` | `string` | always | `draft` until published. Then `scheduled` before `predictionStartAt`, `open` while traders can predict and `locked` from `lockAt`, all worked out from the clock. The rest follow a settle or void. (`draft`, `scheduled`, `open`, `locked`, `settlement_in_progress`, `settled`, `settlement_failed`, `void_in_progress`, `voided` or `void_failed`) |
| `data.isPublished` | `boolean` | always | `true` once published. |
| `data.acceptingPredictions` | `boolean` | always | `true` while the match is `open` and the time is between `predictionStartAt` and `lockAt`. |
| `data.attemptCount` | `integer` | always | Predictions traders have submitted. |
| `data.settlement` | `object` | always | Always `null` here. Read the match with Get match prediction for its settlement totals. |
| `data.version` | `integer` | always | The current version. Send it with Patch match prediction. It goes up with every change, including publish, settle and void. |
| `data.createdAt` | `string` | always | When the match prediction was created. |
| `data.updatedAt` | `string` | always | When it last changed. |

### Example response (200)

```json
{
  "meta": {
    "status": "success",
    "statusCode": 200,
    "code": "MATCH_PREDICTIONS_LISTED",
    "requestId": "req_66f00000000000000000000000000811",
    "page": 1,
    "limit": 20,
    "total": 1
  },
  "message": "Match predictions retrieved.",
  "data": [
    {
      "id": "mp_66f000000000000000000801",
      "title": "Australia vs New Zealand",
      "teamA": {
        "name": "Australia",
        "imageUrl": "https://cdn.example.com/teams/australia.png"
      },
      "teamB": {
        "name": "New Zealand",
        "imageUrl": "https://cdn.example.com/teams/new-zealand.png"
      },
      "predictionStartAt": "2026-10-01T08:00:00.000Z",
      "lockAt": "2026-10-10T18:55:00.000Z",
      "kickoffAt": "2026-10-10T19:00:00.000Z",
      "scoreBasis": "regulation",
      "viewPermission": {
        "roleIds": ["66f000000000000000000806"],
        "userIds": []
      },
      "rewards": {
        "correctResult": {
          "coins": 100,
          "xp": 50
        },
        "exactScoreBonus": {
          "coins": 200,
          "xp": 100
        }
      },
      "entryCost": {
        "enabled": false,
        "coins": 0
      },
      "status": "open",
      "isPublished": true,
      "acceptingPredictions": true,
      "attemptCount": 120,
      "settlement": null,
      "version": 3,
      "createdAt": "2026-09-27T09:00:00.000Z",
      "updatedAt": "2026-09-28T10:00:00.000Z",
      "externalReference": "provider-fixture-123",
      "description": "Predict the final score."
    }
  ]
}
```

## Errors

Every error carries its code in `meta.code` and the request's ID in `meta.requestId`. Validation errors list each problem in `details`, with a `field`, `code` and `message`. The API key checks (`401`, `403`, `404 COMMUNITY_NOT_FOUND` and `500 AUTHENTICATION_FAILED`) return `detail` and `solution` instead. A `404` with an empty body means the route isn't available on api.returning.ai yet.

### Fix the request

| Status | Code | What to do |
| --- | --- | --- |
| 404 | - | The body is empty: api.returning.ai doesn't serve this route yet. Ask Returning.AI before you build on it. |
| 400 | `MATCH_PREDICTION_VALIDATION_FAILED` | A query value is invalid: `page` below 1, `limit` outside 1-100, an unknown `status` (`INVALID_STATUS`), a time not in UTC ISO 8601, `kickoffTo` before `kickoffFrom` (`KICKOFF_RANGE_INVALID`), `search` over 128 characters, or an unknown `sort` or `order`. `details` names each one. |
| 400 | `READ_ONLY_FIELD` | The request has a field the server sets, such as `id`, `communityId` or `version`, in the query. `details` names it. Remove it. |
| 401 | `AUTHENTICATION_REQUIRED` | The key is missing, invalid or expired. Send `Authorization: Bearer <API_KEY>` with a current Community API key. |
| 403 | `API_KEY_PERMISSION_DENIED` | The key lacks `matchPredictions`, or it is a personal key. Use a Community API key and add Match Prediction in Settings > Integration > API Keys. |

### Fix the data

| Status | Code | What to do |
| --- | --- | --- |
| 404 | `COMMUNITY_NOT_FOUND` | The community this key belongs to no longer exists. Contact Returning.AI support. |

### Retry with backoff

| Status | Code | What to do |
| --- | --- | --- |
| 429 | `RATE_LIMITED` | Your community is over its [rate limit](https://docs.returning.ai/how-it-works.md#rate-limits). Wait for the seconds in `Retry-After`, then retry. |
| 500 | `INTERNAL_ERROR` | The matches could not be read. Retry with exponential backoff. |
| 500 | `AUTHENTICATION_FAILED` | The key could not be checked. Retry with backoff; nothing changed. |
| 503 | `MATCH_PREDICTION_FROZEN` | Returning.AI has paused match prediction requests. Nothing changed. Retry later with backoff. |

**Retries:** This endpoint is read-only and doesn't take an `Idempotency-Key`. Retrying the exact request is safe after a network error or a `500`; use bounded exponential backoff. Matches can change status between pages, so read each page once and don't expect the pages to line up exactly. Returning.AI can set a request limit for your community on these endpoints, counted per community and calling IP address. Over it, requests return `429 RATE_LIMITED` with a `Retry-After` header in seconds; wait that long, then retry.

## Next step

- [Get match prediction](https://docs.returning.ai/api-reference/gamification-match-predictions/get-match-prediction.md): `GET /v1/match-predictions/{matchPredictionId}`. Read one match with its current `version`, before you change, publish or settle it.
- [Add a fixture with Create match prediction](https://docs.returning.ai/api-reference/gamification-match-predictions/create-match-prediction.md): `POST /v1/match-predictions`.