> For the complete documentation index, see [llms.txt](https://docs.sportmonks.com/v3/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sportmonks.com/v3/definitions/types/metadata.md).

# Metadata

## Fixture metadata types

The `metadata` include on a fixture returns additional contextual information about the match that does not fit neatly into the core fixture fields. Each entry carries a `type_id` that identifies what kind of metadata it is, and a `values` object whose shape varies by type.

### Requesting metadata

```http
GET https://api.sportmonks.com/v3/football/fixtures/{{fixtureId}}
?api_token={{apiToken}}&include=metadata
```

To resolve type names inline rather than looking them up separately:

```http
GET https://api.sportmonks.com/v3/football/fixtures/{{fixtureId}}
?api_token={{apiToken}}&include=metadata.type
```

### Field descriptions

| Field            | Type             | Description                                                      |
| ---------------- | ---------------- | ---------------------------------------------------------------- |
| `id`             | integer          | Unique ID of this metadata entry                                 |
| `metadatable_id` | integer          | The fixture ID this entry belongs to                             |
| `type_id`        | integer          | The metadata type. See the reference table below                 |
| `value_type`     | string           | Either `"object"` or `"string"`, indicates how to parse `values` |
| `values`         | object or string | The metadata value. Shape varies by type, see below              |

### Metadata type reference

All metadata types verified against the live API on 7 Oct 2026.

| type\_id | Name                    | developer\_name           | values shape                                                                         |
| -------- | ----------------------- | ------------------------- | ------------------------------------------------------------------------------------ |
| 35       | Neutral Venue           | `NEUTRAL_VENUE`           | `{ "neutral": boolean }`                                                             |
| 36       | Kickoff                 | `KICKOFF`                 | `{ "kickOff": "home" \| "away" }`                                                    |
| 159      | Formation               | `FORMATION`               | `{ "home": "4-3-3", "away": "4-2-3-1" }`                                             |
| 161      | Home Participant Colors | `HOME_PARTICIPANT_COLORS` | `{ "participant": "#hex", "kit": "comma-separated hex values", "location": "home" }` |
| 162      | Away Participant Colors | `AWAY_PARTICIPANT_COLORS` | `{ "participant": "#hex", "kit": "comma-separated hex values", "location": "away" }` |
| 572      | Lineup Confirmed        | `LINEUP_CONFIRMED`        | `{ "confirmed": boolean }`                                                           |
| 578      | Attendance              | `ATTENDANCE`              | `{ "attendance": integer }`                                                          |
| 613      | Hashtag                 | `HASHTAG`                 | A string such as `"#MUNMCI"` (value\_type is `"string"`, not `"object"`)             |
| 2838     | Has ExtraTime           | `HAS_EXTRA_TIME`          | `{ "extra_time": boolean }`                                                          |
| 37072    | Prediction Status       | `PREDICTION_STATUS`       | `{ "predictable": boolean }`                                                         |
| 97352    | Pressure Status         | `PRESSURE_STATUS`         | `{ "computable": boolean }`                                                          |

{% hint style="info" %}
**Pitch condition:** a pitch metadata entry (`type_id` 567) was not returned on the fixtures tested when this page was verified. For the possible pitch condition values, see [Weather and pitch](https://docs.sportmonks.com/v3/definitions/types/weather-and-pitch).
{% endhint %}

### Notes on specific types

Formation (159): Returns both teams’ formation strings in a single entry, keyed by home and away. The formations include returns team formation records. For individual player placement, request lineups and use the lineup entry’s formation\_field and formation\_position where available.

**Kit colors (161, 162):** The `kit` field is a comma-separated string of 11 hex color values representing shirt, shorts, socks and related elements in a defined order. The `participant` field is the primary team color as a single hex value, which is the one to use if you only need one color per team.

**Lineup Confirmed (572):** The `confirmed` value indicates whether lineup information has been officially confirmed. A false value is not proof that every returned lineup entry is a prediction. Official `lineups` and `predictedLineups` are separate relationships; inspect the requested relationship and handle missing or provisional information. See the [Predicted Lineups tutorial](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/includes/predicted-lineups) for more detail.

**Prediction Status (37072):** When `predictable` is `false`, the prediction model cannot make accurate predictions for this fixture and no predictions will be available.

**Pressure Status (97352):** When `computable` is `false`, the Pressure Index add-on cannot compute pressure data for this fixture.

**Hashtag (613):** The `value_type` for this entry is `"string"` rather than `"object"`. Parse `values` directly as a string rather than as a JSON object.

### Example response

```json
{
  "metadata": [
    {
      "id": 9089271,
      "metadatable_id": 19427671,
      "type_id": 159,
      "value_type": "object",
      "values": {
        "home": "4-2-3-1",
        "away": "4-1-4-1"
      },
      "type": {
        "id": 159,
        "name": "Formation",
        "code": "formation",
        "developer_name": "FORMATION",
        "model_type": "metadata",
        "stat_group": null
      }
    },
    {
      "id": 9090236,
      "metadatable_id": 19427671,
      "type_id": 572,
      "value_type": "object",
      "values": {
        "confirmed": true
      },
      "type": {
        "id": 572,
        "name": "Lineup Confirmed",
        "code": "lineup-confirmed",
        "developer_name": "LINEUP_CONFIRMED",
        "model_type": "metadata",
        "stat_group": null
      }
    },
    {
      "id": 9124782,
      "metadatable_id": 19427671,
      "type_id": 161,
      "value_type": "object",
      "values": {
        "participant": "#D50619",
        "kit": "#C40010,#C40010,#C40010,#C40010,#A70000,#A70000,#F0F0F0,#F0F0F0,#FBED32,#0A0A0A,#F0F0F0",
        "location": "home"
      },
      "type": {
        "id": 161,
        "name": "Home Participant Colors",
        "code": "home-participany-colors",
        "developer_name": "HOME_PARTICIPANT_COLORS",
        "model_type": "metadata",
        "stat_group": null
      }
    }
  ]
}
```

### Related pages

* [Fixture includes reference](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/includes/fixture-includes-reference)
* [Predicted lineups tutorial](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/includes/predicted-lineups)
* [Lineups and formations tutorial](https://docs.sportmonks.com/v3/tutorials-and-guides/tutorials/lineups-and-formations)
* [Types definitions index](https://docs.sportmonks.com/v3/definitions/types)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.sportmonks.com/v3/definitions/types/metadata.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
