statshawk
REST APICompetitions

GET /v1/competitions/{comp}/editions/{year}/matchups?date= — the pregame matchup board for one calendar day of an edition's slate.

cost 3 unitsany plan
GET
/v1/competitions/{comp}/editions/{year}/matchups

Authorization

X-API-Key<token>

Raw API key (sk_live_… or sk_test_…). Preferred for REST clients. Keys are read-only; the environment prefix is the only key role. See https://statshawk.ai/docs/getting-started/permissions

In: header

Path Parameters

comp*string

Competition slug (mlb, …)

year*string

Season start year (e.g. 2026) — cross-year leagues (NBA/NHL/NCAA) use the year the season STARTS in (2025 = the 2025-26 season)

Query Parameters

date?string
Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/competitions/string/editions/string/matchups"
{
  "data": {
    "items": [
      {
        "away_lineup": [
          {
            "bat_side": null,
            "batting_order": 0,
            "confirmed": true,
            "name": "string",
            "person_id": "per_0a1b2c3d4e5f6g7h8i9j0k1l2m",
            "position": null
          }
        ],
        "away_probable_pitcher": null,
        "away_team": null,
        "contest": "cst_0a1b2c3d4e5f6g7h8i9j0k1l2m",
        "game_time": "2019-08-24T14:15:22Z",
        "home_lineup": [
          {
            "bat_side": null,
            "batting_order": 0,
            "confirmed": true,
            "name": "string",
            "person_id": "per_0a1b2c3d4e5f6g7h8i9j0k1l2m",
            "position": null
          }
        ],
        "home_probable_pitcher": null,
        "home_team": null,
        "lineups_available": true,
        "status": "string"
      }
    ],
    "page": 0,
    "per_page": 0,
    "total": 0
  },
  "meta": {
    "cache": "HIT",
    "fetched_at": "2025-10-15T18:30:00Z",
    "request_id": "266ea41d-adf5-480b-af50-15b940c2b846",
    "source": "postgres",
    "version": "v1"
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}
{
  "error": {
    "code": "string",
    "message": "string",
    "property1": null,
    "property2": null
  }
}