Video Streams Available

These endpoints list the video streams that are available to be subscribed to.

List available video streams for an organization

get
/badminton/o/{organizationId}/video/streams/available

Display the list of video streams for an organization. Streams for completed matches and those older than 12 hours, will not be displayed.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitionIdstring · uuidOptional

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
contentstring · enum · max: 30Optional

Content of the stream

  • CLEAN Output signal is the same as the input signal
  • PROGRAM Score overlays and other enhancements have been added to the stream
Example: CLEANPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
feedTypestring · enum · max: 30Optional

Type of video input

  • ADDITIONAL_ANGLE Additional angle
  • LOW_LATENCY Low Latency
  • PRIMARY Primary
Example: PRIMARYPossible values:
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr_FR
masterVenueIdstring · uuidOptional

The unique identifier of the master venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
providerstring · max: 100Optional

The unique code for the video provider

Example: Test Provider
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sourceNumberinteger · int32Optional

Unique identifier for the video source

Example: 1
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
chevron-right
200

Successful operation

application/json
get
/badminton/o/{organizationId}/video/streams/available

List available video streams for a match

get
/badminton/o/{organizationId}/fixtures/{fixtureId}/video/streams/available

Display the list of video streams for a match

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
fixtureIdstring · uuidRequired

The unique identifier of the fixture

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
organizationIdstring · min: 5 · max: 5Required

The unique identifier of the organization

Example: b1a23
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
contentstring · enum · max: 30Optional

Content of the stream

  • CLEAN Output signal is the same as the input signal
  • PROGRAM Score overlays and other enhancements have been added to the stream
Example: CLEANPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
feedTypestring · enum · max: 30Optional

Type of video input

  • ADDITIONAL_ANGLE Additional angle
  • LOW_LATENCY Low Latency
  • PRIMARY Primary
Example: PRIMARYPossible values:
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr_FR
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
providerstring · max: 100Optional

The unique code for the video provider

Example: Test Provider
sourceNumberinteger · int32Optional

Unique identifier for the video source

Example: 1
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
Responses
chevron-right
200

Successful operation

application/json
get
/badminton/o/{organizationId}/fixtures/{fixtureId}/video/streams/available

List available video streams for the ~organization group~

get
/badminton/orgGroup/{organizationGroupCode}/video/streams/available

Display the list of video streams for the organization group. Streams for completed matches and those older than 12 hours, will not be displayed.

chevron-right
lockRequired scopes
This endpoint requires the following scopes:
  • : Read any data from the organization down
Authorizations
OAuth2clientCredentialsRequired

You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.

Token URL:
Path parameters
organizationGroupCodestring · min: 3 · max: 150Required

The unique identifier of the organization group

Example: aubb
Query parameters
addedstring · date-timeOptional

Record was added after this date/time. In UTC.

Example: 2018-08-16T02:10:48
competitionIdstring · uuidOptional

The unique identifier of the competition

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
contentstring · enum · max: 30Optional

Content of the stream

  • CLEAN Output signal is the same as the input signal
  • PROGRAM Score overlays and other enhancements have been added to the stream
Example: CLEANPossible values:
externalstringOptional

A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.

Example: entityId,personId
feedTypestring · enum · max: 30Optional

Type of video input

  • ADDITIONAL_ANGLE Additional angle
  • LOW_LATENCY Low Latency
  • PRIMARY Primary
Example: PRIMARYPossible values:
fieldsstringOptional

A comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.

Example: dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]
fromTimeUTCstring · date-timeOptional

Where match start time (in UTC) >= this value

Example: 2018-08-16T18:00:00
hideNullbooleanOptional

Don't display data fields with null values or empty structures

Example: true
includestringOptional

A comma separated list of resource types to include. See Resource Inclusion for more information.

Example: organizations,fixtures,entities
limitinteger · int32 · min: 1 · max: 1000Optional

The maximum number of records to return. See Pagination for more information.

Default: 10Example: 10
localestring · min: 5 · max: 5Optional

The locale of the video

Example: fr_FR
masterVenueIdstring · uuidOptional

The unique identifier of the master venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
offsetinteger · int32Optional

The offset of the records. See Pagination for more information.

Example: 10
providerstring · max: 100Optional

The unique code for the video provider

Example: Test Provider
seasonIdstring · uuidOptional

The unique identifier of the season

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
sourceNumberinteger · int32Optional

Unique identifier for the video source

Example: 1
toTimeUTCstring · date-timeOptional

Where match start time (in UTC) <= this value

Example: 2018-08-16T18:00:00
updatedstring · date-timeOptional

Record was modified after this date/time. In UTC.

Example: 2018-08-16T02:11:48
venueIdstring · uuidOptional

The unique identifier of the venue

Example: 009e9276-5c80-11e8-9c2d-fa7ae01bbebc
Responses
chevron-right
200

Successful operation

application/json
get
/badminton/orgGroup/{organizationGroupCode}/video/streams/available

Last updated

Was this helpful?