Skip to main content

List events

GET /api/v1/games/:game_id/events
Returns paginated events for a game.
curl https://app.framesports.com/api/v1/games/game_abc123/events \
  -H "Authorization: Bearer your-api-token"
Response
{
  "links": {
    "first": "/api/v1/games/game_abc123/events?page=1",
    "next": "/api/v1/games/game_abc123/events?page=2",
    "last": "/api/v1/games/game_abc123/events?page=5"
  },
  "data": [
    {
      "id": "ev_abc123",
      "caption": "Positive Carry - Player #7",
      "player_number": 7,
      "team": "Home",
      "start_timestamp": 125.4,
      "end_timestamp": 130.2
    }
  ]
}

Response fields

FieldTypeDescription
idstringPrefixed event ID
captionstringEvent description encoding the event type and player
player_numberintegerJersey number of the player involved (may be null for team events)
teamstring"Home" or "Opp"
start_timestampfloatStart time in seconds from video start
end_timestampfloatEnd time in seconds from video start

Pagination

Results are paginated using JSON:API-style links. Follow the links.next URL to fetch the next page. The links object includes first, next, prev, and last as available.

Event captions

Event captions encode the type of play. Some examples:
Caption patternMeaning
Positive Carry - Player #7Home team carry by jersey 7
Tackle Missed - Player #3Home team missed tackle by jersey 3
TryOpposition try (no player number = opponent)
Lineout Won (5 players)Home lineout with detail