Skip to content
Get a key
API reference / American football
GET/american-football/matches/{id}

Get American football match by ID

Returns a single American football match by its match ID

In the plans that cover this sportPay per call without a key: $0.005 in USDC

Parameters

  • idinteger · pathrequired

    Match ID

Response

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

  • dataobject
  • away_teamobject
  • idinteger
  • namestring
  • scoreinteger
  • eventsobject
  • file_groupstring
  • home_teamobject
  • idinteger
  • namestring
  • scoreinteger
  • idinteger
  • league_gidinteger
  • league_idinteger
  • league_namestring
  • match_idinteger
  • quarter_scoresobject
  • otobject
  • q1object
  • q2object
  • q3object
  • q4object
  • sportstring
  • start_datestring
  • start_timestring
  • statusstring
  • timerstring
  • errorobject
  • codestring
  • messagestring
  • metaobject
  • attributionstring

    Attribution a data source's licence asks for (Cricsheet's history).

  • limitinteger
  • offsetinteger
  • totalinteger
  • successboolean

Errors

StatusCodeWhen
400INVALID_PARAMA parameter is missing or wrong, and the message names it. Fix the request; do not retry it.
401UNAUTHORIZEDThe key is missing, mistyped or was rotated.
402x402 offersNo key and no valid payment: the body lists what to pay. Only a 200 answer is charged.
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?