Common Data Format - Meta Data Schema

Type: object

Version 0.2.2

This schema defines the Meta Data as described in the Common Data Format paper.

root competition
Type: object

root competition id
Type: string

Unique identifier for the competition

root competition name
Type: string

Name of the competition

root competition format
Type: string

Format of the competition (e.g., 'league18', 'league20')

root competition age_restriction
Type: string or null

Age restriction for the competition (e.g., 'U18', 'U20')

root competition type
Type: string

Type of competition (e.g., 'youth', 'mens', 'womens')

root season
Type: object

root season id
Type: string

Unique identifier for the season

root season name
Type: string

Season name (e.g., '2022/23')

root match
Type: object

root match id
Type: string

Unique identifier for the match

root match kickoff_time
Type: stringFormat: date-time

Scheduled kickoff time in UTC

root match periods
Type: array of object
No Additional Items

Each item of this array must be:

root match periods periods items
Type: object

root match periods periods items period
Type: enum (of string)

Must be one of:

  • "first_half"
  • "second_half"
  • "first_half_extratime"
  • "second_half_extratime"
  • "shootout"

root match periods periods items play_direction
Type: enum (of string)

The direction of play for the home team

Must be one of:

  • "left_right"
  • "right_left"

root match periods periods items time_start
Type: stringFormat: date-time

Start time of the period in UTC

root match periods periods items time_end
Type: stringFormat: date-time

End time of the period in UTC

root match periods periods items frame_id_start
Type: integer

Frame ID at the start of the period

root match periods periods items frame_id_end
Type: integer

Frame ID at the start of the period

root match periods periods items left_team_id
Type: string

Unique team identifier of the team playing on the left side of the pitch in this period. The leftteamid and rightteamid should be the actual, nonstandardized sides.

root match periods periods items right_team_id
Type: string

Unique team identifier of the team playing on the left side of the pitch in this period. The leftteamid and rightteamid should be the actual, nonstandardized sides.

root match whistles
Type: array of object

Whistles that start and end major periods of play

 No Additional Items

Each item of this array must be:

root match whistles whistles items
Type: object

root match whistles whistles items type
Type: string

Examples of types 'firsthalf', 'secondhalf', 'weatherdelay', 'healthdelay', 'injurytreatment', 'fanhealth_delay' etc.

root match whistles whistles items sub_type
Type: string

Sub type related to an interruption, for example 'start' or 'end'

root match whistles whistles items time
Type: stringFormat: date-time

The time in UTC of the whistle

root match round
Type: string

Round of the match (e.g. 1, 2, 3, final, semi_final)

root match scheduled_kickoff_time
Type: stringFormat: date-time

Scheduled kickoff time in UTC

root match local_kickoff_time
Type: stringFormat: date-time

Local kickoff time

root match misc
Type: object

root match misc country
Type: string

Country where the match is played

root match misc city
Type: string

City where the match is played

root match misc percipitation
Type: number

Percipitation during the match in millimetres

root match misc is_open_roof
Type: boolean

Indicates if the roof is open (true) or closed (false)

root teams
Type: object

root teams home
Type: object

root teams home id
Type: string

Unique identifier for the home team

root teams home players
Type: array of object
No Additional Items

Each item of this array must be:

root teams home players players items
Type: object

root teams home players players items id
Type: string

Unique player identifier

root teams home players players items team_id
Type: string

Unique team identifier denoting the team the player plays for

root teams home players players items jersey_number
Type: integer

Jersey number for a player

root teams home players players items is_starter
Type: boolean

Denotes whether a player started the game (true) or not (false)

root stadium
Type: object

root stadium id
Type: string

Unique identifier for the stadium

root stadium pitch_length
Type: number or null

Length of the pitch in metres, null if not available

root stadium pitch_width
Type: number or null

Width of the pitch in metres, null if not available

root stadium name
Type: string

Name of the stadium

root stadium turf
Type: string

Information on the turf of the pitch (e.g., 'grass', 'natural_reinforced')

root meta
Type: object

root meta video
Type: object or null

Video meta data information, null if not relevant

root meta video perspective
Type: string

Camera perspective (e.g. in 'stadium', 'broadcast', 'tactical', 'tactical_wide')

root meta video version
Type: string

Version number for the video data collection in use (e.g. '0.1.0')

root meta video name
Type: string

Vendor name of the video data

root meta video fps
Type: integer

Frames per second (i.e., frame rate) of video

root meta event
Type: object or null

Event data meta information, null if not relevant

root meta event collection_timing
Type: string

Indicates if the event data was collected live or post match

root meta tracking
Type: object or null

Tracking data meta information, null if not relevant

root meta tracking version
Type: string

Version number for the tracking data collection in use (e.g. '0.1.0')

root meta tracking name
Type: string

Vendor name of the tracking data

root meta tracking fps
Type: integer

Frames per second (i.e., frame rate) of tracking

root meta tracking collection_timing
Type: string

Indicates if the tracking data was collected live or post match

root meta landmarks
Type: object or null

Landmark tracking data meta information, null if not relevant

root meta landmarks version
Type: string

Version number for the landmark data collection in use (e.g. '0.1.0')

root meta landmarks name
Type: string

Vendor name of the landmark tracking data

root meta landmarks fps
Type: integer

Frames per second (i.e., frame rate) of landmark tracking

root meta landmarks collection_timing
Type: string

Indicates if the limb data was collected live or post match

root meta ball
Type: object or null

Ball tracking data meta information, null if not relevant. Only relevant when providing an independent ball file.

root meta ball version
Type: string

Version number for the ball data collection in use

root meta ball name
Type: string

Vendor name of the ball data

root meta ball fps
Type: integer

Frames per second (i.e., frame rate) of ball tracking

root meta ball collection_timing
Type: string

Indicates if the ball data was collected live or post match

root meta meta
Type: object or null

Meta information

root meta meta version
Type: string

Version number for the meta data collection in use

root meta meta name
Type: string

Vendor name of the meta data

root meta cdf
Type: object or null

Common Data Format (CDF) meta information

root meta cdf version
Type: string

Version number for the CDF in use