Skip to content
API reference / Soccer
GET/basketball/matches/{id}/briefing

Match briefing (all sports)

Insights plan feature (403 FEATURE_NOT_IN_PLAN without it). Ready context for one match, computed from stored results and tables: last-5 form, current streaks (overall and at the venue), season home and away records, head-to-head in our data, table position, gaps and zones, stakes (first against second, top-3 clash, relegation clash, local derby, what a win means against the leader's current points), schedule load, injuries and lineups; soccer before kickoff also suspended_out and one_booking_from_ban (league card rules, complete cards only). Every statement is also a fact with a sentence (lang=de, es, it, fr; default English). Facts only: no predictions. A fact marked incomplete (a match without a result inside its window) has no sentence. format=md returns Markdown.

Insights planPay per call without a key: $0.02 in USDC

Parameters

  • idinteger · pathrequired

    Match ID

  • langstring · query

    Language of sentences and names: de, es, it, fr

  • formatstring · query

    md for Markdown

Response

JSON with success, the result in data, and where the endpoint pages its results meta.

  • dataobject
  • after_matchboolean

    form, streaks and records include this match

  • completenessobject
  • as_ofstring
  • away_results_completeboolean
  • history_fromstring
  • home_results_completeboolean
  • team_idsboolean

    false: the data provider sent no team ids, only names

  • factsarray of object
  • based_onarray of integer
  • history_fromstring
  • importanceinteger
  • incompleteboolean

    a match without a result cuts it: no sentence

  • opponentobject
  • player_idinteger
  • sincestring
  • teamobject
  • team_idinteger

    Flat fields for consumers that do not read values: the team's and player's id, the fact's main number, the day a run or "first since" reaches back to, and the start of our data (no claim reaches further).

  • textstring
  • typestring
  • valueinteger
  • valuesobject
  • formobject
  • awayarray of object
  • homearray of object
  • head_to_headobject
  • away_team_goalsinteger
  • away_team_winsinteger
  • biggest_away_team_winobject
  • biggest_home_team_winobject
  • drawsinteger
  • history_fromstring

    our results start here: no claim reaches further back

  • home_team_goalsinteger

    Goals over the counted meetings, and each side's biggest win (largest margin, the latest of equal ones; a shoot-out is no win).

  • home_team_winsinteger
  • meetingsarray of object

    latest first, at most 5

  • meetings_without_resultinteger

    Meetings in the past without a result: the counts leave them out, so a summary is incomplete; LatestMissing: the most recent one is among them.

  • playedinteger

    all meetings in our data

  • injuriesarray of object
  • availabilitystring

    to_miss or questionable

  • lineupsinteger
  • playerstring
  • player_idinteger
  • reasonstring
  • season_goalsinteger

    Why the player matters (filled from our data, soccer only).

  • startsinteger

    starts in the team's last Lineups confirmed lineups

  • team_idinteger
  • top_scorerboolean

    the team's top scorer (ties count)

  • lineup_typestring

    confirmed, expected or ""

  • lineupsobject
  • coachesobject
  • expectedobject
  • lineup_typestring

    confirmed or expected

  • lineupsobject
  • matchany

    Match: soccer as /soccer/matches/{id} serves it; other sports as BriefingMatch.

  • recordsobject
  • awayobject
  • homeobject
  • scheduleobject
  • awayobject
  • homeobject
  • sportstring
  • storyobject

    a played match: goals, red cards

  • completeboolean

    goal events, each with a minute, add up to the final score

  • goalsarray of object
  • red_cardsarray of object
  • streaksobject
  • awayarray of object
  • homearray of object
  • tableobject
  • awayobject

Errors

StatusCodeWhen
402x402 offersNo key and no valid payment: the body lists what to pay. Only a 200 answer is charged.
403FORBIDDENThe sport or feature is not in your plan (FEATURE_NOT_IN_PLAN for Insights and other plan features).
404NOT_FOUNDNo record with that id.

All errors have the shape described in Errors and limits.

Generated from the OpenAPI file, version 1.0. See it as JSON

Was this page helpful?