openapi: 3.1.0
info:
title: MLB MLB v3 Headshots NFL v3 Scores API
version: '1.0'
description: MLB API - OpenAPI 3.1 Specification
servers:
- url: https://api.sportsdata.io
description: Production server
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: NFL v3 Scores
paths:
/v3/nfl/scores/{format}/AreAnyGamesInProgress:
get:
description: Returns <code>true</code> if there is at least one game being played at the time of the request or <code>false</code> if there are none.
operationId: nfl_v3_scores_are_games_in_progress
summary: Are Games In Progress
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: boolean
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Teams:
get:
description: 'Full team information: team name and city, conference and division, colors, coaching and scheme info. Also contains basic fantasy info such as IDs as well as full stadium data. This endpoint returns the teams currently active in the league.'
operationId: nfl_v3_scores_team_profiles___by_active
summary: Team Profiles - by Active
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
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:
- NFL v3 Scores
/v3/nfl/scores/{format}/Byes/{season}:
get:
description: Get bye weeks for the teams during a specified NFL season.
operationId: nfl_v3_scores_bye_weeks
summary: Bye Weeks
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "\n Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Bye'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/CurrentSeason:
get:
description: Year of the current NFL season. This value changes at the start of the new NFL league year. NFL seasons run across two calendar years; the league year is the one in which it starts, not ends (that is, a season starting in 2023 and ending in 2024 will have the league year of 2023.)
operationId: nfl_v3_scores_season___current
summary: Season - Current
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type:
- integer
- 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/CurrentWeek:
get:
description: Number of the current week of the NFL season. This value usually changes on Tuesday nights or Wednesday mornings at midnight ET but in the rare case of a rescheduled or overseas game with a non-standard gameday this could change.
operationId: nfl_v3_scores_week___current
summary: Week - Current
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type:
- integer
- 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Scores/{season}:
get:
description: Full scores and gameday info delivered live and post-game. Live data includes down and distance, as well as game clock. Gameday info includes referee, weather, TV channel etc.
operationId: nfl_v3_scores_games___by_season__live___final
summary: Games - by Season [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: 'Year of the season (with optional season type).<br>Examples: <code>2018</code>, <code>2018PRE</code>, <code>2018POST</code>, <code>2018STAR</code>, <code>2019</code>, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Score'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/LastCompletedSeason:
get:
description: Year of the most recently completed NFL season. This value changes immediately after the Super Bowl. NFL seasons run across two calendar years; the league year is the one in which it starts, not ends (that is, a season starting in 2023 and ending in 2024 will have the league year of 2023.)
operationId: nfl_v3_scores_season___last_completed
summary: Season - Last Completed
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type:
- integer
- 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/LastCompletedWeek:
get:
description: Number of the last completed week of the NFL season. This value usually changes on Tuesday nights or Wednesday mornings at midnight ET but in the rare case of a rescheduled or overseas game with a non-standard gameday this could change.
operationId: nfl_v3_scores_week___last_completed
summary: Week - Last Completed
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type:
- integer
- 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/News:
get:
description: Basic RotoBaller news feed, with limited stories available - usually 0-1 stories per day. Ideal for test purposes.
operationId: nfl_v3_scores_news
summary: News
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/NewsByPlayerID/{playerid}:
get:
description: Basic RotoBaller news feed, with limited stories available - usually 0-1 stories per day. Ideal for test purposes.
operationId: nfl_v3_scores_news___by_player
summary: News - by Player
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: playerid
in: path
description: Each NFL player has a unique ID assigned by FantasyData. Player IDs can be determined by pulling player related data. Example:<code>14257</code>.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/NewsByTeam/{team}:
get:
description: Basic RotoBaller news feed, with limited stories available - usually 0-1 stories per day. Ideal for test purposes.
operationId: nfl_v3_scores_news___by_team
summary: News - by Team
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: team
in: path
description: 'Abbreviation of the team. Example: <code>WAS</code>.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Schedules/{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: nfl_v3_scores_schedules
summary: Schedules
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: 'Year of the season (with optional season type).<br>Examples: <code>2018</code>, <code>2018PRE</code>, <code>2018POST</code>, <code>2018STAR</code>, <code>2019</code>, etc.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Schedule'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/ScoresByWeek/{season}/{week}:
get:
description: Full scores and gameday info delivered live and post-game. Live data includes down and distance, as well as game clock. Gameday info includes referee, weather, TV channel etc.
operationId: nfl_v3_scores_games___by_week__live___final
summary: Games - by Week [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "\n Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.\n "
required: true
schema:
type: string
- name: week
in: path
description: "\n Week of the season. Valid values are as follows: Preseason 0 to 4, Regular Season 1 to 17, Postseason 1 to 4.\n Example: <code>1</code>\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Score'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Stadiums:
get:
description: Returns all stadiums in the NFL with capacity, surface, latitude/longitude, city and state (and, where applicable, country.)
operationId: nfl_v3_scores_stadiums
summary: Stadiums
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Stadium'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Standings/{season}:
get:
description: Includes regular season standings in division and conference, from which postseason seeding can be derived.
operationId: nfl_v3_scores_standings
summary: Standings
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "\n Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Standing'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Teams/{season}:
get:
description: 'Full team information: team name and city, conference and division, colors, coaching and scheme info. Also contains basic fantasy info such as IDs as well as full stadium data. This endpoint returns the active teams for a given season.'
operationId: nfl_v3_scores_team_profiles___by_season
summary: Team Profiles - by Season
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "\n Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.\n "
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:
- NFL v3 Scores
/v3/nfl/scores/{format}/Timeframes/{type}:
get:
description: Timeframes for the NFL refer to current weeks, season status etc.
operationId: nfl_v3_scores_timeframes
summary: Timeframes
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: type
in: path
description: The type of timeframes to return. Valid entries are <code>current</code> or <code>upcoming</code> or <code>completed</code> or <code>recent</code> or <code>all</code>.
required: true
schema:
type: string
enum:
- current
- upcoming
- completed
- recent
- all
default: current
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Timeframe'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/UpcomingSeason:
get:
description: Year of the current NFL season, if we are in the mid-season. If we are in the off-season, then year of the next upcoming season. This value changes immediately after the Super Bowl. NFL seasons run across two calendar years; the league year is the one in which it starts, not ends (that is, a season starting in 2023 and ending in 2024 will have the league year of 2023.)
operationId: nfl_v3_scores_season___upcoming
summary: Season - Upcoming
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type:
- integer
- 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/UpcomingWeek:
get:
description: Number of the next upcoming week of the NFL season. This value usually changes on Tuesday nights or Wednesday mornings at midnight ET but in the rare case of a rescheduled or overseas game with a non-standard gameday this could change.
operationId: nfl_v3_scores_week___upcoming
summary: Week - Upcoming
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
responses:
'200':
description: Success
content:
application/json:
schema:
type:
- integer
- 'null'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/TeamGameStats/{season}/{week}:
get:
description: Returns the box score statistical record team-wide (aggregated from all players) for a given team's game in a given week, during the game and with final stats after it ends.
operationId: nfl_v3_scores_team_game_stats__live___final
summary: Team Game Stats [Live & Final]
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "\n Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.\n "
required: true
schema:
type: string
- name: week
in: path
description: "\n Week of the season. Valid values are as follows: Preseason 0 to 4, Regular Season 1 to 17, Postseason 1 to 4.\n Example: <code>1</code>\n "
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:
- NFL v3 Scores
/v3/nfl/scores/{format}/TeamSeasonStats/{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: nfl_v3_scores_team_season_stats
summary: Team Season Stats
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: season
in: path
description: "\n Year of the season and the season type. If no season type is provided, then the default is regular season.\n <br>Examples: <code>2015REG</code>, <code>2015PRE</code>, <code>2015POST</code>.\n "
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TeamSeason'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/AllTeams:
get:
description: 'Full team information: team name and city, conference and division, colors, coaching and scheme info. Also contains basic fantasy info such as IDs as well as full stadium data. This endpoint returns all teams regardless of current active status.'
operationId: nfl_v3_scores_team_profiles___all
summary: Team Profiles - All
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
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:
- NFL v3 Scores
/v3/nfl/scores/{format}/NewsByDate/{date}:
get:
description: Basic RotoBaller news feed, with limited stories available - usually 0-1 stories per day. Ideal for test purposes.
operationId: nfl_v3_scores_news___by_date
summary: News - by Date
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: date
in: path
description: 'The date of the news.
<br>Examples: <code>2017-JUL-31</code>, <code>2017-SEP-01</code>.'
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/News'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/SimulatedScores/{numberofplays}:
get:
description: Gets simulated live scores of NFL games, covering the Conference Championship games on January 21, 2018.
operationId: nfl_v3_scores_scores_by_week_simulation
summary: Scores by Week Simulation
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
- name: numberofplays
in: path
description: The number of plays to progress in this NFL live game simulation. Example entries are <code>0</code>, <code>1</code>, <code>2</code>, <code>3</code>, <code>150</code>, <code>200</code>, etc.
required: true
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Score'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
tags:
- NFL v3 Scores
/v3/nfl/scores/{format}/Players:
get:
description: Full player bio and details, including injury notes, for all NFL players in our database.
operationId: nfl_v3_scores_player_details___all
summary: Player Details - All
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
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:
- NFL v3 Scores
/v3/nfl/scores/{format}/FreeAgents:
get:
description: Full player bio and details, including injury notes, for all available NFL free agents unattached to a team.
operationId: nfl_v3_scores_player_details___by_free_agents
summary: Player Details - by Free Agents
parameters:
- name: format
in: path
description: Desired response format. Valid entries are <code>JSON</code> or <code>XML</code>.
required: true
schema:
type: string
enum:
- JSON
- XML
default: JSON
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'
# --- truncated at 32 KB (251 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sportsdataio/refs/heads/main/openapi/sportsdataio-nfl-v3-scores-api-openapi.yml