Skip to content

Overview

LIGR runs live sports graphics and streams for broadcasters, leagues and federations. This site documents four surfaces you can build on.

SurfaceWhat it doesWhere to start
REST APIRead and write matches, facts, teams, overlays, streams and themesYour first request
WebhooksSigned POST requests when a match, fact, summary, team, competition or overlay changes. Off by default. Ask your LIGR contact to turn them onWebhooks overview
Graphics SDKWrite a graphic in HTML and JavaScript, then publish it into a themeGraphics SDK
Rive graphicsImport a native Rive runtime or source project, then bind live dataRive graphics
  • A scoring system that creates matches and posts facts as the match runs.
  • An automation that fires graphics on an overlay and starts and stops the stream of a match.
  • A data push from a spreadsheet or a feed into a theme data source.
  • Your own HTML graphics, published into a theme that operators use.
  • Native Rive graphics bound to live match data and control-room variables.
  1. Get an organization on LIGR. Ask your LIGR contact if you do not have one.
  2. Ask an owner or an admin of that organization to create an API key.
  3. Send that key on every request to https://api.ligr.live/rest.

The examples in these docs use production: api.ligr.live for REST and overlay.ligr.live for overlays. If LIGR gave you a non-production environment, use its API and overlay origins instead. A key works only in the environment that issued it.

PageWhat it answers
AuthenticationHow keys work, which scopes exist, and how expiry works
Your first requestA working curl call and the response it returns
ConceptsThe competition tree, the theme tree, and the ids that join them
Includes & paginationHow to fetch related entities and page through lists
ErrorsThe status codes, the error codes and the response bodies
Rate limitsThe RateLimit headers, observe mode, and enforcement
VersioningWhy /v1 and /v2 run side by side, and the deprecation policy