openapi: 3.1.0
info:
title: SOCCER API
version: '1.0'
description: SOCCER API - OpenAPI 3.1 Specification
servers:
- url: https://api.sportsdata.io
description: Production server
paths:
/v4/soccer/scores/{format}/GamesByDate/{competition}/{date}:
get:
description: Full scores and gameday info delivered live and post-game. Live
data includes half and score info. Gameday info includes weather, TV channel
etc
operationId: soccer_v4_scores_games___by_date__live___final
summary: Games - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Game'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/Areas:
get:
description: A list of countries, continents etc. for finding their respective
competitions.
operationId: soccer_v4_scores_areas__countries
summary: Areas (Countries)
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Area'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/Competitions:
get:
description: A list of all competitions (leagues, cups etc.) and their associated
countries or areas.
operationId: soccer_v4_scores_competitions__leagues
summary: Competitions (Leagues)
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Competition'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/Teams/{competition}:
get:
description: 'Full team information: team name and city, conference and division,
and colors. Also contains basic fantasy info such as IDs as well as full stadium
data. This endpoint returns the teams ever associated with a competition;
use Team Profiles - by Season for just the current ones.'
operationId: soccer_v4_scores_team_profiles___by_competition
summary: Team Profiles - by Competition
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Team'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/Venues:
get:
description: Stadium information from across the world
operationId: soccer_v4_scores_venues
summary: Venues
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Venue'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/SeasonTeams/{competition}/{seasonid}:
get:
description: 'Full team information: team name and city, conference and division,
and colors. Also contains basic fantasy info such as IDs as well as full stadium
data. This endpoint returns the teams currently associated with a competition''s
active season; use Team Profiles - by Competition for all-time (e.g. teams
since relegated from the EPL.)'
operationId: soccer_v4_scores_team_profiles___by_season
summary: Team Profiles - by Season
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: seasonid
in: path
description: "Unique FantasyData Season ID. SeasonIDs can be found in the\
\ Competition Hierarchy (League Hierarchy). \nExamples: 1,\
\ 2, 3, etc"
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/SeasonTeam'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/Schedule/{competition}/{season}:
get:
description: Home and away teams, date and time, season type and week etc. are
included. Also includes gameday information. This includes full stadium information
(capacity, lat/long, surface etc.), top-line betting information (spread,
moneyline, total), weather conditions, and broadcast information.
operationId: soccer_v4_scores_schedules
summary: Schedules
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Round'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/PlayersByTeam/{competition}/{teamid}:
get:
description: Full player bio and details, including injury notes, for all available
players by team.
operationId: soccer_v4_scores_player_details___by_team
summary: Player Details - by Team
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: teamid
in: path
description: "Unique FantasyData Team ID. \nExample:516."
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Player'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/TeamSeasonStats/{competition}/{season}:
get:
description: Returns all season-long stats (i.e. the season total, not each
individual game record) for all teams (aggregated from all players) for a
given season.
operationId: soccer_v4_scores_team_season_stats
summary: Team Season Stats
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Round'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/TeamGameStatsByDate/{competition}/{date}:
get:
description: Returns the box score statistical record team-wide (aggregated
from all players) for all games on a given date within a competition, both
live and post-game.
operationId: soccer_v4_scores_team_game_stats___by_date__live___final
summary: Team Game Stats - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/Standings/{competition}/{season}:
get:
description: Includes regular season standings in a given league or tournament
and season.
operationId: soccer_v4_scores_standings
summary: Standings
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Round'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/CompetitionDetails/{competition}:
get:
description: Full scores and gameday info delivered live and post-game. Live
data includes half and score info, delivered by competition.
operationId: soccer_v4_scores_games___by_competition__live___final
summary: Games - by Competition [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CompetitionDetail'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/HistoricalMembershipsByTeam/{competition}/{teamid}:
get:
description: Historical memberships of a team, i.e. players who were once on
the roster but have since left.
operationId: soccer_v4_scores_memberships_historical___by_team
summary: Memberships Historical - by Team
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: teamid
in: path
description: "Unique FantasyData Team ID. \nExample:516."
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Membership'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/ActiveMemberships/{competition}:
get:
description: Players currently active on teams within a specified competition.
operationId: soccer_v4_scores_memberships___by_active
summary: Memberships - by Active
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Membership'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/RecentlyChangedMemberships/{competition}/{days}:
get:
description: A list of all recently changed memberships (e.g. player transfers,
releases) for a given competition, called by number of days ago.
operationId: soccer_v4_scores_memberships___by_recently_changed
summary: Memberships - by Recently Changed
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: days
in: path
description: 'The number of days since memberships were updated. For example,
if you pass 3, you''ll receive all memberships that have been
updated in the past 3 days. Valid entries are: 1, 2
... 30'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Membership'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/CanceledMemberships:
get:
description: Memberships (players' membership of a team) that have since been
revoked by our system.
operationId: soccer_v4_scores_memberships___by_canceled
summary: Memberships - by Canceled
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/CanceledMembership'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/SchedulesBasic/{competition}/{season}:
get:
description: A lightweight schedule endpoint without gameday information. Home
and away teams, the date and time of the game, and season type, week etc.
are included. Ideal for the most basic information required to build a schedule.
operationId: soccer_v4_scores_schedules__basic
summary: Schedules (Basic)
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScheduleBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/ScoresBasic/{competition}/{date}:
get:
description: Full scores and gameday info delivered live and post-game, called
by date and competition.
operationId: soccer_v4_scores_games__basic____by_date__live___final
summary: Games (Basic) - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScoreBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/PlayersByTeamBasic/{competition}/{teamid}:
get:
description: Roster information for a given team. Player profiles include basic
biographical information, position, etc. Specify a TeamId parameter to receive
all players currently on that team.
operationId: soccer_v4_scores_player_profiles___by_team
summary: Player Profiles - by Team
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: teamid
in: path
description: "Unique FantasyData Team ID. \nExample:516."
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/GamesByDateFinal/{competition}/{date}:
get:
description: Full scores and gameday info, as well as half and full-time score,
delivered post-game.
operationId: soccer_v4_scores_games___by_date__final
summary: Games - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Game'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/scores/{format}/ScoresBasicFinal/{competition}/{date}:
get:
description: The most top-line full-time information, ideal for basic applications,
called by competition and date, delivered post-game.
operationId: soccer_v4_scores_games__basic____by_date__final
summary: Games (Basic) - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ScoreBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Scores
/v4/soccer/headshots/{format}/Headshots:
get:
description: USA Today/IMAGN cropped action headshots for all active MLS players
only, delivered shortly after the season starts.
operationId: soccer_v4_headshots_headshots
summary: Headshots
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Headshot'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Headshots
/v4/soccer/projections/{format}/PlayerGameProjectionStatsByDate/{competition}/{date}:
get:
description: SportsDataIO's proprietary projections, including DFS salary information
and injuries, for fantasy players, called by date.
operationId: soccer_v4_projections_projected_player_game_stats___by_date
summary: Projected Player Game Stats - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerGameProjection'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Projections
/v4/soccer/projections/{format}/DfsSlatesByDate/{competition}/{date}:
get:
description: Returns DFS Slates which have not yet started, with their player
and salary information.
operationId: soccer_v4_projections_dfs_slates___by_date
summary: DFS Slates - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2020-02-18
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DfsSlate'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Projections
/v4/soccer/projections/{format}/UpcomingDfsSlatesByCompetition/{competition}:
get:
description: Returns upcoming DFS Slates which have not yet started, with their
player and salary information, by competition.
operationId: soccer_v4_projections_upcoming_dfs_slates___by_competition
summary: Upcoming DFS Slates - by Competition
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DfsSlate'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Projections
/v4/soccer/projections/{format}/InjuredPlayers/{competition}:
get:
description: This endpoint provides all currently injured soccer players by
competition, along with injury details.
operationId: soccer_v4_projections_player_details___by_injured
summary: Player Details - by Injured
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Player'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Projections
/v4/soccer/stats/{format}/BoxScoresByDate/{competition}/{date}:
get:
description: Full statistical information for a specified game, down to the
team and player stat level, delivered live during the games, called for all
games on a given date within a competition.
operationId: soccer_v4_stats_box_scores___by_date__live___final
summary: Box Scores - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BoxScore'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/BoxScoresDeltaByDate/{competition}/{date}/{minutes}:
get:
description: This method returns all box scores for a given date in a given
competition, but only returns player stats that have changed in the last X
minutes as specified in your API call. By definition this is a live endpoint,
not final.
operationId: soccer_v4_stats_box_scores_delta___by_date
summary: Box Scores Delta - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
- name: minutes
in: path
description: 'Only returns player statistics that have changed in the last
X minutes. You specify how many minutes in time to go back. Valid entries
are:
1, 2 ... all.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BoxScore'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/BoxScore/{competition}/{gameid}:
get:
description: Full statistical information for a specified game, down to the
team and player stat level, delivered live during the game, called per individual
game.
operationId: soccer_v4_stats_box_score__live___final
summary: Box Score [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 702, 1274, etc.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BoxScore'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/PlayerGameStatsByDate/{competition}/{date}:
get:
description: Returns the box score statistical record for all involved players
across all teams' games on a given date in a given competition, both live
and after each game has concluded.
operationId: soccer_v4_stats_player_game_stats___by_date__live___final
summary: Player Game Stats - by Date [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/PlayerSeasonStats/{competition}/{season}:
get:
description: Returns all season-long stats (i.e. the season total, not each
individual game record) for all players for a given season.
operationId: soccer_v4_stats_player_season_stats
summary: Player Season Stats
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Round'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/BoxScoreFinal/{competition}/{gameid}:
get:
description: Full statistical information for a specified game, down to the
team and player stat level, delivered after the game is complete.
operationId: soccer_v4_stats_box_score__final
summary: Box Score [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 702, 1274, etc.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BoxScore'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/BoxScoresFinal/{competition}/{date}:
get:
description: Full statistical information for a specified date for each game
that took place, down to the team and player stat level, delivered after the
game is complete.
operationId: soccer_v4_stats_box_scores___by_date__final
summary: Box Scores - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BoxScore'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/LineupsByDate/{competition}/{date}:
get:
description: Projected and confirmed starting XIs and substitute benches for
a given competition on a given date.
operationId: soccer_v4_stats_lineups___by_date
summary: Lineups - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerGameBasic'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/PlayerGameStatsByDateFinal/{competition}/{date}:
get:
description: Returns the box score statistical record for all involved players
across all teams' games for a given competition on a given date after each
game has concluded.
operationId: soccer_v4_stats_player_game_stats___by_date__final
summary: Player Game Stats - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/PlayerGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/TeamGameStatsByDateFinal/{competition}/{date}:
get:
description: Returns the box score statistical record team-wide (aggregated
from all players) for a games in a given competition on a given date, updated
as each game has concluded.
operationId: soccer_v4_stats_team_game_stats___by_date__final
summary: Team Game Stats - by Date [Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/stats/{format}/FantasyGameStatsByDate/{competition}/{date}:
get:
description: A simple list of fantasy points awarded to players who took part
in a given competition's games on a given date.
operationId: soccer_v4_stats_fantasy_points___by_date
summary: Fantasy Points - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2017-02-27, 2017-09-01.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/FantasyGame'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Stats
/v4/soccer/odds/{format}/GameOddsLineMovement/{competition}/{gameid}:
get:
description: Returns the non-full-game odds (spread, moneyline, total) for games
on a given date. Non-full-game means 1st-half or 1st-quarter, for example,
rather than full game. Returns the full line movement for the given game within
a competition. This endpoint has a longer cache as it is meant for historical
data/line movement rather than the most up to the second line.
operationId: soccer_v4_odds_pre_game_odds_line_movement
summary: Pre-Game Odds Line Movement
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 14060, 14061, etc.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/LiveGameOddsLineMovement/{competition}/{gameid}:
get:
description: Returns in-play game odds (spread, moneyline, total) for a given
game in a given competition. Returns the full line movement for the given
game. This endpoint has a longer cache as it is meant for historical data/line
movement rather than the most up to the second line.
operationId: soccer_v4_odds_in_game_odds_line_movement
summary: In-Game Odds Line Movement
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 14060, 14061, etc.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/GameOddsByDate/{competition}/{date}:
get:
description: Returns full game odds (spread, moneyline, total) for games from
a given competition on a given date. Only returns the most recently seen odds,
not inclusive of line movement.
operationId: soccer_v4_odds_pre_game_odds___by_date
summary: Pre-Game Odds - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: "The date of the game(s). \n
Examples: 2017-02-27,\
\ 2017-09-01."
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/ActiveSportsbooks:
get:
description: A list of all available sportsbooks with their associated unique
IDs.
operationId: soccer_v4_odds_sportsbooks___by_active
summary: Sportsbooks - by Active
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Sportsbook'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingEventsBySeason/{competition}/{season}:
get:
description: The list of current BettingEvents for the given season within a
given competition, from which Betting Market data can be gathered via the
Betting Markets by Event endpoint, for all available Betting Market types
(e.g. Player Props, Team Props.)
operationId: soccer_v4_odds_betting_events___by_season
summary: Betting Events - by Season
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingEvent'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingFuturesBySeason/{competition}/{season}:
get:
description: Returns available Futures markets for the given season and a given
competition. Does not include line movement.
operationId: soccer_v4_odds_betting_futures___by_season
summary: Betting Futures - by Season
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingEvent'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarket/{competition}/{marketId}:
get:
description: Returns full line movement for a given BettingMarket. Due to the
sheer size of the output and the level of detail, it is intended for historical
data purposes and not for the most up-to-the-second lines.
operationId: soccer_v4_odds_betting_market
summary: Betting Market
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: marketId
in: path
description: The MarketId of the desired market for which to pull all outcomes/bets.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarkets/{competition}/{eventId}:
get:
description: Returns the markets of all available types (e.g. Player Props,
Team Props) and available outcomes for a given BettingEventID within a given
competition.
operationId: soccer_v4_odds_betting_markets___by_event
summary: Betting Markets - by Event
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: eventId
in: path
description: 'The EventId of the desired event/game for which to pull all
betting markets (includes outcomes/bets).
'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarketsByGameID/{competition}/{gameid}:
get:
description: Returns the markets of all available types (e.g. Player Props,
Team Props) and available outcomes for a given GameID within a given competition.
operationId: soccer_v4_odds_betting_markets___by_game
summary: Betting Markets - by Game
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of the desired game for which to pull all betting
markets (includes outcomes/bets).
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarketsByMarketType/{competition}/{eventId}/{marketTypeID}:
get:
description: Returns Markets and available outcomes for a given event (within
a competition) and market type requested. A lighter call than by BettingEventID
as it only includes markets tagged with the specific MarketType, a full list
of which is available for each sport in its Betting Metadata endpoint.
operationId: soccer_v4_odds_betting_markets___by_market_type
summary: Betting Markets - by Market Type
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: eventId
in: path
description: The EventId of the desired event/game for which to pull all betting
markets (includes outcomes/bets).
required: true
schema:
type: string
- name: marketTypeID
in: path
description: 'The Market Type ID of the desired MarketTypes to pull. Some
common types include: 1 for Game Lines, 2 for
Player Props, 3 for Team Props, 6 for Game Props'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMetadata:
get:
description: Returns the list of MarketTypes, BetTypes, PeriodTypes, OutcomeTypes,
and ResultTypes to map the IDs to descriptive names. Also includes a list
of the MarketType, BetType & PeriodType combinations which we will have resulting
for.
operationId: soccer_v4_odds_betting_metadata
summary: Betting Metadata
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BettingEntityMetadataCollection'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingEventsByDate/{competition}/{date}:
get:
description: The list of current BettingEvents for the given date and competition,
from which Betting Market data can be gathered via the Betting Markets by
Event endpoint, for all available Betting Market types (e.g. Player Props,
Team Props.)
operationId: soccer_v4_odds_betting_events___by_date
summary: Betting Events - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2018-11-20,
2018-11-23.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingEvent'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingPlayerPropsByGameID/{competition}/{gameId}:
get:
description: This works in the same way as Betting Markets by Market Type but
is prefiltered to the Player Props type only. Ideal if your application will
only ever require Player Props, but if you also want Team Props etc. it is
recommended to use the by Market Type endpoint.
operationId: soccer_v4_odds_betting_player_props___by_game
summary: Betting Player Props - by Game
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameId
in: path
description: The unique GameID of the game in question.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/AlternateMarketGameOddsLineMovement/{competition}/{gameid}:
get:
description: Returns the non-full-game odds (spread, moneyline, total) for games
on a given date. Non-full-game means 1st-half or 1st-quarter, for example,
rather than full game. Returns the full line movement for the given game within
a competition. This endpoint has a longer cache as it is meant for historical
data/line movement rather than the most up to the second line.
operationId: soccer_v4_odds_period_game_odds_line_movement
summary: Period Game Odds Line Movement
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 41323
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/LiveGameOddsByDate/{competition}/{date}:
get:
description: Returns in-play game odds (spread, moneyline, total) for games
on a given date in a given competition. Only returns the most recently seen
odds, not inclusive of line movement. As this is in-game, it will only return
results while the game is in progress.
operationId: soccer_v4_odds_in_game_odds___by_date
summary: In-Game Odds - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2018-06-20,
2018-06-23.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/AlternateMarketGameOddsByDate/{competition}/{date}:
get:
description: Returns the non-full-game odds (spread, moneyline, total) for games
on a given date in a given competition. Non-full-game means 1st-half or 1st-quarter,
for example, rather than full game. Only returns the most recently seen odds,
not inclusive of line movement.
operationId: soccer_v4_odds_period_game_odds___by_date
summary: Period Game Odds - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: "The date of the game(s). \n
Examples: 2017-02-27,\
\ 2017-09-01."
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/PreGameOddsByDate/{competition}/{date}/{sportsbookgroup}:
get:
description: Returns the full-game and non-full-game odds (spread, moneyline,
total) for games on a given date for a given competition. Only returns the
most recently seen odds, not inclusive of line movement. A Sportsbook Group
must be specified as a URL parameter.
operationId: soccer_v4_odds_pre_game_and_period_game_odds___by_date__sportsbook_group
summary: Pre-Game and Period Game Odds - by Date [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: "The date of the game(s). \n
Examples: 2017-02-27,\
\ 2017-09-01."
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/InGameOddsByDate/{competition}/{date}/{sportsbookgroup}:
get:
description: Returns in-play game odds (spread, moneyline, total) for games
on a given date and competition. Only returns the most recently seen odds,
not inclusive of line movement. As this is in-game, it will only return results
while the game is in progress. A Sportsbook Group must be specified as a URL
parameter.
operationId: soccer_v4_odds_in_game_odds___by_date__sportsbook_group
summary: In-Game Odds - by Date [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: date
in: path
description: 'The date of the game(s).
Examples: 2018-06-20,
2018-06-23.'
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/PreGameOddsLineMovement/{competition}/{gameid}/{sportsbookgroup}:
get:
description: Returns the game odds for a given game in a given competition.
In this endpoint both full-game and partial-game odds are included. Returns
the full line movement for the given game. This endpoint has a longer cache
as it is meant for historical data/line movement rather than the most up to
the second line. A Sportsbook Group must be specified as a URL parameter.
operationId: soccer_v4_odds_pre_game_and_period_game_odds_line_movement__sportsbook_group
summary: Pre-Game and Period Game Odds Line Movement [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 14060, 14061, etc.
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/InGameOddsLineMovement/{competition}/{gameid}/{sportsbookgroup}:
get:
description: Returns in-play game odds (spread, moneyline, total) for a given
game and competition. Returns the full line movement for the given game. This
endpoint has a longer cache as it is meant for historical data/line movement
rather than the most up to the second line. A Sportsbook Group must be specified
as a URL parameter.
operationId: soccer_v4_odds_in_game_odds_line_movement__sportsbook_group
summary: In-Game Odds Line Movement [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 14060, 14061, etc.
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/PreGameOddsLineMovementWithResulting/{competition}/{gameid}/{sportsbookgroup}:
get:
description: 'Returns the game odds for a given game and competition. In this
endpoint both full-game and partial-game odds are included. This also includes
Resulting: for markets with a ResultType, each line will be graded and it
will be determined whether the bet would have won or lost. Returns the full
line movement for the given game. This endpoint has a longer cache as it is
meant for historical data/line movement rather than the most up to the second
line. A Sportsbook Group must be specified as a URL parameter.'
operationId: soccer_v4_odds_pre_game_and_period_game_odds_line_movement_with_resulting__sportsbook_group
summary: Pre-Game and Period Game Odds Line Movement with Resulting [Sportsbook
Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 14060, 14061, etc.
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfoResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/InGameOddsLineMovementWithResulting/{competition}/{gameid}/{sportsbookgroup}:
get:
description: 'Returns in-play game odds (spread, moneyline, total) for a given
game in a competition. This also includes Resulting: for markets with a ResultType,
each line will be graded and it will be determined whether the bet would have
won or lost. Returns the full line movement for the given game. This endpoint
has a longer cache as it is meant for historical data/line movement rather
than the most up to the second line. A Sportsbook Group must be specified
as a URL parameter.'
operationId: soccer_v4_odds_in_game_odds_line_movement_with_resulting__sportsbook_group
summary: In-Game Odds Line Movement with Resulting [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of a Soccer game. GameIDs can be found in the Games
API. Valid entries are 14060, 14061, etc.
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/GameInfoResult'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingFuturesBySeason/{competition}/{season}/{sportsbookgroup}:
get:
description: Returns available Futures markets for the given season. Does not
include line movement. A Sportsbook Group must be specified as a URL parameter.
operationId: soccer_v4_odds_betting_futures___by_season__sportsbook_group
summary: Betting Futures - by Season [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: season
in: path
description: 'Year of the season
Examples: 2020, 2021,
etc.'
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingEvent'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarket/{competition}/{marketId}/{sportsbookgroup}:
get:
description: Returns full line movement for a given BettingMarket. Due to the
sheer size of the output and the level of detail, it is intended for historical
data purposes and not for the most up-to-the-second lines. A Sportsbook Group
must be specified as a URL parameter.
operationId: soccer_v4_odds_betting_market__sportsbook_group
summary: Betting Market [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: marketId
in: path
description: The MarketId of the desired market for which to pull all outcomes/bets.
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarketsByEvent/{competition}/{eventId}/{sportsbookgroup}:
get:
description: Returns the markets and available outcomes for a given BettingEventID.
A Sportsbook Group must be specified as a URL parameter.
operationId: soccer_v4_odds_betting_markets___by_event__sportsbook_group
summary: Betting Markets - by Event [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: eventId
in: path
description: 'The EventId of the desired event/game for which to pull all
betting markets (includes outcomes/bets).
'
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarketsByGameID/{competition}/{gameid}/{sportsbookgroup}:
get:
description: Returns the markets of all available types (e.g. Player Props,
Team Props) and available outcomes for a given GameID in a competition. A
Sportsbook Group must be specified as a URL parameter.
operationId: soccer_v4_odds_betting_markets___by_game__sportsbook_group
summary: Betting Markets - by Game [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameid
in: path
description: The GameID of the desired game for which to pull all betting
markets (includes outcomes/bets).
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingMarketsByMarketType/{competition}/{eventId}/{marketTypeID}/{sportsbookgroup}:
get:
description: Returns Markets and available outcomes for a given event and market
type requested. A lighter call than by BettingEventID as it only includes
markets tagged with the specific MarketType, a full list of which is available
for each sport in its Betting Metadata endpoint. A Sportsbook Group must be
specified as a URL parameter.
operationId: soccer_v4_odds_betting_markets___by_market_type__sportsbook_group
summary: Betting Markets - by Market Type [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: eventId
in: path
description: The EventId of the desired event/game for which to pull all betting
markets (includes outcomes/bets).
required: true
schema:
type: string
- name: marketTypeID
in: path
description: 'The Market Type ID of the desired MarketTypes to pull. Some
common types include: 1 for Game Lines, 2 for
Player Props, 3 for Team Props, 6 for Game Props'
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
/v4/soccer/odds/{format}/BettingPlayerPropsByGameID/{competition}/{gameId}/{sportsbookgroup}:
get:
description: This works in the same way as Betting Markets by Market Type but
is prefiltered to the Player Props type only. Ideal if your application will
only ever require Player Props, but if you also want Team Props etc. it is
recommended to use the by Market Type endpoint. A Sportsbook Group must be
specified as a URL parameter.
operationId: soccer_v4_odds_betting_player_props___by_game__sportsbook_group
summary: Betting Player Props - by Game [Sportsbook Group]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are JSON
or XML.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: competition
in: path
description: 'An indication of a soccer competition/league. This value can
be the CompetitionId or the Competition Key. Possible values include: EPL,
1, MLS, 8, etc.'
required: true
schema:
type: string
- name: gameId
in: path
description: The unique GameID of the game in question.
required: true
schema:
type: string
- name: sportsbookgroup
in: path
description: 'The name of the Sportsbook grouping.
Examples: G1100'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- Soccer v4 Odds
components:
schemas:
Unauthorized:
properties:
HttpStatusCode:
type: integer
Code:
type: integer
Description:
type: string
Help:
type: string
Game:
properties:
GameId:
type: integer
description: The unique ID of the game
RoundId:
type: integer
description: The unique ID of the round that this game is associated with.
Season:
type: integer
description: The soccer regular season for which these totals apply
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Group:
type:
- string
- 'null'
description: 'The name of the group in which this game occurs. Note: This
is used in tournaments & cups'
AwayTeamId:
type:
- integer
- 'null'
description: The unique ID of the away team
HomeTeamId:
type:
- integer
- 'null'
description: The unique ID of the home team
VenueId:
type:
- integer
- 'null'
description: The unique ID of the venue
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (in UTC)
Status:
type:
- string
- 'null'
description: 'Indicates the game''s status. Possible values include: Scheduled,
InProgress, Break, Final, Awarded, Postponed, Canceled, Suspended. If
a game is called off before it starts, the Status is set to Postponed,
until a new date/time is scheduled, at which point, the DateTime is updated,
and the Status is set back to Scheduled. If a game has already started,
and temporarily interrupted, it''s Status is set to Suspended, until it
either resumes, or gets postponed and replayed at a later date. If the
game is at halftime, then the Status will be Break. Awarded is used in
cases where a game is decided on the so called "green table." That means
that a game was decided by the Federation/League to one team for a reason.
This can include situations like riots, where the opponent team gets 3:0
win awarded as punishment. Awarded is also used when a club withdraws
during the season from the competition then all the remaining matches
getting awarded 3:0.'
Week:
type:
- integer
- 'null'
description: The week during the season/round in which this game occurs
Period:
type:
- string
- 'null'
description: 'The final period of the game. Possible values: Regular = Game
ended in 90 minutes of regular time; ExtraTime = Game ended in extra time
/ overtime; PenaltyShootout = Game finished in penalty shootout time'
Clock:
type:
- integer
- 'null'
description: 'The clock for the game if it is in progress. Note: if the
game hasn''t started or the game is over; then this will be NULL'
Winner:
type:
- string
- 'null'
description: 'The winner of the game. Possible values: AwayTeam; HomeTeam;
Draw'
VenueType:
type:
- string
- 'null'
description: 'Shows which team has home field advantage. Possible values:
Home; Away; Neutral'
AwayTeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the away team
AwayTeamName:
type:
- string
- 'null'
description: The name of the away team
AwayTeamCountryCode:
type:
- string
- 'null'
description: The country code of the away team.
AwayTeamScore:
type:
- integer
- 'null'
description: The final score of the away team
AwayTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the away team.
AwayTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the away team.
AwayTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the away team (if applicable).
AwayTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the away team (if applicable).
HomeTeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the home team
HomeTeamName:
type:
- string
- 'null'
description: The name of the home team
HomeTeamCountryCode:
type:
- string
- 'null'
description: The country code of the home team
HomeTeamScore:
type:
- integer
- 'null'
description: The final score of the home team
HomeTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the home team
HomeTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the home team
HomeTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the home team (if applicable)
HomeTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the home team (if applicable)
HomeTeamMoneyLine:
type:
- integer
- 'null'
description: Payout on a bet that the away home wins
AwayTeamMoneyLine:
type:
- integer
- 'null'
description: Payout on a bet that the away team wins.
DrawMoneyLine:
type:
- integer
- 'null'
description: The sportsbook's money line for a draw
PointSpread:
type:
- number
- 'null'
description: Point spread for the home team
HomeTeamPointSpreadPayout:
type:
- integer
- 'null'
description: Payout if the home team covers the spread
AwayTeamPointSpreadPayout:
type:
- integer
- 'null'
description: Payout if the away team covers the spread
OverUnder:
type:
- number
- 'null'
description: The sportsbook's total goals line (over/under) for the game
OverPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for the over bet on the total goals
line
UnderPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for the under
Attendance:
type:
- integer
- 'null'
description: The attendance for the game.
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when this record was updated (in UTC)
GlobalGameId:
type: integer
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalAwayTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the away team. This value is guaranteed
to be unique across all sports/leagues.
GlobalHomeTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the home team. This value is guaranteed
to be unique across all sports/leagues.
ClockExtra:
type:
- integer
- 'null'
description: 'The added stoppage time minute the game is currently in. Note:
will be null when game is not in stoppage time'
ClockDisplay:
type:
- string
- 'null'
description: 'A convenient string display of the current clock with format
Clock+ClockExtra (example: 90+3)'
IsClosed:
type:
- boolean
- 'null'
description: Indicates whether the game is over and the final score and
stats have been verified and closed out
HomeTeamFormation:
type:
- string
- 'null'
description: The formation for the home team (4-4-2; 4-3-3; etc.)
AwayTeamFormation:
type:
- string
- 'null'
description: The formation for the away team (4-4-2, 4-3-3, etc.)
PlayoffAggregateScore:
$ref: '#/components/schemas/PlayoffAggregateScore'
description: Aggregate scoring information for 2-leg/home-and-home games
(i.e. Champions League Round of 16). Team A is determined by the first
legs home team.
PlayoffAggregateScore:
properties:
TeamA_Id:
type: integer
description: 'The TeamID of Team A. Note: Team A is determined by the home
team in the first leg, and remains set through the life of the record'
TeamA_AggregateScore:
type: integer
description: 'The score, on aggregate, of Team A in the matchup. Note: Team
A is determined by the home team in the first leg, and remains set through
the life of the record'
TeamB_Id:
type: integer
description: 'The TeamID of Team B. Note: Team B is determined by the away
team in the first leg, and remains set through the life of the record'
TeamB_AggregateScore:
type: integer
description: 'The score, on aggregate, of Team B in the matchup. Note: Team
B is determined by the away team in the first leg, and remains set through
the life of the record'
WinningTeamId:
type: integer
description: The ID of the team that wins the home-and-home matchup
Created:
type:
- string
- 'null'
description: Date and time the record was created (in US Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (in US Eastern
Time)
Area:
properties:
AreaId:
type: integer
description: The unique ID of the area
CountryCode:
type:
- string
- 'null'
description: The 3-digit country or continent code where the area is located
Name:
type:
- string
- 'null'
description: The display name of the area
Competitions:
type: array
items:
$ref: '#/components/schemas/Competition'
description: The competitions that are associated with and/or played in
the area
Competition:
properties:
CompetitionId:
type: integer
description: The unique ID of the competition/league
AreaId:
type: integer
description: The unique ID of the area where this competition/league is
played
AreaName:
type:
- string
- 'null'
description: The display name of the area where this competition/league
is played
Name:
type:
- string
- 'null'
description: The display name of the competition/league
Gender:
type:
- string
- 'null'
description: 'The gender of the players on the team Possible Values: Male;
Female'
Type:
type:
- string
- 'null'
description: 'The type of this competition/league Possible values: Club;
International'
Format:
type:
- string
- 'null'
description: 'The format of the competition/league. Possible values: Domestic
League; International Cup'
Seasons:
type: array
items:
$ref: '#/components/schemas/Season'
description: The seasons associated with this competition/league
Key:
type:
- string
- 'null'
description: The unique string key of the competition/league
Season:
properties:
SeasonId:
type: integer
description: The unique ID of the season
CompetitionId:
type: integer
description: The unique ID of the competition
Season:
type: integer
description: The soccer regular season for which these totals apply
Name:
type:
- string
- 'null'
description: The display name of the season (e.g. 2017/2018; 2018/19; etc)
CompetitionName:
type:
- string
- 'null'
description: The display name of the competition associated with this season
StartDate:
type:
- string
- 'null'
description: The start date of the season
EndDate:
type:
- string
- 'null'
description: The end date of the season (UTC)
CurrentSeason:
type: boolean
description: Indicates whether or not this season is the current season
of the competition
Rounds:
type: array
items:
$ref: '#/components/schemas/Round'
description: The unique ID of the round that this season is associated with
Round:
properties:
RoundId:
type: integer
description: The unique ID of the round
SeasonId:
type: integer
description: The unique ID of the season this round is associated with
Season:
type: integer
description: The soccer regular season for which these totals apply
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Name:
type:
- string
- 'null'
description: 'The display name of the round (examples: Regular Season, Semi-finals,
Final, etc)'
Type:
type:
- string
- 'null'
description: 'The type of this round. Possible values: Cup; Table'
StartDate:
type:
- string
- 'null'
description: The start date of the round
EndDate:
type:
- string
- 'null'
description: The end date of the round
CurrentWeek:
type:
- integer
- 'null'
description: The current week that this round is in
CurrentRound:
type: boolean
description: Indicates whether or not this round is the current round of
the competition/season
Games:
type: array
items:
$ref: '#/components/schemas/Game'
description: The games and their details that are apart of this round
Standings:
type: array
items:
$ref: '#/components/schemas/Standing'
description: The standings details associated with this round of the competition
TeamSeasons:
type: array
items:
$ref: '#/components/schemas/TeamSeason'
description: The team stat records associated with this round
PlayerSeasons:
type: array
items:
$ref: '#/components/schemas/PlayerSeason'
description: Player Season stat records associated with this round
Standing:
properties:
StandingId:
type: integer
description: The unique ID of the standing
RoundId:
type: integer
description: The unique ID of the round that this team is associated with
TeamId:
type: integer
description: TheĀ unique ID of the team
Name:
type:
- string
- 'null'
description: The team's full name
ShortName:
type:
- string
- 'null'
description: The short name of the team
Scope:
type:
- string
- 'null'
description: 'The scope of the standing (possible values: Total, Away, Home)'
Order:
type:
- integer
- 'null'
description: The order of the teams in the standing (e.g 1; 2; 3; 4; etc.)
Games:
type:
- integer
- 'null'
description: Total number of games played by the team in the season
Wins:
type:
- integer
- 'null'
description: Number of wins by the team in the season
Losses:
type:
- integer
- 'null'
description: The number of losses for the team
Draws:
type:
- integer
- 'null'
description: Number of draws by the team in the season
GoalsScored:
type:
- integer
- 'null'
description: Total number of goals scored by the team in the season
GoalsAgainst:
type:
- integer
- 'null'
description: Total number of goals against by the team in the season
GoalsDifferential:
type:
- integer
- 'null'
description: 'The goal differential of the team in the season. Note: GoalDifferential
= GoalsScored - GoalsAgainst'
Points:
type:
- integer
- 'null'
description: Total points accumulated by the team
Group:
type:
- string
- 'null'
description: The name of the group (when applicable)
GlobalTeamID:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
TeamSeason:
properties:
StatId:
type: integer
description: The unique ID of the stat associated with this team
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type: integer
description: The soccer regular season for which these totals apply
RoundId:
type:
- integer
- 'null'
description: The unique ID of the round that this team is associated with
TeamId:
type:
- integer
- 'null'
description: The unique ID of the team
Name:
type:
- string
- 'null'
description: The team's full name
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the team
GlobalTeamId:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Possession:
type:
- number
- 'null'
description: Percentage of ball possession by the team in the season
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (UTC Time)
Games:
type:
- integer
- 'null'
description: The number of games played
FantasyPoints:
type:
- number
- 'null'
description: Total fantasy points
FantasyPointsFanDuel:
type:
- number
- 'null'
description: Total Fan Duel daily fantasy points scored
FantasyPointsDraftKings:
type:
- number
- 'null'
description: Total Draft Kings daily fantasy points scored
FantasyPointsYahoo:
type:
- number
- 'null'
description: Total Yahoo daily fantasy points scored
FantasyPointsMondogoal:
type:
- number
- 'null'
description: Total Mondogoal fantasy points scored
Minutes:
type:
- number
- 'null'
description: Total minutes played
Goals:
type:
- number
- 'null'
description: Total goals scored
Assists:
type:
- number
- 'null'
description: Total assists scored
Shots:
type:
- number
- 'null'
description: Total shots attempted
ShotsOnGoal:
type:
- number
- 'null'
description: Total shots on goal attempted
YellowCards:
type:
- number
- 'null'
description: Total yellow cards against
RedCards:
type:
- number
- 'null'
description: Total red cards against
YellowRedCards:
type:
- number
- 'null'
description: Total double yellow cards against (which result in a red card)
Crosses:
type:
- number
- 'null'
description: Total passes from a wide area of the field towards the center
of the field near the opponent's goal
TacklesWon:
type:
- number
- 'null'
description: Total tackles won
Interceptions:
type:
- number
- 'null'
description: Total interceptions made
OwnGoals:
type:
- number
- 'null'
description: Total goals scored against own team (accidentally)
Fouls:
type:
- number
- 'null'
description: Total fouls made
Fouled:
type:
- number
- 'null'
description: Total times fouled
Offsides:
type:
- number
- 'null'
description: Total offsides against
Passes:
type:
- number
- 'null'
description: Total passes attempted
PassesCompleted:
type:
- number
- 'null'
description: Total passes completed successfully to teammate
LastManTackle:
type:
- number
- 'null'
description: Total tackles made when there is no one else available to stop
the opponent from scoring (this can be the goalkeeper)
CornersWon:
type:
- number
- 'null'
description: Total corner kicks awarded
BlockedShots:
type:
- number
- 'null'
description: Total shots blocked
Touches:
type:
- number
- 'null'
description: Total times this player touched the ball
DefenderCleanSheets:
type:
- number
- 'null'
description: Total defender clean sheets (awarded when zero goals were allowed
to the opponent and the player played at least 60 minutes)
GoalkeeperSaves:
type:
- number
- 'null'
description: Total saves made by goalkeeper
GoalkeeperGoalsAgainst:
type:
- number
- 'null'
description: Total goals allowed by goalkeeper
GoalkeeperSingleGoalAgainst:
type:
- number
- 'null'
description: Total games where this goalkeeper allowed exactly one goal
GoalkeeperCleanSheets:
type:
- number
- 'null'
description: Total goalkeeper clean sheets (awarded when zero goals were
allowed to the opponent and the player played at least 60 minutes)
GoalkeeperWins:
type:
- number
- 'null'
description: Total goalkeeper wins (awarded when zero goals were allowed
to the opponent and the player played at least 45 minutes)
PenaltyKickGoals:
type:
- number
- 'null'
description: Total penalty kick goals
PenaltyKickMisses:
type:
- number
- 'null'
description: Total penalty kick misses
PenaltyKickSaves:
type:
- number
- 'null'
description: Total penalty kick saves
PenaltiesWon:
type:
- number
- 'null'
description: Total penalties won
PenaltiesConceded:
type:
- number
- 'null'
description: 'Total penalties conceded '
Score:
type:
- number
- 'null'
description: Goals scored by entire team
OpponentScore:
type:
- number
- 'null'
description: Goals allowed to opponent
Tackles:
type:
- number
- 'null'
description: Total Tackles
PlayerSeason:
properties:
StatId:
type: integer
description: The unique ID of the stat associated with this player
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type: integer
description: The soccer regular season for which these totals apply
RoundId:
type:
- integer
- 'null'
description: The unique ID of the round that this player is associated with
TeamId:
type:
- integer
- 'null'
description: The unique ID of the player's team
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
Name:
type:
- string
- 'null'
description: The player's full name
ShortName:
type:
- string
- 'null'
description: The short name of the player
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the team
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker),
M (Midfielder), D (Defender), GK (Goalkeeper)'
Started:
type:
- integer
- 'null'
description: The total number of games the player started in the season
GlobalTeamId:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (UTC Time)
Games:
type:
- integer
- 'null'
description: The number of games played
FantasyPoints:
type:
- number
- 'null'
description: Total fantasy points
FantasyPointsFanDuel:
type:
- number
- 'null'
description: Total Fan Duel daily fantasy points scored
FantasyPointsDraftKings:
type:
- number
- 'null'
description: Total Draft Kings daily fantasy points scored
FantasyPointsYahoo:
type:
- number
- 'null'
description: Total Yahoo daily fantasy points scored
FantasyPointsMondogoal:
type:
- number
- 'null'
description: Total Mondogoal fantasy points scored
Minutes:
type:
- number
- 'null'
description: Total minutes played
Goals:
type:
- number
- 'null'
description: Total goals scored
Assists:
type:
- number
- 'null'
description: Total assists scored
Shots:
type:
- number
- 'null'
description: Total shots attempted
ShotsOnGoal:
type:
- number
- 'null'
description: Total shots on goal attempted
YellowCards:
type:
- number
- 'null'
description: Total yellow cards against
RedCards:
type:
- number
- 'null'
description: Total red cards against
YellowRedCards:
type:
- number
- 'null'
description: Total double yellow cards against (which result in a red card)
Crosses:
type:
- number
- 'null'
description: Total passes from a wide area of the field towards the center
of the field near the opponent's goal
TacklesWon:
type:
- number
- 'null'
description: Total tackles won
Interceptions:
type:
- number
- 'null'
description: Total interceptions made
OwnGoals:
type:
- number
- 'null'
description: Total goals scored against own team (accidentally)
Fouls:
type:
- number
- 'null'
description: Total fouls made
Fouled:
type:
- number
- 'null'
description: Total times fouled
Offsides:
type:
- number
- 'null'
description: Total offsides against
Passes:
type:
- number
- 'null'
description: Total passes attempted
PassesCompleted:
type:
- number
- 'null'
description: Total passes completed successfully to teammate
LastManTackle:
type:
- number
- 'null'
description: Total tackles made when there is no one else available to stop
the opponent from scoring (this can be the goalkeeper)
CornersWon:
type:
- number
- 'null'
description: Total corner kicks awarded
BlockedShots:
type:
- number
- 'null'
description: Total shots blocked
Touches:
type:
- number
- 'null'
description: Total times this player touched the ball
DefenderCleanSheets:
type:
- number
- 'null'
description: Total defender clean sheets (awarded when zero goals were allowed
to the opponent and the player played at least 60 minutes)
GoalkeeperSaves:
type:
- number
- 'null'
description: Total saves made by goalkeeper
GoalkeeperGoalsAgainst:
type:
- number
- 'null'
description: Total goals allowed by goalkeeper
GoalkeeperSingleGoalAgainst:
type:
- number
- 'null'
description: Total games where this goalkeeper allowed exactly one goal
GoalkeeperCleanSheets:
type:
- number
- 'null'
description: Total goalkeeper clean sheets (awarded when zero goals were
allowed to the opponent and the player played at least 60 minutes)
GoalkeeperWins:
type:
- number
- 'null'
description: Total goalkeeper wins (awarded when zero goals were allowed
to the opponent and the player played at least 45 minutes)
PenaltyKickGoals:
type:
- number
- 'null'
description: Total penalty kick goals
PenaltyKickMisses:
type:
- number
- 'null'
description: Total penalty kick misses
PenaltyKickSaves:
type:
- number
- 'null'
description: Total penalty kick saves
PenaltiesWon:
type:
- number
- 'null'
description: Total penalties won
PenaltiesConceded:
type:
- number
- 'null'
description: 'Total penalties conceded '
Score:
type:
- number
- 'null'
description: Goals scored by entire team
OpponentScore:
type:
- number
- 'null'
description: Goals allowed to opponent
Tackles:
type:
- number
- 'null'
description: Total Tackles
Team:
properties:
TeamId:
type: integer
description: The unique ID of the team
AreaId:
type:
- integer
- 'null'
description: The unique ID of the team's current home arena
VenueId:
type:
- integer
- 'null'
description: The unique ID of the team's venue
Key:
type:
- string
- 'null'
description: Abbreviation of the team (e.g. LIV; ARS; MNU; etc.)
Name:
type:
- string
- 'null'
description: The mascot of the team (e.g. The Reds, The Gunners, etc.)
FullName:
type:
- string
- 'null'
description: The full name of the team (e.g. Liverpool Football Club, Arsenal
Football Club, etc.)
Active:
type: boolean
description: Whether or not this team is active (true/false)
AreaName:
type:
- string
- 'null'
description: The area name of the home team
VenueName:
type:
- string
- 'null'
description: The name of the home team's venue
Gender:
type:
- string
- 'null'
description: 'The gender of the players on the team. Possible Values: Male;
Female'
Type:
type:
- string
- 'null'
description: 'The type of this team. Possible values: Club, National'
Address:
type:
- string
- 'null'
description: The address of the home team
City:
type:
- string
- 'null'
description: The city of the home team
Zip:
type:
- string
- 'null'
description: The zip code of the team's home location
Phone:
type:
- string
- 'null'
description: The phone number of the home team
Fax:
type:
- string
- 'null'
description: The fax number of the home team
Website:
type:
- string
- 'null'
description: The website address of the home team
Email:
type:
- string
- 'null'
description: The email of the home team
Founded:
type:
- integer
- 'null'
description: The calendar year that the team was founded
ClubColor1:
type:
- string
- 'null'
description: The primary color of this team's logo/uniform/branding
ClubColor2:
type:
- string
- 'null'
description: The secondary color of this team's logo/uniform/branding
ClubColor3:
type:
- string
- 'null'
description: The tertiary color of this team's logo/uniform/branding
Nickname1:
type:
- string
- 'null'
description: A nickname for this team
Nickname2:
type:
- string
- 'null'
description: A nickname for this team
Nickname3:
type:
- string
- 'null'
description: A nickname for this team
WikipediaLogoUrl:
type:
- string
- 'null'
description: The link to the team's logo hosted on Wikipedia (This is not
licensed for public or commercial use)
WikipediaWordMarkUrl:
type:
- string
- 'null'
description: The link to the team's wordmark logo hosted on Wikipedia (This
is not licensed for public or commercial use)
GlobalTeamId:
type: integer
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Venue:
properties:
VenueId:
type: integer
description: The unique ID of the venue
Name:
type:
- string
- 'null'
description: The full name of the venue
Address:
type:
- string
- 'null'
description: The address where the venue is located
City:
type:
- string
- 'null'
description: The city where the venue is located
Zip:
type:
- string
- 'null'
description: The zip code of where the venue is located
Country:
type:
- string
- 'null'
description: The country name of where the venue is located
Open:
type: boolean
description: Indicates whether this venue is actively used
Opened:
type:
- integer
- 'null'
description: The year the venue opened (e.g. 1950; 1960; etc)
Nickname1:
type:
- string
- 'null'
description: A nickname for this venue
Nickname2:
type:
- string
- 'null'
description: A nickname for this venue
Capacity:
type:
- integer
- 'null'
description: The estimated seating capacity of the venue
Surface:
type:
- string
- 'null'
description: 'The playing surface of the stadium. Possible values: Grass;
Artificial'
GeoLat:
type:
- number
- 'null'
description: The geographic latitude coordinate of this venue
GeoLong:
type:
- number
- 'null'
description: The geographic latitude coordinate of this venue
SeasonTeam:
properties:
SeasonTeamId:
type: integer
description: Unique ID of this season/team combination
SeasonId:
type: integer
description: The unique ID of the season this record is associated with
TeamId:
type: integer
description: The unique ID of the team
TeamName:
type:
- string
- 'null'
description: The name of the team associated with this record
Active:
type: boolean
description: Whether this team is actively associated with this season (true/false)
Gender:
type:
- string
- 'null'
description: 'The gender of the players on the team. Possible Values: Male;
Female'
Type:
type:
- string
- 'null'
description: 'The type of season/team. Possible values: Club; National'
Team:
$ref: '#/components/schemas/Team'
description: The details of the team for the given season/team association
Player:
properties:
PlayerId:
type: integer
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
FirstName:
type:
- string
- 'null'
description: The player's first name
LastName:
type:
- string
- 'null'
description: The last name of the player
CommonName:
type:
- string
- 'null'
description: The player's common name
ShortName:
type:
- string
- 'null'
description: The short name of the player
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper).'
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Jersey:
type:
- integer
- 'null'
description: The player's jersey number
Foot:
type:
- string
- 'null'
description: 'The primary foot of the player. Possible values: left or right.'
Height:
type:
- integer
- 'null'
description: The height of the player in centimeters (cm)
Weight:
type:
- integer
- 'null'
description: The player's weight in kilograms (kg)
Gender:
type:
- string
- 'null'
description: 'The gender of this player on the team. Possible Values: Male;
Female.'
BirthDate:
type:
- string
- 'null'
description: The player's date of birth
BirthCity:
type:
- string
- 'null'
description: The city in which the player was born
BirthCountry:
type:
- string
- 'null'
description: The country in which the player was born
Nationality:
type:
- string
- 'null'
description: The nationality of the player
InjuryStatus:
type:
- string
- 'null'
description: 'Indicates the player''s injury status. Possible values: Questionable;
Out.'
InjuryBodyPart:
type:
- string
- 'null'
description: The body part of the player that is injured (Knee; Groin; Calf;
Hamstring; etc.)
InjuryNotes:
type:
- string
- 'null'
description: Not yet supported; will be null
InjuryStartDate:
type:
- string
- 'null'
description: The date that the injury started or was first discovered
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
PhotoUrl:
type:
- string
- 'null'
description: 'This field is deprecated. Note: Photos are no longer available
through this field. Headshots are now delivered through IMAGN. Please
see our Headshots products for further information.'
RotoWirePlayerID:
type:
- integer
- 'null'
description: The player's cross reference PlayerID to the RotoWire news
feed.
DraftKingsPosition:
type:
- string
- 'null'
description: The position of the player according to DraftKings
UsaTodayPlayerID:
type:
- integer
- 'null'
description: The player's cross reference PlayerID to USA Today headshot
data feeds
UsaTodayHeadshotUrl:
type:
- string
- 'null'
description: The player's headshot URL as provided by USA Today. License
from USA Today is required.
UsaTodayHeadshotNoBackgroundUrl:
type:
- string
- 'null'
description: The player's transparent background headshot URL as provided
by USA Today. License from USA Today is required.
UsaTodayHeadshotUpdated:
type:
- string
- 'null'
description: The last updated timestamp of the player's headshot as provided
by USA Today. License from USA Today is required.
UsaTodayHeadshotNoBackgroundUpdated:
type:
- string
- 'null'
description: The last updated timestamp of the player's transparent background
headshot as provided by USA Today. License from USA Today is required.
TeamGame:
properties:
StatId:
type: integer
description: The unique ID of the stat associated with this team
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type: integer
description: The soccer regular season for which these totals apply
RoundId:
type:
- integer
- 'null'
description: The unique ID of the round that this team is associated with
TeamId:
type:
- integer
- 'null'
description: The unique ID of the team
Name:
type:
- string
- 'null'
description: The team's full name
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the team
GlobalTeamId:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Possession:
type:
- number
- 'null'
description: Percentage of ball possession by the team in the game
Corners:
type:
- number
- 'null'
description: Total number of corner kicks taken by the team in the game
GameId:
type:
- integer
- 'null'
description: The unique ID of this game
OpponentId:
type:
- integer
- 'null'
description: The unique ID of the team's opponent
Opponent:
type:
- string
- 'null'
description: The name of the opponentĀ
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (UTC)
HomeOrAway:
type:
- string
- 'null'
description: Whether the team is home or away
IsGameOver:
type: boolean
description: Whether the game is over (true/false)
GlobalGameId:
type:
- integer
- 'null'
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalOpponentId:
type:
- integer
- 'null'
description: A globally unique ID for this opponent. This value is guaranteed
to be unique across all sports/leagues.
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (UTC Time)
Games:
type:
- integer
- 'null'
description: The number of games played
FantasyPoints:
type:
- number
- 'null'
description: Total fantasy points
FantasyPointsFanDuel:
type:
- number
- 'null'
description: Total Fan Duel daily fantasy points scored
FantasyPointsDraftKings:
type:
- number
- 'null'
description: Total Draft Kings daily fantasy points scored
FantasyPointsYahoo:
type:
- number
- 'null'
description: Total Yahoo daily fantasy points scored
FantasyPointsMondogoal:
type:
- number
- 'null'
description: Total Mondogoal fantasy points scored
Minutes:
type:
- number
- 'null'
description: Total minutes played
Goals:
type:
- number
- 'null'
description: Total goals scored
Assists:
type:
- number
- 'null'
description: Total assists scored
Shots:
type:
- number
- 'null'
description: Total shots attempted
ShotsOnGoal:
type:
- number
- 'null'
description: Total shots on goal attempted
YellowCards:
type:
- number
- 'null'
description: Total yellow cards against
RedCards:
type:
- number
- 'null'
description: Total red cards against
YellowRedCards:
type:
- number
- 'null'
description: Total double yellow cards against (which result in a red card)
Crosses:
type:
- number
- 'null'
description: Total passes from a wide area of the field towards the center
of the field near the opponent's goal
TacklesWon:
type:
- number
- 'null'
description: Total tackles won
Interceptions:
type:
- number
- 'null'
description: Total interceptions made
OwnGoals:
type:
- number
- 'null'
description: Total goals scored against own team (accidentally)
Fouls:
type:
- number
- 'null'
description: Total fouls made
Fouled:
type:
- number
- 'null'
description: Total times fouled
Offsides:
type:
- number
- 'null'
description: Total offsides against
Passes:
type:
- number
- 'null'
description: Total passes attempted
PassesCompleted:
type:
- number
- 'null'
description: Total passes completed successfully to teammate
LastManTackle:
type:
- number
- 'null'
description: Total tackles made when there is no one else available to stop
the opponent from scoring (this can be the goalkeeper)
CornersWon:
type:
- number
- 'null'
description: Total corner kicks awarded
BlockedShots:
type:
- number
- 'null'
description: Total shots blocked
Touches:
type:
- number
- 'null'
description: Total times this player touched the ball
DefenderCleanSheets:
type:
- number
- 'null'
description: Total defender clean sheets (awarded when zero goals were allowed
to the opponent and the player played at least 60 minutes)
GoalkeeperSaves:
type:
- number
- 'null'
description: Total saves made by goalkeeper
GoalkeeperGoalsAgainst:
type:
- number
- 'null'
description: Total goals allowed by goalkeeper
GoalkeeperSingleGoalAgainst:
type:
- number
- 'null'
description: Total games where this goalkeeper allowed exactly one goal
GoalkeeperCleanSheets:
type:
- number
- 'null'
description: Total goalkeeper clean sheets (awarded when zero goals were
allowed to the opponent and the player played at least 60 minutes)
GoalkeeperWins:
type:
- number
- 'null'
description: Total goalkeeper wins (awarded when zero goals were allowed
to the opponent and the player played at least 45 minutes)
PenaltyKickGoals:
type:
- number
- 'null'
description: Total penalty kick goals
PenaltyKickMisses:
type:
- number
- 'null'
description: Total penalty kick misses
PenaltyKickSaves:
type:
- number
- 'null'
description: Total penalty kick saves
PenaltiesWon:
type:
- number
- 'null'
description: Total penalties won
PenaltiesConceded:
type:
- number
- 'null'
description: 'Total penalties conceded '
Score:
type:
- number
- 'null'
description: Goals scored by entire team
OpponentScore:
type:
- number
- 'null'
description: Goals allowed to opponent
Tackles:
type:
- number
- 'null'
description: Total Tackles
CompetitionDetail:
properties:
CurrentSeason:
$ref: '#/components/schemas/Season'
description: The current active season for this competition/league
Teams:
type: array
items:
$ref: '#/components/schemas/TeamDetail'
description: The list of active teams associated with this competition
Games:
type: array
items:
$ref: '#/components/schemas/Game'
description: The complete schedule for the current season of this competition/league
CompetitionId:
type: integer
description: The unique ID of the competition/league
AreaId:
type: integer
description: The unique ID of the area where this competition/league is
played
AreaName:
type:
- string
- 'null'
description: The display name of the area where this competition/league
is played
Name:
type:
- string
- 'null'
description: The display name of the competition/league
Gender:
type:
- string
- 'null'
description: 'The gender of the players on the team Possible Values: Male;
Female'
Type:
type:
- string
- 'null'
description: 'The type of this competition/league Possible values: Club;
International'
Format:
type:
- string
- 'null'
description: 'The format of the competition/league. Possible values: Domestic
League; International Cup'
Seasons:
type: array
items:
$ref: '#/components/schemas/Season'
description: The seasons associated with this competition/league
Key:
type:
- string
- 'null'
description: The unique string key of the competition/league
TeamDetail:
properties:
Players:
type: array
items:
$ref: '#/components/schemas/Player'
description: The players who are current on this team's active roster/squad
TeamId:
type: integer
description: The unique ID of the team
AreaId:
type:
- integer
- 'null'
description: The unique ID of the team's current home arena
VenueId:
type:
- integer
- 'null'
description: The unique ID of the team's venue
Key:
type:
- string
- 'null'
description: Abbreviation of the team (e.g. LIV; ARS; MNU; etc.)
Name:
type:
- string
- 'null'
description: The mascot of the team (e.g. The Reds, The Gunners, etc.)
FullName:
type:
- string
- 'null'
description: The full name of the team (e.g. Liverpool Football Club, Arsenal
Football Club, etc.)
Active:
type: boolean
description: Whether or not this team is active (true/false)
AreaName:
type:
- string
- 'null'
description: The area name of the home team
VenueName:
type:
- string
- 'null'
description: The name of the home team's venue
Gender:
type:
- string
- 'null'
description: 'The gender of the players on the team. Possible Values: Male;
Female'
Type:
type:
- string
- 'null'
description: 'The type of this team. Possible values: Club, National'
Address:
type:
- string
- 'null'
description: The address of the home team
City:
type:
- string
- 'null'
description: The city of the home team
Zip:
type:
- string
- 'null'
description: The zip code of the team's home location
Phone:
type:
- string
- 'null'
description: The phone number of the home team
Fax:
type:
- string
- 'null'
description: The fax number of the home team
Website:
type:
- string
- 'null'
description: The website address of the home team
Email:
type:
- string
- 'null'
description: The email of the home team
Founded:
type:
- integer
- 'null'
description: The calendar year that the team was founded
ClubColor1:
type:
- string
- 'null'
description: The primary color of this team's logo/uniform/branding
ClubColor2:
type:
- string
- 'null'
description: The secondary color of this team's logo/uniform/branding
ClubColor3:
type:
- string
- 'null'
description: The tertiary color of this team's logo/uniform/branding
Nickname1:
type:
- string
- 'null'
description: A nickname for this team
Nickname2:
type:
- string
- 'null'
description: A nickname for this team
Nickname3:
type:
- string
- 'null'
description: A nickname for this team
WikipediaLogoUrl:
type:
- string
- 'null'
description: The link to the team's logo hosted on Wikipedia (This is not
licensed for public or commercial use)
WikipediaWordMarkUrl:
type:
- string
- 'null'
description: The link to the team's wordmark logo hosted on Wikipedia (This
is not licensed for public or commercial use)
GlobalTeamId:
type: integer
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Membership:
properties:
MembershipId:
type: integer
description: The unique ID for the membership
TeamId:
type: integer
description: The unique ID of the team
PlayerId:
type: integer
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
PlayerName:
type:
- string
- 'null'
description: The player's full name
TeamName:
type:
- string
- 'null'
description: The full name of the team
TeamArea:
type:
- string
- 'null'
description: The area the team is located within their home country
Active:
type: boolean
description: Whether the player's membership is active (true/false)
StartDate:
type:
- string
- 'null'
description: The start date of the membership (in UTC)
EndDate:
type:
- string
- 'null'
description: The end date of the membership (in UTC)
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
Jersey:
type:
- integer
- 'null'
description: The player's jersey number on this team
CanceledMembership:
properties:
CanceledMembershipId:
type: integer
description: The unique ID of the canceled membership
MembershipId:
type: integer
description: The unique ID of the membership which is being canceled; should
be used to find memberships which may be safely deleted.
TeamId:
type: integer
description: The unique ID of the team associated with this canceled membership
PlayerID:
type: integer
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
Created:
type:
- string
- 'null'
description: The date and time when this canceled membership was created
ScheduleBasic:
properties:
GameId:
type: integer
description: The unique ID of the game
RoundId:
type: integer
description: The unique ID of the round that this game is associated with.
Season:
type: integer
description: The soccer regular season for which these totals apply
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Group:
type:
- string
- 'null'
description: 'The name of the group in which this game occurs. Note: This
is used in tournaments & cups'
AwayTeamId:
type:
- integer
- 'null'
description: The unique ID of the away team
HomeTeamId:
type:
- integer
- 'null'
description: The unique ID of the home team
VenueId:
type:
- integer
- 'null'
description: The unique ID of the venue
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game
Status:
type:
- string
- 'null'
description: 'Indicates the game''s status. Possible values include: Scheduled,
InProgress, Break, Final, Awarded, Postponed, Canceled, Suspended. If
a game is called off before it starts, the Status is set to Postponed,
until a new date/time is scheduled, at which point, the DateTime is updated,
and the Status is set back to Scheduled. If a game has already started,
and temporarily interrupted, it''s Status is set to Suspended, until it
either resumes, or gets postponed and replayed at a later date. If the
game is at halftime, then the Status will be Break. Awarded is used in
cases where a game is decided on the so called "green table." That means
that a game was decided by the Federation/League to one team for a reason.
This can include situations like riots, where the opponent team gets 3:0
win awarded as punishment. Awarded is also used when a club withdraws
during the season from the competition then all the remaining matches
getting awarded 3:0.'
Week:
type:
- integer
- 'null'
description: The week during the season/round in which this game occurs
Winner:
type:
- string
- 'null'
description: 'The winner of the game. Possible values: AwayTeam; HomeTeam;
Draw'
VenueType:
type:
- string
- 'null'
description: 'Shows which team has home field advantage. Possible values:
Home; Away; Neutral'
AwayTeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the away team
AwayTeamName:
type:
- string
- 'null'
description: The name of the away team
AwayTeamCountryCode:
type:
- string
- 'null'
description: The country code of the away team
AwayTeamScore:
type:
- integer
- 'null'
description: The final score of the away team
AwayTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the away team.
AwayTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the away team.
AwayTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the away team (if applicable).
AwayTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the away team (if applicable).
HomeTeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the home team
HomeTeamName:
type:
- string
- 'null'
description: The name of the home team
HomeTeamCountryCode:
type:
- string
- 'null'
description: The country code of the home team
HomeTeamScore:
type:
- integer
- 'null'
description: The final score of the home team
HomeTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the home team
HomeTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the home team
HomeTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the home team (if applicable)
HomeTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the home team (if applicable)
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (in US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when this record was updated (in UTC)
GlobalGameId:
type: integer
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalAwayTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the away team. This value is guaranteed
to be unique across all sports/leagues.
GlobalHomeTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the home team. This value is guaranteed
to be unique across all sports/leagues.
IsClosed:
type:
- boolean
- 'null'
description: Indicates whether the game is over and the final score and
stats have been verified and closed out
PlayoffAggregateScore:
$ref: '#/components/schemas/PlayoffAggregateScore'
description: Aggregate scoring information for 2-leg/home-and-home games
(i.e. Champions League Round of 16). Team A is determined by the first
legs home team.
ScoreBasic:
properties:
Period:
type:
- string
- 'null'
description: 'The final period of the game. Possible values: Regular = Game
ended in 90 minutes of regular time; ExtraTime = Game ended in extra time
/ overtime; PenaltyShootout = Game finished in penalty shootout time'
Clock:
type:
- integer
- 'null'
description: 'The clock for the game if it is in progress. Note: if the
game hasn''t started or the game is over; then this will be NULL.'
GameId:
type: integer
description: The unique ID of the game
RoundId:
type: integer
description: The unique ID of the round that this game is associated with.
Season:
type: integer
description: The soccer regular season for which these totals apply
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Group:
type:
- string
- 'null'
description: 'The name of the group in which this game occurs. Note: This
is used in tournaments & cups'
AwayTeamId:
type:
- integer
- 'null'
description: The unique ID of the away team
HomeTeamId:
type:
- integer
- 'null'
description: The unique ID of the home team
VenueId:
type:
- integer
- 'null'
description: The unique ID of the venue
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game
Status:
type:
- string
- 'null'
description: 'Indicates the game''s status. Possible values include: Scheduled,
InProgress, Break, Final, Awarded, Postponed, Canceled, Suspended. If
a game is called off before it starts, the Status is set to Postponed,
until a new date/time is scheduled, at which point, the DateTime is updated,
and the Status is set back to Scheduled. If a game has already started,
and temporarily interrupted, it''s Status is set to Suspended, until it
either resumes, or gets postponed and replayed at a later date. If the
game is at halftime, then the Status will be Break. Awarded is used in
cases where a game is decided on the so called "green table." That means
that a game was decided by the Federation/League to one team for a reason.
This can include situations like riots, where the opponent team gets 3:0
win awarded as punishment. Awarded is also used when a club withdraws
during the season from the competition then all the remaining matches
getting awarded 3:0.'
Week:
type:
- integer
- 'null'
description: The week during the season/round in which this game occurs
Winner:
type:
- string
- 'null'
description: 'The winner of the game. Possible values: AwayTeam; HomeTeam;
Draw'
VenueType:
type:
- string
- 'null'
description: 'Shows which team has home field advantage. Possible values:
Home; Away; Neutral'
AwayTeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the away team
AwayTeamName:
type:
- string
- 'null'
description: The name of the away team
AwayTeamCountryCode:
type:
- string
- 'null'
description: The country code of the away team
AwayTeamScore:
type:
- integer
- 'null'
description: The final score of the away team
AwayTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the away team.
AwayTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the away team.
AwayTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the away team (if applicable).
AwayTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the away team (if applicable).
HomeTeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the home team
HomeTeamName:
type:
- string
- 'null'
description: The name of the home team
HomeTeamCountryCode:
type:
- string
- 'null'
description: The country code of the home team
HomeTeamScore:
type:
- integer
- 'null'
description: The final score of the home team
HomeTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the home team
HomeTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the home team
HomeTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the home team (if applicable)
HomeTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the home team (if applicable)
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (in US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when this record was updated (in UTC)
GlobalGameId:
type: integer
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalAwayTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the away team. This value is guaranteed
to be unique across all sports/leagues.
GlobalHomeTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the home team. This value is guaranteed
to be unique across all sports/leagues.
IsClosed:
type:
- boolean
- 'null'
description: Indicates whether the game is over and the final score and
stats have been verified and closed out
PlayoffAggregateScore:
$ref: '#/components/schemas/PlayoffAggregateScore'
description: Aggregate scoring information for 2-leg/home-and-home games
(i.e. Champions League Round of 16). Team A is determined by the first
legs home team.
PlayerBasic:
properties:
PlayerId:
type: integer
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
FirstName:
type:
- string
- 'null'
description: The player's first name
LastName:
type:
- string
- 'null'
description: The last name of the player
CommonName:
type:
- string
- 'null'
description: The player's common name
ShortName:
type:
- string
- 'null'
description: The short name of the player
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker),
M (Midfielder), D (Defender), GK (Goalkeeper).'
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Jersey:
type:
- integer
- 'null'
description: The player's jersey number
Foot:
type:
- string
- 'null'
description: 'The primary foot of the player. Possible values: left or right.'
Height:
type:
- integer
- 'null'
description: The height of the player in centimeters (cm)
Weight:
type:
- integer
- 'null'
description: The player's weight in kilograms (kg)
Gender:
type:
- string
- 'null'
description: 'The gender of this player on the team. Possible Values: Male;
Female.'
BirthDate:
type:
- string
- 'null'
description: The player's date of birth
BirthCity:
type:
- string
- 'null'
description: The city in which the player was born
BirthCountry:
type:
- string
- 'null'
description: The country in which the player was born
Nationality:
type:
- string
- 'null'
description: The nationality of the player
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
Headshot:
properties:
PlayerID:
type: integer
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
Name:
type:
- string
- 'null'
description: The player's full name
TeamID:
type:
- integer
- 'null'
description: The unique ID of the team associated with this player headshot
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the team
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper).'
PreferredHostedHeadshotUrl:
type:
- string
- 'null'
description: The player's preferred hosted headshot URL. This returns the
headshot with transparent background if available.
PreferredHostedHeadshotUpdated:
type:
- string
- 'null'
description: The last updated date of the player's preferred hosted headshot.
HostedHeadshotWithBackgroundUrl:
type:
- string
- 'null'
description: The player's hosted headshot URL
HostedHeadshotWithBackgroundUpdated:
type:
- string
- 'null'
description: The last updated timestamp of the player's hosted headshot
HostedHeadshotNoBackgroundUrl:
type:
- string
- 'null'
description: The player's transparent background hosted headshot URL
HostedHeadshotNoBackgroundUpdated:
type:
- string
- 'null'
description: The last updated timestamp of the player's transparent background
hosted headshot
PlayerGameProjection:
properties:
StatId:
type: integer
description: The unique ID of the stat associated with this player
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type: integer
description: The soccer regular season for which these totals apply
RoundId:
type:
- integer
- 'null'
description: The unique ID of the round that this player is associated with
TeamId:
type:
- integer
- 'null'
description: The unique ID of the team
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
Name:
type:
- string
- 'null'
description: The player's full name
ShortName:
type:
- string
- 'null'
description: The short name of the player
Team:
type:
- string
- 'null'
description: The name of the team
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper).'
Jersey:
type:
- integer
- 'null'
description: The player's jersey number
Started:
type:
- integer
- 'null'
description: The total number of games the player started
Captain:
type:
- boolean
- 'null'
description: Whether the player is a captain (true/false)
Suspension:
type:
- boolean
- 'null'
description: Whether the player is suspended or not (true/false)
SuspensionReason:
type:
- string
- 'null'
description: The reason given for the player's suspension
FanDuelSalary:
type:
- integer
- 'null'
description: The player's salary for FanDuel daily fantasy contests.
DraftKingsSalary:
type:
- integer
- 'null'
description: The player's salary for DraftKings daily fantasy contests.
YahooSalary:
type:
- integer
- 'null'
description: The player's salary for Yahoo daily fantasy contests
MondogoalSalary:
type:
- integer
- 'null'
description: The player's salary for Mondogoal's daily fantasy contests
FanDuelPosition:
type:
- string
- 'null'
description: The player's eligible position in FanDuel's daily fantasy sports
platform.
DraftKingsPosition:
type:
- string
- 'null'
description: The player's eligible position in DraftKings' daily fantasy
sports platform.
YahooPosition:
type:
- string
- 'null'
description: The player's eligible position in Yahoo's daily fantasy sports
platform
MondogoalPosition:
type:
- string
- 'null'
description: The player's eligible position in Mondogoal's daily fantasy
sports platform.
InjuryStatus:
type:
- string
- 'null'
description: 'Indicates the player''s injury status. Possible values: Questionable;
Out.'
InjuryBodyPart:
type:
- string
- 'null'
description: The body part of the player that is injured (Knee; Groin; Calf;
Hamstring; etc.)
InjuryNotes:
type:
- string
- 'null'
description: Not yet supported; will be null
InjuryStartDate:
type:
- string
- 'null'
description: The date that the injury started or was first discovered
GlobalTeamId:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Corners:
type:
- number
- 'null'
description: Total number of corner kicks taken by the player in the game
GameId:
type:
- integer
- 'null'
description: The unique ID of this game
OpponentId:
type:
- integer
- 'null'
description: The unique ID of the team's opponent
Opponent:
type:
- string
- 'null'
description: The name of the opponentĀ
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (UTC)
HomeOrAway:
type:
- string
- 'null'
description: Whether the team is home or away
IsGameOver:
type: boolean
description: Whether the game is over (true/false)
GlobalGameId:
type:
- integer
- 'null'
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalOpponentId:
type:
- integer
- 'null'
description: A globally unique ID for this opponent. This value is guaranteed
to be unique across all sports/leagues.
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (UTC Time)
Games:
type:
- integer
- 'null'
description: The number of games played
FantasyPoints:
type:
- number
- 'null'
description: Total fantasy points
FantasyPointsFanDuel:
type:
- number
- 'null'
description: Total Fan Duel daily fantasy points scored
FantasyPointsDraftKings:
type:
- number
- 'null'
description: Total Draft Kings daily fantasy points scored
FantasyPointsYahoo:
type:
- number
- 'null'
description: Total Yahoo daily fantasy points scored
FantasyPointsMondogoal:
type:
- number
- 'null'
description: Total Mondogoal fantasy points scored
Minutes:
type:
- number
- 'null'
description: Total minutes played
Goals:
type:
- number
- 'null'
description: Total goals scored
Assists:
type:
- number
- 'null'
description: Total assists scored
Shots:
type:
- number
- 'null'
description: Total shots attempted
ShotsOnGoal:
type:
- number
- 'null'
description: Total shots on goal attempted
YellowCards:
type:
- number
- 'null'
description: Total yellow cards against
RedCards:
type:
- number
- 'null'
description: Total red cards against
YellowRedCards:
type:
- number
- 'null'
description: Total double yellow cards against (which result in a red card)
Crosses:
type:
- number
- 'null'
description: Total passes from a wide area of the field towards the center
of the field near the opponent's goal
TacklesWon:
type:
- number
- 'null'
description: Total tackles won
Interceptions:
type:
- number
- 'null'
description: Total interceptions made
OwnGoals:
type:
- number
- 'null'
description: Total goals scored against own team (accidentally)
Fouls:
type:
- number
- 'null'
description: Total fouls made
Fouled:
type:
- number
- 'null'
description: Total times fouled
Offsides:
type:
- number
- 'null'
description: Total offsides against
Passes:
type:
- number
- 'null'
description: Total passes attempted
PassesCompleted:
type:
- number
- 'null'
description: Total passes completed successfully to teammate
LastManTackle:
type:
- number
- 'null'
description: Total tackles made when there is no one else available to stop
the opponent from scoring (this can be the goalkeeper)
CornersWon:
type:
- number
- 'null'
description: Total corner kicks awarded
BlockedShots:
type:
- number
- 'null'
description: Total shots blocked
Touches:
type:
- number
- 'null'
description: Total times this player touched the ball
DefenderCleanSheets:
type:
- number
- 'null'
description: Total defender clean sheets (awarded when zero goals were allowed
to the opponent and the player played at least 60 minutes)
GoalkeeperSaves:
type:
- number
- 'null'
description: Total saves made by goalkeeper
GoalkeeperGoalsAgainst:
type:
- number
- 'null'
description: Total goals allowed by goalkeeper
GoalkeeperSingleGoalAgainst:
type:
- number
- 'null'
description: Total games where this goalkeeper allowed exactly one goal
GoalkeeperCleanSheets:
type:
- number
- 'null'
description: Total goalkeeper clean sheets (awarded when zero goals were
allowed to the opponent and the player played at least 60 minutes)
GoalkeeperWins:
type:
- number
- 'null'
description: Total goalkeeper wins (awarded when zero goals were allowed
to the opponent and the player played at least 45 minutes)
PenaltyKickGoals:
type:
- number
- 'null'
description: Total penalty kick goals
PenaltyKickMisses:
type:
- number
- 'null'
description: Total penalty kick misses
PenaltyKickSaves:
type:
- number
- 'null'
description: Total penalty kick saves
PenaltiesWon:
type:
- number
- 'null'
description: Total penalties won
PenaltiesConceded:
type:
- number
- 'null'
description: 'Total penalties conceded '
Score:
type:
- number
- 'null'
description: Goals scored by entire team
OpponentScore:
type:
- number
- 'null'
description: Goals allowed to opponent
Tackles:
type:
- number
- 'null'
description: Total Tackles
DfsSlate:
properties:
SlateID:
type: integer
description: The unique ID of the slate as assigned by SportsDataIO
Operator:
type:
- string
- 'null'
description: 'The name of the operator who is running contests for this
slate. Possible values: FanDuel; DraftKings; Yahoo; FantasyDraft; etc.'
OperatorSlateID:
type:
- integer
- 'null'
description: Unique ID of a slate (assigned by the operator).
OperatorName:
type:
- string
- 'null'
description: 'The name of the slate (assigned by the operator). Possible
values: Main, Express, Arcade, Late Night, etc.'
OperatorDay:
type:
- string
- 'null'
description: The day (in UTC) that the slate begins (assigned by the operator).
OperatorStartTime:
type:
- string
- 'null'
description: The date/time (in UTC) that the slate begins (assigned by the
operator).
NumberOfGames:
type:
- integer
- 'null'
description: The number of actual games that this slate covers
IsMultiDaySlate:
type:
- boolean
- 'null'
description: Whether this slate uses games that take place on different
days
RemovedByOperator:
type:
- boolean
- 'null'
description: Indicates whether this slate was removed/deleted by the operator.
OperatorGameType:
type:
- string
- 'null'
description: The game type of the slate. Will often be null as most operators
only have one game type.
DfsSlateGames:
type: array
items:
$ref: '#/components/schemas/DfsSlateGame'
description: The games that are included in this slate
DfsSlatePlayers:
type: array
items:
$ref: '#/components/schemas/DfsSlatePlayer'
description: The players that are included in this slate
SlateRosterSlots:
type: array
items:
type:
- string
- 'null'
description: The positions that need to be filled for this particular slate
SalaryCap:
type:
- integer
- 'null'
description: The salary cap for the current slate (is null for slates with
no salary cap such a Tiers gametypes)
CompetitionId:
type:
- integer
- 'null'
description: The Id of the competition related to this slate (Premier League,
Champions League, etc.)
DfsSlateGame:
properties:
SlateGameID:
type: integer
description: The unique ID of the SlateGame as assigned by SportsDataIO
SlateID:
type: integer
description: The unique ID of the slate that this SlateGame refers to
GameID:
type:
- integer
- 'null'
description: The unique ID of the game that this SlateGame refers to
Game:
$ref: '#/components/schemas/Game'
description: The details of the Game that this SlateGame refers to
OperatorGameID:
type:
- integer
- 'null'
description: Unique ID of a SlateGame (assigned by the operator).
RemovedByOperator:
type:
- boolean
- 'null'
description: Indicates whether this game was removed/deleted by the operator.
DfsSlatePlayer:
properties:
SlatePlayerID:
type: integer
description: The unique ID of the SlatePlayer as assigned by SportsDataIO
SlateID:
type: integer
description: The unique ID of the slate that this SlatePlayer refers to
SlateGameID:
type:
- integer
- 'null'
description: The unique ID of the SlateGame that this SlatePlayer refers
to
PlayerID:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
PlayerGameProjectionStatID:
type:
- integer
- 'null'
description: The SportsDataIO StatID that this SlatePlayer refers to. This
points to data in the respective sports' projected player game stats feeds.
OperatorPlayerID:
type:
- string
- 'null'
description: Unique ID of the Player (assigned by the operator).
OperatorSlatePlayerID:
type:
- string
- 'null'
description: Unique ID of the SlatePlayer (assigned by the operator).
OperatorPlayerName:
type:
- string
- 'null'
description: The player's name (assigned by the operator).
OperatorPosition:
type:
- string
- 'null'
description: The player's eligible positions for the contest (assigned by
the operator).
OperatorSalary:
type:
- integer
- 'null'
description: The player's salary for the contest (assigned by the operator).
OperatorRosterSlots:
type: array
items:
type:
- string
- 'null'
description: The player's eligible positions to be played in the contest
(assigned by the operator). This would include UTIL plays for those that
are eligible.
RemovedByOperator:
type:
- boolean
- 'null'
description: Indicates whether this player was removed/deleted by the operator.
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the team
TeamID:
type:
- integer
- 'null'
description: The unique ID of the team associated with this SlatePlayer
record
BoxScore:
properties:
Game:
$ref: '#/components/schemas/Game'
description: The game details associated with this box score
AwayTeamCoach:
$ref: '#/components/schemas/Coach'
description: The coach of the away team
HomeTeamCoach:
$ref: '#/components/schemas/Coach'
description: The coach of the home team
MainReferee:
$ref: '#/components/schemas/Referee'
description: The main referee
AssistantReferee1:
$ref: '#/components/schemas/Referee'
description: The first assistant referee
AssistantReferee2:
$ref: '#/components/schemas/Referee'
description: The second assistant referee
FourthReferee:
$ref: '#/components/schemas/Referee'
description: The information about the fourth referee working the match
AdditionalAssistantReferee1:
$ref: '#/components/schemas/Referee'
description: The first additional assistant referee
AdditionalAssistantReferee2:
$ref: '#/components/schemas/Referee'
description: The second additional assistant referee
Lineups:
type: array
items:
$ref: '#/components/schemas/Lineup'
description: The details of the lineups for each team
Goals:
type: array
items:
$ref: '#/components/schemas/Goal'
description: The details of the goals scored during this game
Bookings:
type: array
items:
$ref: '#/components/schemas/Booking'
description: The details of the bookings (yellow/red cards) recorded during
this game
PenaltyShootouts:
type: array
items:
$ref: '#/components/schemas/PenaltyShootout'
description: The details of the penalty shootouts recorded during this game
TeamGames:
type: array
items:
$ref: '#/components/schemas/TeamGame'
description: The stats by the team in the game
PlayerGames:
type: array
items:
$ref: '#/components/schemas/PlayerGame'
description: The player stats for this game
VideoAssistantReferee:
$ref: '#/components/schemas/Referee'
description: The name of the referee in charge of the video reviews (VAR)
Coach:
properties:
CoachId:
type: integer
description: The unique ID of the coach
FirstName:
type:
- string
- 'null'
description: Coach's first name
LastName:
type:
- string
- 'null'
description: The last name of the coach
ShortName:
type:
- string
- 'null'
description: The short name of the coach
Nationality:
type:
- string
- 'null'
description: Coach's nationality
Referee:
properties:
RefereeId:
type: integer
description: The last name of the referee
FirstName:
type:
- string
- 'null'
description: The first name of the referee
LastName:
type:
- string
- 'null'
description: The last name of the referee
ShortName:
type:
- string
- 'null'
description: The short name of the referee
Nationality:
type:
- string
- 'null'
description: The nationality of the referee
Lineup:
properties:
LineupId:
type: integer
description: The unique ID of this lineup
GameId:
type: integer
description: The unique ID of the game tied to this lineup
Type:
type:
- string
- 'null'
description: 'The player''s status in the lineup. Possible values: Substitute
In; Starter; Bench.'
TeamId:
type: integer
description: The unique ID of the team associated with this lineup
PlayerId:
type: integer
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
Name:
type:
- string
- 'null'
description: The player's full name
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper).'
ReplacedPlayerId:
type:
- integer
- 'null'
description: The unique ID of the replaced player
ReplacedPlayerName:
type:
- string
- 'null'
description: The name of the replaced player
GameMinute:
type:
- integer
- 'null'
description: The minute of the game
GameMinuteExtra:
type:
- integer
- 'null'
description: The extra minute of the game
PitchPositionHorizontal:
type:
- integer
- 'null'
description: 'The pitch position of where this player lined up on the field.
Note: This is used for rendering an image of a soccer/football field with
the players marked as such. This will be a number between 0 and 50.'
PitchPositionVertical:
type:
- integer
- 'null'
description: 'The pitch position of where this player lined up on the field.
Note: This is used for rendering an image of a soccer/football field with
the players marked as such. This will be a number between 0 and 50.'
Goal:
properties:
GoalId:
type: integer
description: The unique ID of the goal
GameId:
type: integer
description: The unique ID of the game tied to this goal
TeamId:
type: integer
description: The unique ID of the team associated with this goal
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
Name:
type:
- string
- 'null'
description: The full name of the player who scored the goal
Type:
type:
- string
- 'null'
description: The type of goal scored
AssistedByPlayerId1:
type:
- integer
- 'null'
description: The unique ID of the first assisted player
AssistedByPlayerName1:
type:
- string
- 'null'
description: The player's name of the first assisted player
AssistedByPlayerId2:
type:
- integer
- 'null'
description: The unique ID of the second assisted player
AssistedByPlayerName2:
type:
- string
- 'null'
description: The player's name of the second assisted player
GameMinute:
type:
- integer
- 'null'
description: The minute in the game in which the goal was scored
GameMinuteExtra:
type:
- integer
- 'null'
description: The extra minute in the game in which the goal was scored
Booking:
properties:
BookingId:
type: integer
description: The unique ID of the booking
GameId:
type: integer
description: The unique ID of the game tied to this booking
Type:
type:
- string
- 'null'
description: 'The type of booking. Possible values: Yellow Card, Red Card,
Yellow Red Card'
TeamId:
type: integer
description: The unique ID of the team associated with this booking
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
Name:
type:
- string
- 'null'
description: The full name of the player who was booked
GameMinute:
type:
- integer
- 'null'
description: The minute in the game in which the booking occurred
GameMinuteExtra:
type:
- integer
- 'null'
description: The extra minute in the game in which the booking occurred
PenaltyShootout:
properties:
PenaltyShootoutId:
type: integer
description: The unique ID of the penalty shootout
GameId:
type: integer
description: The unique ID of the game tied to this penalty shootout
Type:
type:
- string
- 'null'
description: 'The result of this penalty shootout kick. Possible values:
Goal; Miss.'
TeamId:
type: integer
description: The unique ID of the team
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
Name:
type:
- string
- 'null'
description: The name of the player in the penalty shootout
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper).'
Order:
type: integer
description: The order of the penalty shootout
PlayerGame:
properties:
StatId:
type: integer
description: The unique ID of the stat associated with this player
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type: integer
description: The soccer regular season for which these totals apply
RoundId:
type:
- integer
- 'null'
description: The unique ID of the round that this player is associated with
TeamId:
type:
- integer
- 'null'
description: The unique ID of the team
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career.'
Name:
type:
- string
- 'null'
description: The player's full name
ShortName:
type:
- string
- 'null'
description: The short name of the player
Team:
type:
- string
- 'null'
description: The name of the team
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper).'
Jersey:
type:
- integer
- 'null'
description: The player's jersey number
Started:
type:
- integer
- 'null'
description: The total number of games the player started
Captain:
type:
- boolean
- 'null'
description: Whether the player is a captain (true/false)
Suspension:
type:
- boolean
- 'null'
description: Whether the player is suspended or not (true/false)
SuspensionReason:
type:
- string
- 'null'
description: The reason given for the player's suspension
FanDuelSalary:
type:
- integer
- 'null'
description: The player's salary for FanDuel daily fantasy contests.
DraftKingsSalary:
type:
- integer
- 'null'
description: The player's salary for DraftKings daily fantasy contests.
YahooSalary:
type:
- integer
- 'null'
description: The player's salary for Yahoo daily fantasy contests
MondogoalSalary:
type:
- integer
- 'null'
description: The player's salary for Mondogoal's daily fantasy contests
FanDuelPosition:
type:
- string
- 'null'
description: The player's eligible position in FanDuel's daily fantasy sports
platform.
DraftKingsPosition:
type:
- string
- 'null'
description: The player's eligible position in DraftKings' daily fantasy
sports platform.
YahooPosition:
type:
- string
- 'null'
description: The player's eligible position in Yahoo's daily fantasy sports
platform
MondogoalPosition:
type:
- string
- 'null'
description: The player's eligible position in Mondogoal's daily fantasy
sports platform.
InjuryStatus:
type:
- string
- 'null'
description: 'Indicates the player''s injury status. Possible values: Questionable;
Out.'
InjuryBodyPart:
type:
- string
- 'null'
description: The body part of the player that is injured (Knee; Groin; Calf;
Hamstring; etc.)
InjuryNotes:
type:
- string
- 'null'
description: Not yet supported; will be null
InjuryStartDate:
type:
- string
- 'null'
description: The date that the injury started or was first discovered
GlobalTeamId:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
Corners:
type:
- number
- 'null'
description: Total number of corner kicks taken by the player in the game
GameId:
type:
- integer
- 'null'
description: The unique ID of this game
OpponentId:
type:
- integer
- 'null'
description: The unique ID of the team's opponent
Opponent:
type:
- string
- 'null'
description: The name of the opponentĀ
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (UTC)
HomeOrAway:
type:
- string
- 'null'
description: Whether the team is home or away
IsGameOver:
type: boolean
description: Whether the game is over (true/false)
GlobalGameId:
type:
- integer
- 'null'
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalOpponentId:
type:
- integer
- 'null'
description: A globally unique ID for this opponent. This value is guaranteed
to be unique across all sports/leagues.
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (UTC Time)
Games:
type:
- integer
- 'null'
description: The number of games played
FantasyPoints:
type:
- number
- 'null'
description: Total fantasy points
FantasyPointsFanDuel:
type:
- number
- 'null'
description: Total Fan Duel daily fantasy points scored
FantasyPointsDraftKings:
type:
- number
- 'null'
description: Total Draft Kings daily fantasy points scored
FantasyPointsYahoo:
type:
- number
- 'null'
description: Total Yahoo daily fantasy points scored
FantasyPointsMondogoal:
type:
- number
- 'null'
description: Total Mondogoal fantasy points scored
Minutes:
type:
- number
- 'null'
description: Total minutes played
Goals:
type:
- number
- 'null'
description: Total goals scored
Assists:
type:
- number
- 'null'
description: Total assists scored
Shots:
type:
- number
- 'null'
description: Total shots attempted
ShotsOnGoal:
type:
- number
- 'null'
description: Total shots on goal attempted
YellowCards:
type:
- number
- 'null'
description: Total yellow cards against
RedCards:
type:
- number
- 'null'
description: Total red cards against
YellowRedCards:
type:
- number
- 'null'
description: Total double yellow cards against (which result in a red card)
Crosses:
type:
- number
- 'null'
description: Total passes from a wide area of the field towards the center
of the field near the opponent's goal
TacklesWon:
type:
- number
- 'null'
description: Total tackles won
Interceptions:
type:
- number
- 'null'
description: Total interceptions made
OwnGoals:
type:
- number
- 'null'
description: Total goals scored against own team (accidentally)
Fouls:
type:
- number
- 'null'
description: Total fouls made
Fouled:
type:
- number
- 'null'
description: Total times fouled
Offsides:
type:
- number
- 'null'
description: Total offsides against
Passes:
type:
- number
- 'null'
description: Total passes attempted
PassesCompleted:
type:
- number
- 'null'
description: Total passes completed successfully to teammate
LastManTackle:
type:
- number
- 'null'
description: Total tackles made when there is no one else available to stop
the opponent from scoring (this can be the goalkeeper)
CornersWon:
type:
- number
- 'null'
description: Total corner kicks awarded
BlockedShots:
type:
- number
- 'null'
description: Total shots blocked
Touches:
type:
- number
- 'null'
description: Total times this player touched the ball
DefenderCleanSheets:
type:
- number
- 'null'
description: Total defender clean sheets (awarded when zero goals were allowed
to the opponent and the player played at least 60 minutes)
GoalkeeperSaves:
type:
- number
- 'null'
description: Total saves made by goalkeeper
GoalkeeperGoalsAgainst:
type:
- number
- 'null'
description: Total goals allowed by goalkeeper
GoalkeeperSingleGoalAgainst:
type:
- number
- 'null'
description: Total games where this goalkeeper allowed exactly one goal
GoalkeeperCleanSheets:
type:
- number
- 'null'
description: Total goalkeeper clean sheets (awarded when zero goals were
allowed to the opponent and the player played at least 60 minutes)
GoalkeeperWins:
type:
- number
- 'null'
description: Total goalkeeper wins (awarded when zero goals were allowed
to the opponent and the player played at least 45 minutes)
PenaltyKickGoals:
type:
- number
- 'null'
description: Total penalty kick goals
PenaltyKickMisses:
type:
- number
- 'null'
description: Total penalty kick misses
PenaltyKickSaves:
type:
- number
- 'null'
description: Total penalty kick saves
PenaltiesWon:
type:
- number
- 'null'
description: Total penalties won
PenaltiesConceded:
type:
- number
- 'null'
description: 'Total penalties conceded '
Score:
type:
- number
- 'null'
description: Goals scored by entire team
OpponentScore:
type:
- number
- 'null'
description: Goals allowed to opponent
Tackles:
type:
- number
- 'null'
description: Total Tackles
PlayerGameBasic:
properties:
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (in US Eastern
Time)
UpdatedUtc:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (in UTC Time)
Games:
type:
- integer
- 'null'
description: Total number of games played by the player in the game
Minutes:
type:
- number
- 'null'
description: Total minutes played by the player in the game
Goals:
type:
- number
- 'null'
description: Total goals scored by the player in the game
Assists:
type:
- number
- 'null'
description: Total assists scored by the player in the game
Shots:
type:
- number
- 'null'
description: Total shots attempted by the player in the game
ShotsOnGoal:
type:
- number
- 'null'
description: Total shots on goal attempted by the player in the game
YellowCards:
type:
- number
- 'null'
description: Total yellow cards against the player in the game
RedCards:
type:
- number
- 'null'
description: Total red cards against by the player in the game
YellowRedCards:
type:
- number
- 'null'
description: 'Total double yellow cards against the player in the game.
Note: A double yellow card results in a red card'
Crosses:
type:
- number
- 'null'
description: 'Total crosses by the player in the game. Note: a cross means
a pass from a wide area of the field towards the center of the field near
the opponent''s goal.'
TacklesWon:
type:
- number
- 'null'
description: Total tackles won by the player in the game
Interceptions:
type:
- number
- 'null'
description: Total interceptions made by the player in the game
OwnGoals:
type:
- number
- 'null'
description: Total goals scored against own team (accidentally)
Fouls:
type:
- number
- 'null'
description: Total fouls made by the player in the game
Fouled:
type:
- number
- 'null'
description: Total times the player was fouled in the game
Offsides:
type:
- number
- 'null'
description: Total offsides against by the player in the game
Passes:
type:
- number
- 'null'
description: Total passes attempted by the player in the game
PassesCompleted:
type:
- number
- 'null'
description: Total passes completed by the player in the game
LastManTackle:
type:
- number
- 'null'
description: Total tackles made by the player when there is no one else
available to stop the opponent from scoring in the game
CornersWon:
type:
- number
- 'null'
description: Total corner kicks awarded to the player in the game
BlockedShots:
type:
- number
- 'null'
description: Total shots blocked by the player in the game
Touches:
type:
- number
- 'null'
description: Total times the player touched the ball in the game
DefenderCleanSheets:
type:
- number
- 'null'
description: 'Total defender clean sheets by the player in the game. Note:
clean sheets are awarded when zero goals were allowed to the opponent
and the player played at least 60 minutes).'
GoalkeeperSaves:
type:
- number
- 'null'
description: Total saves made by goalkeeper in the game
GoalkeeperGoalsAgainst:
type:
- number
- 'null'
description: Total goals allowed by goalkeeper in the game
GoalkeeperSingleGoalAgainst:
type:
- number
- 'null'
description: Total games where the goalkeeper allowed exactly one goal in
the game
GoalkeeperCleanSheets:
type:
- number
- 'null'
description: 'Total number of clean sheets by the goalkeeper in the game.
Note: Awarded when zero goals were allowed to the opponent and the player
played at least 60 minutes'
GoalkeeperWins:
type:
- number
- 'null'
description: Total wins by the goalkeeper in the game
PenaltyKickGoals:
type:
- number
- 'null'
description: Total penalty kick goals scored by the player in the game
PenaltyKickMisses:
type:
- number
- 'null'
description: Total penalty kicks missed by the player in the game
PenaltyKickSaves:
type:
- number
- 'null'
description: Total penalty kicks saved by the player in the game
PenaltiesWon:
type:
- number
- 'null'
description: Total penalties won by the player in the game
PenaltiesConceded:
type:
- number
- 'null'
description: Total penalties conceded by the player in the game
Score:
type:
- number
- 'null'
description: Total goals scored by the player's team in the game
OpponentScore:
type:
- number
- 'null'
description: Total goals scored against own team by the player in the game
Tackles:
type:
- number
- 'null'
description: Total tackles by the player in the game
GameId:
type:
- integer
- 'null'
description: The unique ID of the game
OpponentId:
type:
- integer
- 'null'
description: The unique ID of the team's opponent
Opponent:
type:
- string
- 'null'
description: The name of the opponent team
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (in UTC)
HomeOrAway:
type:
- string
- 'null'
description: Whether the team is the home team or away team
IsGameOver:
type: boolean
description: Whether the game is over (true) or not (false)
GlobalGameId:
type:
- integer
- 'null'
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalOpponentId:
type:
- integer
- 'null'
description: A globally unique ID for this opponent. This value is guaranteed
to be unique across all sports/leagues.
StatId:
type: integer
description: The unique ID of the stat associated with this player
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type: integer
description: The soccer regular season for which these totals apply
RoundId:
type:
- integer
- 'null'
description: The unique ID of the round that this player is associated with
TeamId:
type:
- integer
- 'null'
description: The unique ID of the team
PlayerId:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
Name:
type:
- string
- 'null'
description: The player's full name
ShortName:
type:
- string
- 'null'
description: The short name of the player
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the player's team
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper)'
Jersey:
type: integer
description: The player's jersey number
Started:
type:
- integer
- 'null'
description: The total number of games the player started
Captain:
type:
- boolean
- 'null'
description: Whether the player is a captain (true/false)
Suspension:
type:
- boolean
- 'null'
description: Whether the player is suspended or not (true/false)
SuspensionReason:
type:
- string
- 'null'
description: The reason given for the player's suspension
GlobalTeamId:
type:
- integer
- 'null'
description: A globally unique ID for this team. This value is guaranteed
to be unique across all sports/leagues.
FantasyGame:
properties:
GameID:
type:
- integer
- 'null'
description: The unique ID of the game
PlayerID:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
SeasonType:
type:
- integer
- 'null'
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Season:
type:
- integer
- 'null'
description: The soccer regular season for which these totals apply
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (in UTC)
Team:
type:
- string
- 'null'
description: The abbreviation [Key] of the team
Opponent:
type:
- string
- 'null'
description: The name of the opponent team
Jersey:
type:
- integer
- 'null'
description: The player's jersey number
Name:
type:
- string
- 'null'
description: The player's full name
Position:
type:
- string
- 'null'
description: 'The position of the player. Possible values include: A (Attacker);
M (Midfielder); D (Defender); GK (Goalkeeper)'
PositionCategory:
type:
- string
- 'null'
description: The player's position category
Started:
type:
- integer
- 'null'
description: The total number of games the player started
FantasyPoints:
type:
- number
- 'null'
description: Total fantasy points
IsGameOver:
type: boolean
description: Whether the game is over (true) or not (false)
FantasyPointsFanDuel:
type:
- number
- 'null'
description: This field is expected to be NULL
FantasyPointsYahoo:
type:
- number
- 'null'
description: This field is expected to be NULL
FantasyPointsDraftKings:
type:
- number
- 'null'
description: Total DraftKings daily fantasy points scored by the player
in the game
FanDuelPosition:
type:
- string
- 'null'
description: The player's eligible position in FanDuel's daily fantasy sports
platform.
DraftKingsPosition:
type:
- string
- 'null'
description: The player's eligible position in DraftKings' daily fantasy
sports platform.
YahooPosition:
type:
- string
- 'null'
description: The player's eligible position in Yahoo's daily fantasy sports
platform
GlobalGameID:
type:
- integer
- 'null'
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
Updated:
type:
- string
- 'null'
description: The timestamp of when the record was last updated (US Eastern
Time)
GameInfo:
properties:
GameId:
type: integer
description: The unique ID of the game
RoundId:
type: integer
description: The unique ID of the round that this game is associated with
Season:
type: integer
description: The soccer regular season for which these totals apply
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Week:
type:
- integer
- 'null'
description: The week during the season/round in which this game occurs
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (in UTC)
Status:
type:
- string
- 'null'
description: 'Indicates the game''s status. Possible values include: Scheduled,
InProgress, Break, Final, Awarded, Postponed, Canceled, Suspended. If
a game is called off before it starts, the Status is set to Postponed,
until a new date/time is scheduled, at which point, the DateTime is updated,
and the Status is set back to Scheduled. If a game has already started,
and temporarily interrupted, it''s Status is set to Suspended, until it
either resumes, or gets postponed and replayed at a later date. If the
game is at halftime, then the Status will be Break. Awarded is used in
cases where a game is decided on the so called "green table." That means
that a game was decided by the Federation/League to one team for a reason.
This can include situations like riots, where the opponent team gets 3:0
win awarded as punishment. Awarded is also used when a club withdraws
during the season from the competition then all the remaining matches
getting awarded 3:0.'
AwayTeamId:
type:
- integer
- 'null'
description: The unique ID of the away team
HomeTeamId:
type:
- integer
- 'null'
description: The unique ID of the home team
AwayTeamName:
type:
- string
- 'null'
description: The name of the away team
HomeTeamName:
type:
- string
- 'null'
description: The name of the home team
GlobalGameId:
type: integer
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalAwayTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the away team. This value is guaranteed
to be unique across all sports/leagues.
GlobalHomeTeamId:
type:
- integer
- 'null'
description: A globally unique ID for the home team. This value is guaranteed
to be unique across all sports/leagues.
PregameOdds:
type: array
items:
$ref: '#/components/schemas/GameOdd'
description: List of Pregame Odds from different sportsbooks
LiveOdds:
type: array
items:
$ref: '#/components/schemas/GameOdd'
description: List of Live Odds from different sportsbooks
HomeTeamScore:
type:
- integer
- 'null'
description: Score of the home team (updated after game ends to allow for
resolving bets)
AwayTeamScore:
type:
- integer
- 'null'
description: Score of the away team (updated after game ends to allow for
resolving bets)
TotalScore:
type:
- integer
- 'null'
description: The total combined score of both teams in the game (updated
after game ends to allow for resolving bets)
AlternateMarketPregameOdds:
type: array
items:
$ref: '#/components/schemas/GameOdd'
description: List of Alternate Market GameOdds from different sportsbooks
(such as 1st-half, 1st-qtr, etc)
GameOdd:
properties:
GameOddId:
type: integer
description: The unique ID of this odd
Sportsbook:
type:
- string
- 'null'
description: The name of the sportsbook
GameId:
type: integer
description: The unique ID of the game
Created:
type:
- string
- 'null'
description: The timestamp of when these odds were first created (in US
Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when these odds were last updated, based on
US Eatern Time (EST/EDT). If these are the latest odds for this game,
and they have not been updated within the last few minutes, then it indicates
that there were problems connecting to the sportsbook.
HomeMoneyLine:
type:
- integer
- 'null'
description: The sportsbook's moneyline for the home team
AwayMoneyLine:
type:
- integer
- 'null'
description: The sportsbook's money line for the away team
DrawMoneyLine:
type:
- integer
- 'null'
description: The sportsbook's money line for a draw
HomePointSpread:
type:
- number
- 'null'
description: The sportsbook's point spread for the home team
AwayPointSpread:
type:
- number
- 'null'
description: The sportsbook's point spread for the away team
HomePointSpreadPayout:
type:
- integer
- 'null'
description: The sportsbook's point spread payout for the home team
AwayPointSpreadPayout:
type:
- integer
- 'null'
description: The sportsbook's point spread payout for the away team
OverUnder:
type:
- number
- 'null'
description: The sportsbook's total goals line (over/under) for the game
OverPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for the over bet on the total goals
line
UnderPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for the under bet on the total goals
line
SportsbookId:
type:
- integer
- 'null'
description: The unique ID of the sportsbook
SportsbookUrl:
type:
- string
- 'null'
description: The URL for sportsbook event
HomeTeamAsianHandicap:
type:
- number
- 'null'
description: The sportsbook's asian handicap for the home team
AwayTeamAsianHandicap:
type:
- number
- 'null'
description: The sportsbook's asian handicap for the away team
HomeTeamAsianHandicapPayout:
type:
- integer
- 'null'
description: The sportsbook's Asian handicap payout for the home team
AwayTeamAsianHandicapPayout:
type:
- integer
- 'null'
description: The sportsbook's asian handicap payout for the away team covering
AsianTotal:
type:
- number
- 'null'
description: The sportsbook's asian total for the game
AsianTotalOverPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for a result over the asian total
AsianTotalUnderPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for a result under the asian total
OddType:
type:
- string
- 'null'
description: 'The market type of the odd (ex: live; pregame; 90 minutes
+ stoppage time; etc.)'
Sportsbook:
properties:
SportsbookID:
type: integer
description: The unique ID of the sportsbook
Name:
type:
- string
- 'null'
description: The name of the sportsbook
BettingEvent:
properties:
BettingEventID:
type: integer
description: The unique ID assocated with the betting event
Name:
type:
- string
- 'null'
description: The name of this betting event
Season:
type:
- integer
- 'null'
description: The soccer regular season for which these totals apply
BettingEventTypeID:
type: integer
description: The ID associated with the type of betting event
BettingEventType:
type:
- string
- 'null'
description: Indicates the type of betting event - Game or Future
StartDate:
type:
- string
- 'null'
description: The last day for betting on this event
Created:
type:
- string
- 'null'
description: The created date of this betting event (in US Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when the betting event record was last updated
(US Eastern Time)
GameID:
type:
- integer
- 'null'
description: The unique ID of the game
GlobalGameID:
type:
- integer
- 'null'
description: A globally unique ID for this game tied to this event
GameStatus:
type:
- string
- 'null'
description: The status of the game tied to this event
Quarter:
type:
- string
- 'null'
description: The quarter of the game tied to this event
AwayTeam:
type:
- string
- 'null'
description: The abbreviation [Key] of the away team tied to this event
HomeTeam:
type:
- string
- 'null'
description: The abbreviation [Key] of the home team tied to this event
AwayTeamID:
type:
- integer
- 'null'
description: The unique ID of the away team tied to this event
HomeTeamID:
type:
- integer
- 'null'
description: The unique ID of the home team tied to this event
GlobalAwayTeamID:
type:
- integer
- 'null'
description: A globally unique ID for the away team tied to this event
GlobalHomeTeamID:
type:
- integer
- 'null'
description: A globally unique ID for the home team tied to this event
AwayTeamScore:
type:
- integer
- 'null'
description: The away team score of the game tied to this event (updated
after game ends to allow for resolving bets)
HomeTeamScore:
type:
- integer
- 'null'
description: The home team score of the game tied to this event (updated
after game ends to allow for resolving bets)
TotalScore:
type:
- integer
- 'null'
description: The total combined score of both teams in the game (updated
after game ends to allow for resolving bets)
AwayRotationNumber:
type:
- integer
- 'null'
description: The away team rotation number of the game tied to this event
HomeRotationNumber:
type:
- integer
- 'null'
description: The home team rotation number of the game tied to this event
BettingMarkets:
type: array
items:
$ref: '#/components/schemas/BettingMarket'
description: The list of betting markets for this event
CompetitionId:
type:
- integer
- 'null'
description: The Id of the competition related to this betting event
BettingMarket:
properties:
BettingMarketID:
type: integer
description: The unique ID of the betting market
BettingEventID:
type: integer
description: The unique ID assocated with the betting event
BettingMarketTypeID:
type:
- integer
- 'null'
description: The unique ID associated with the name of the market type
BettingMarketType:
type:
- string
- 'null'
description: The name of the market type within a betting market (e.g. Player
Prop, Team Prop, Game Prop, etc.)
BettingBetTypeID:
type:
- integer
- 'null'
description: The ID associated with the name of the bet type within a market
BettingBetType:
type:
- string
- 'null'
description: The name of the bet type within a market (e.g. Spread, Moneyline,
Total Goals, etc.)
BettingPeriodTypeID:
type:
- integer
- 'null'
description: The ID associated with the betting period type which we can
result
BettingPeriodType:
type:
- string
- 'null'
description: The name of the period type of a market (e.g. Regular Season;
1st half; 90 Minutes and Stoppage Time; etc.)
Name:
type:
- string
- 'null'
description: The name of this betting market
TeamID:
type:
- integer
- 'null'
description: The unique ID of the team associated with betting market
TeamKey:
type:
- string
- 'null'
description: The abbreviation [Key] of the team associated with this betting
market
PlayerID:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
PlayerName:
type:
- string
- 'null'
description: The player's full name tied to this betting market
Created:
type:
- string
- 'null'
description: The created date of this market (in US Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when the betting market record was last updated
(US Eastern Time)
AvailableSportsbooks:
type: array
items:
$ref: '#/components/schemas/Sportsbook'
description: The sportsbooks that have had odds in this market
AnyBetsAvailable:
type:
- boolean
- 'null'
description: Shows if any bets are currently available for betting in this
market
BettingOutcomes:
type: array
items:
$ref: '#/components/schemas/BettingOutcome'
description: The list of betting outcomes from each sportsbook in this market
ConsensusOutcomes:
type: array
items:
$ref: '#/components/schemas/ConsensusOutcome'
description: The single set of consesnus outcomes of this market
BettingOutcome:
properties:
BettingOutcomeID:
type:
- integer
- 'null'
description: The unique ID associated with this specific outcome
BettingMarketID:
type:
- integer
- 'null'
description: The unique ID of the betting market
SportsBook:
$ref: '#/components/schemas/Sportsbook'
description: The sportsbook offering this outcome for betting
BettingOutcomeTypeID:
type:
- integer
- 'null'
description: The ID associated with the betting outcome type
BettingOutcomeType:
type:
- string
- 'null'
description: The name of the betting outcome within a betting market (e.g.
Home; Away; Under; Over)
PayoutAmerican:
type:
- integer
- 'null'
description: 'The american odds payout '
PayoutDecimal:
type:
- number
- 'null'
description: The decimal odds payout
Value:
type:
- number
- 'null'
description: The number associated with the outcome of a market (e.g. the
spread, game total, etc.)
Participant:
type:
- string
- 'null'
description: 'The name of the participant (typically team or player) associated
with the outcome. NOTE: This is provided by the sportsbook. In the case
of Player odds, we highly recommend using PlayerID as names of players
can be inconsistent between sportsbooks.'
IsAvailable:
type:
- boolean
- 'null'
description: Indicates if this outcome is available for betting as of the
last update
IsAlternate:
type:
- boolean
- 'null'
description: Indicates if this is an alternate value or the core value
Created:
type:
- string
- 'null'
description: The created date of the outcome (in US Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when the betting outcome was last updated
(US Eastern Time)
Unlisted:
type:
- string
- 'null'
description: The timestamp of when the outcome was no longer available for
betting
TeamID:
type:
- integer
- 'null'
description: The unique ID of the team associated with betting outcome
PlayerID:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
GlobalTeamID:
type:
- integer
- 'null'
description: A globally unique ID for this team associated with this outcome
(where applicable)
SportsbookUrl:
type:
- string
- 'null'
description: The URL for sportsbook event
IsInPlay:
type:
- boolean
- 'null'
description: Was this outcome created after the start time of the game (only
applies when the betting event is of type game)
ConsensusOutcome:
properties:
NumberOfSportsbooks:
type: integer
description: The number of sportsbooks odds that went into creating this
consensus outcome
BettingOutcomeID:
type:
- integer
- 'null'
description: The unique ID associated with this specific outcome
BettingMarketID:
type:
- integer
- 'null'
description: The unique ID of the betting market
SportsBook:
$ref: '#/components/schemas/Sportsbook'
description: The sportsbook offering this outcome for betting
BettingOutcomeTypeID:
type:
- integer
- 'null'
description: The ID associated with the betting outcome type
BettingOutcomeType:
type:
- string
- 'null'
description: The name of the betting outcome within a betting market (e.g.
Home; Away; Under; Over)
PayoutAmerican:
type:
- integer
- 'null'
description: 'The american odds payout '
PayoutDecimal:
type:
- number
- 'null'
description: The decimal odds payout
Value:
type:
- number
- 'null'
description: The number associated with the outcome of a market (e.g. the
spread, game total, etc.)
Participant:
type:
- string
- 'null'
description: 'The name of the participant (typically team or player) associated
with the outcome. NOTE: This is provided by the sportsbook. In the case
of Player odds, we highly recommend using PlayerID as names of players
can be inconsistent between sportsbooks.'
IsAvailable:
type:
- boolean
- 'null'
description: Indicates if this outcome is available for betting as of the
last update
IsAlternate:
type:
- boolean
- 'null'
description: Indicates if this is an alternate value or the core value
Created:
type:
- string
- 'null'
description: The created date of the outcome (in US Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when the betting outcome was last updated
(US Eastern Time)
Unlisted:
type:
- string
- 'null'
description: The timestamp of when the outcome was no longer available for
betting
TeamID:
type:
- integer
- 'null'
description: The unique ID of the team associated with betting outcome
PlayerID:
type:
- integer
- 'null'
description: 'The player''s unique PlayerID as assigned by SportsDataIO.
Note: this ID stays with the player their entire career'
GlobalTeamID:
type:
- integer
- 'null'
description: A globally unique ID for this team associated with this outcome
(where applicable)
SportsbookUrl:
type:
- string
- 'null'
description: The URL for sportsbook event
IsInPlay:
type:
- boolean
- 'null'
description: Was this outcome created after the start time of the game (only
applies when the betting event is of type game)
BettingEntityMetadataCollection:
properties:
BettingBetTypes:
type: array
items:
$ref: '#/components/schemas/BettingEntityMetadata'
description: The list of the bet types that can be found within a market
BettingMarketTypes:
type: array
items:
$ref: '#/components/schemas/BettingEntityMetadata'
description: A list of the possible market types within a Betting Event
(e.g. Game Line, Team prop, Player Future, etc.)
BettingPeriodTypes:
type: array
items:
$ref: '#/components/schemas/BettingEntityMetadata'
description: The name of the period type of a market (e.g. Regular Season;
1st half; 90 Minutes and Stoppage Time; etc.)
BettingEventTypes:
type: array
items:
$ref: '#/components/schemas/BettingEntityMetadata'
description: A list of the possible BettingEventTypes (e.g. Game, Future)
BettingOutcomeTypes:
type: array
items:
$ref: '#/components/schemas/BettingEntityMetadata'
description: A list of the possible BettingOutcomeTypes (e.g. Home; Away;
Under; Over)
BettingEntityMetadata:
properties:
RecordId:
type: integer
description: 'The ID of the record. NOTE: Unique only within the same entity
type (i.e. BettingMarketType Ids overlap with BettingBetType Ids)'
Name:
type:
- string
- 'null'
description: Denotes the name of the Type (e.g. Betting Market Type, Betting
Event Type, Betting Period Type)
Active:
type:
- boolean
- 'null'
description: Whether or not this market is currently is use
GameInfoResult:
properties:
GameID:
type: integer
description: The unique ID of the game
Season:
type: integer
description: The soccer regular season for which these totals apply
SeasonType:
type: integer
description: The type of season that this record corresponds to (1=Regular
Season, 2=Preseason, 3=Postseason, 4=Offseason, 5=AllStar).
Day:
type:
- string
- 'null'
description: The day of the game
DateTime:
type:
- string
- 'null'
description: The date and time of the game (in UTC)
Status:
type:
- string
- 'null'
description: 'Indicates the game''s status. Possible values include: Scheduled,
InProgress, Break, Final, Awarded, Postponed, Canceled, Suspended. If
a game is called off before it starts, the Status is set to Postponed,
until a new date/time is scheduled, at which point, the DateTime is updated,
and the Status is set back to Scheduled. If a game has already started,
and temporarily interrupted, it''s Status is set to Suspended, until it
either resumes, or gets postponed and replayed at a later date. If the
game is at halftime, then the Status will be Break. Awarded is used in
cases where a game is decided on the so called "green table." That means
that a game was decided by the Federation/League to one team for a reason.
This can include situations like riots, where the opponent team gets 3:0
win awarded as punishment. Awarded is also used when a club withdraws
during the season from the competition then all the remaining matches
getting awarded 3:0.'
AwayTeamID:
type:
- integer
- 'null'
description: The unique ID of the away team
HomeTeamID:
type:
- integer
- 'null'
description: The unique ID of the home team
AwayTeamName:
type:
- string
- 'null'
description: The name of the away team
HomeTeamName:
type:
- string
- 'null'
description: The name of the home team
GlobalGameID:
type: integer
description: A globally unique ID for this game. This value is guaranteed
to be unique across all sports/leagues.
GlobalAwayTeamID:
type:
- integer
- 'null'
description: A globally unique ID for the away team. This value is guaranteed
to be unique across all sports/leagues.
GlobalHomeTeamID:
type:
- integer
- 'null'
description: A globally unique ID for the home team. This value is guaranteed
to be unique across all sports/leagues.
PregameOdds:
type: array
items:
$ref: '#/components/schemas/GameOddResult'
description: List of Pregame GameOdds from different sportsbooks with results
HomeTeamScore:
type:
- integer
- 'null'
description: Score of the home team (updated after game ends to allow for
resolving bets)
AwayTeamScore:
type:
- integer
- 'null'
description: Score of the away team (updated after game ends to allow for
resolving bets)
TotalScore:
type:
- integer
- 'null'
description: The total combined score of both teams in the game (updated
after game ends to allow for resolving bets)
RoundID:
type: integer
description: The unique ID of the round that this game is associated with
Week:
type:
- integer
- 'null'
description: The week during the season/round in which this game occurs
AlternateMarketPregameOdds:
type: array
items:
$ref: '#/components/schemas/GameOddResult'
description: List of Alternate Market GameOdds from different sportsbooks
(such as 1st-half; 1st-qtr; etc)
Period:
type:
- string
- 'null'
description: 'The final period of the game. Possible values: Regular = Game
ended in 90 minutes of regular time; ExtraTime = Game ended in extra time
/ overtime; PenaltyShootout = Game finished in penalty shootout time'
Clock:
type:
- integer
- 'null'
description: 'The clock for the game if it is in progress. Note: if the
game hasn''t started or the game is over; then this will be NULL'
Winner:
type:
- string
- 'null'
description: 'The winner of the game. Possible values: AwayTeam; HomeTeam;
Draw'
AwayTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the away team.
AwayTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the away team.
AwayTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the away team (if applicable).
AwayTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the away team (if applicable).
HomeTeamScorePeriod1:
type:
- integer
- 'null'
description: The first period score of the home team
HomeTeamScorePeriod2:
type:
- integer
- 'null'
description: The second period score of the home team
HomeTeamScoreExtraTime:
type:
- integer
- 'null'
description: The extra time (overtime) score of the home team (if applicable)
HomeTeamScorePenalty:
type:
- integer
- 'null'
description: The penalty shootout score of the home team (if applicable)
ClockExtra:
type:
- integer
- 'null'
description: 'The added stoppage time minute the game is currently in. Note:
will be null when game is not in stoppage time'
ClockDisplay:
type:
- string
- 'null'
description: A convenient string display of the current clock with format
Clock+ClockExtra (ex 90+3)
IsClosed:
type:
- boolean
- 'null'
description: Indicates whether the game is over and the final score and
stats have been verified and closed out
LiveOdds:
type: array
items:
$ref: '#/components/schemas/GameOddResult'
description: List of Live Odds from different sportsbooks with results
GameOddResult:
properties:
GameOddID:
type: integer
description: The unique ID of this odd
Sportsbook:
type:
- string
- 'null'
description: The name of the sportsbook
GameID:
type: integer
description: The unique ID of the game
Created:
type:
- string
- 'null'
description: The timestamp of when these odds were first created (in US
Eastern Time)
Updated:
type:
- string
- 'null'
description: The timestamp of when these odds were last updated, based on
US Eatern Time (EST/EDT). If these are the latest odds for this game,
and they have not been updated within the last few minutes, then it indicates
that there were problems connecting to the sportsbook.
HomeMoneyLine:
type:
- integer
- 'null'
description: The sportsbook's moneyline for the home team
AwayMoneyLine:
type:
- integer
- 'null'
description: The sportsbook's money line for the away team
HomePointSpread:
type:
- number
- 'null'
description: The sportsbook's point spread for the home team
AwayPointSpread:
type:
- number
- 'null'
description: The sportsbook's point spread for the away team
HomePointSpreadPayout:
type:
- integer
- 'null'
description: The sportsbook's point spread payout for the home team
AwayPointSpreadPayout:
type:
- integer
- 'null'
description: The sportsbook's point spread payout for the away team
OverUnder:
type:
- number
- 'null'
description: The sportsbook's total goals line (over/under) for the game
OverPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for the over bet on the total goals
line
UnderPayout:
type:
- integer
- 'null'
description: The sportsbook's payout for the under
SportsbookID:
type:
- integer
- 'null'
description: The unique ID of the sportsbook
SportsbookUrl:
type:
- string
- 'null'
description: The URL for sportsbook event
OddType:
type:
- string
- 'null'
description: The odd type of this specific odd
GameOddOutcomeResults:
type: array
items:
$ref: '#/components/schemas/GameOddOutcome'
description: List of outcomes showing results of betting markets that were
bet on for the given match
GameOddOutcome:
properties:
GameOddId:
type: integer
description: The unique ID of this odd
GameOddResultTypeId:
type:
- integer
- 'null'
description: The GameOddResultType of this outcome as an integer
GameOddResultType:
type:
- string
- 'null'
description: The string identifier of the GameOddResultType of this outcome
(e.g. Won, Lost, Push, Not Resulted, Incomplete)
OddType:
type:
- string
- 'null'
description: 'The market type of the odd (ex: live; pregame; 90 minutes
+ stoppage time; etc.)'
GameOddType:
type:
- string
- 'null'
description: The GameOddOutcomeType of this outcome as a string
BetValue:
type:
- number
- 'null'
description: The value that was bet in this outcome (if applicable)
ActualValue:
type:
- number
- 'null'
description: The value that actually occurred in game (if applicable)
securitySchemes:
apiKeyHeader:
type: apiKey
name: Ocp-Apim-Subscription-Key
in: header
apiKeyQuery:
type: apiKey
name: key
in: query
security:
- apiKeyHeader: []
- apiKeyQuery: []