Skip to content
Developers

Overview

LIGR REST API 0.0.23

Section titled “LIGR REST API 0.0.23”

The LIGR REST API drives matches, facts, graphics and streams.

Send an API key as Authorization: Bearer <key> on every request. x-ligr-api-key is the legacy header. Each operation names the scope it needs, such as matches:read or matches:write. See Authentication.

Every page below is generated from this specification. Download it at /openapi.json.

Information

  • OpenAPI version: 3.0.0

Operations

Section titled “Operations”
POST
/v2/matches/{matchId}/abandon
POST
/v2/matches/{matchId}/cancel
POST
/v1/matches
POST
/v2/matches
POST
/v2/matches/{matchId}/finish
GET
/v1/matches/{matchId}
GET
/v2/matches/{matchId}
GET
/v1/matches
GET
/v2/matches
POST
/v1/matches/{matchId}
POST
/v2/matches/{matchId}
POST
/v2/matches/{matchId}/facts
DELETE
/v2/matches/{matchId}/facts/{factId}
POST
/v2/matches/{matchId}/facts/{factId}
GET
/v2/matches/{matchId}/summary
POST
/v1/competitions
POST
/v2/competitions/{competitionId}/theme-profiles
GET
/v1/competitions/{competitionId}
GET
/v2/competitions/{competitionId}/theme-profiles/{profileId}
GET
/v1/competitions/grades
GET
/v1/competitions
GET
/v2/competitions/{competitionId}/theme-profiles
POST
/v1/teams/{teamId}/logo/uploads
POST
/v1/teams
GET
/v1/teams/{teamId}
GET
/v1/competitions/{competitionId}/teams
GET
/v1/teams
DELETE
/v1/teams/{teamId}/logo
PUT
/v1/teams/{teamId}/logo
PATCH
/v1/teams/{teamId}
POST
/v1/teams/{teamId}/players
GET
/v1/matches/{matchId}/lineup
GET
/v1/players/{playerId}
GET
/v1/players
GET
/v1/teams/{teamId}/players
PUT
/v2/matches/{matchId}/lineup
PATCH
/v1/teams/{teamId}/players/{playerId}
POST
/v1/venues
GET
/v1/venues/{venueId}
GET
/v1/venues
GET
/v1/officials/{officialId}
GET
/v1/officials
POST
/v1/overlays
GET
/v1/overlays/{overlayId}
GET
/v2/overlays/{overlayId}
POST
/v1/overlays/{overlayId}/refresh-key
POST
/v2/overlays/{overlayId}/graphics/commands
POST
/v1/overlays/{overlayId}
POST
/v2/control-rooms
POST
/v2/control-rooms/{roomId}/presets
POST
/v2/control-rooms/{roomId}/sections
GET
/v2/control-rooms/{roomId}
GET
/v2/control-rooms/{roomId}/presets/{presetId}
GET
/v2/control-rooms
GET
/v2/control-rooms/{roomId}/presets
GET
/v2/control-rooms/{roomId}/sections
PUT
/v2/control-rooms/{roomId}/presets/{presetId}
POST
/v2/overlays/{overlayId}/control-room/graphics
POST
/v1/streams/{streamSettingsId}/overlay/change
POST
/v1/streams/destinations
POST
/v1/streams/{streamId}/createAndLinkOneOffDestination
POST
/v1/streams
POST
/v1/streams/inputs
DELETE
/v1/streams/destinations/{destinationId}
DELETE
/v1/streams/{streamSettingsId}
DELETE
/v1/streams/inputs/{inputId}
GET
/v1/streams/destinations/{destinationId}
GET
/v1/streams/{streamSettingsId}
GET
/v1/streams/inputs/{inputId}
GET
/v1/streams/{streamSettingsId}/state
POST
/v1/streams/{streamSettingsId}/overlay/hide
GET
/v1/streams/destinations
GET
/v1/streams/inputs
GET
/v1/streams
POST
/v1/streams/{streamSettingsId}/overlay/refresh
POST
/v1/streams/{streamSettingsId}/input/refresh
POST
/v1/streams/{streamSettingsId}/manage
POST
/v1/streams/{streamSettingsId}/input/latency
POST
/v1/streams/{streamSettingsId}/automation
POST
/v1/streams/{streamSettingsId}/overlay/show
POST
/v1/streams/{streamSettingsId}/start
POST
/v1/streams/{streamSettingsId}/destinations/start
POST
/v1/streams/{streamSettingsId}/stop
POST
/v1/streams/{streamSettingsId}/destinations/stop
POST
/v1/streams/destinations/{destinationId}
POST
/v1/streams/{streamSettingsId}
POST
/v1/streams/inputs/{inputId}
POST
/v2/data-sources/{competitionThemeSettingId}/{alias}
PUT
/v2/themes/{themeId}/active-version
POST
/v2/themes/{themeId}/data-source-templates
POST
/v2/themes
POST
/v2/themes/{themeId}/variables
DELETE
/v2/themes/{themeId}/data-source-templates/{id}
DELETE
/v2/themes/{themeId}
DELETE
/v2/themes/{themeId}/variables/{id}
GET
/v2/themes/{themeId}
GET
/v2/themes/{themeId}/versions/{version}
GET
/v2/themes/{themeId}/data-source-templates
GET
/v2/themes/{themeId}/variables
GET
/v2/themes
POST
/v2/themes/{themeId}/versions
PATCH
/v2/themes/{themeId}/data-source-templates/{id}
PATCH
/v2/themes/{themeId}/variables/{id}
POST
/v2/themes/{themeId}/code-graphics
POST
/v2/themes/{themeId}/code-graphics/{graphicId}/uploads
GET
/v2/themes/{themeId}/code-graphics/{graphicId}
GET
/v2/themes/{themeId}/code-graphics
POST
/v2/themes/{themeId}/code-graphics/{graphicId}/versions
PUT
/v2/themes/{themeId}/code-graphics/{graphicId}/bundle
POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/elements
POST
/v2/themes/{themeId}/rive-graphics/candidates/{candidateId}/graphics
POST
/v2/themes/{themeId}/rive-graphics/imports/{jobId}/cancel
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/image-transform
POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables
POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/user-expressions
POST
/v2/themes/{themeId}/rive-graphics/images
POST
/v2/themes/{themeId}/rive-graphics/uploads
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables/{id}
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/user-expressions/{id}
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/schemas/{name}
GET
/v2/themes/{themeId}/rive-graphics/{graphicId}/files/{kind}
POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/duplicate
POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/evaluate
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/exposure
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/assets/{id}/exposure
GET
/v2/themes/{themeId}/rive-graphics/{graphicId}/preview
GET
/v2/themes/{themeId}/rive-graphics/{graphicId}
GET
/v2/themes/{themeId}/rive-graphics/{graphicId}/files/metadata
GET
/v2/themes/{themeId}/rive-graphics/capabilities
GET
/v2/themes/{themeId}/rive-graphics/imports/{jobId}
GET
/v2/themes/{themeId}/rive-graphics
POST
/v2/themes/{themeId}/rive-graphics/imports/{jobId}/prepare
POST
/v2/themes/{themeId}/rive-graphics/{graphicId}/versions
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/exposure
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/elements/{index}
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/assets/{id}
DELETE
/v2/themes/{themeId}/rive-graphics/{graphicId}/assets/{id}/exposure
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/elements/order
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/schemas/{name}
POST
/v2/themes/{themeId}/rive-graphics/imports/{jobId}/selection
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/source-array
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/assets/{id}/file
PUT
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}/image-transform
PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/control-variables/{id}
PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/data-bindings/{id}
PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/inputs/{id}
PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/user-expressions/{id}
PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/assets/{id}
PATCH
/v2/themes/{themeId}/rive-graphics/{graphicId}/settings
GET
/v2/schemas/sports/{sport}
GET
/v2/scenarios/{sport}

Authentication

Section titled “Authentication”

bearer

Section titled “bearer”

Preferred: provide your API key as Authorization: Bearer .

Security scheme type: http

api_key

Section titled “api_key”

Legacy API key header. Use Bearer authentication for new integrations.

Security scheme type: apiKey

Header parameter name: x-ligr-api-key