3.0.0 • Published 5 years ago
@datafire/sportsdata_cfb_v3_scores v3.0.0
@datafire/sportsdata_cfb_v3_scores
Client library for CFB v3 Scores
Installation and Usage
npm install --save @datafire/sportsdata_cfb_v3_scoreslet sportsdata_cfb_v3_scores = require('@datafire/sportsdata_cfb_v3_scores').create({
  apiKeyHeader: "",
  apiKeyQuery: ""
});
.then(data => {
  console.log(data);
});Description
CFB schedules, scores, team stats, odds, weather, and news API.
Actions
AreGamesInProgress
Returns true if there is at least one game being played at the time of the request or false if there are none.
sportsdata_cfb_v3_scores.AreGamesInProgress({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output boolean
CurrentSeason
Current Season
sportsdata_cfb_v3_scores.CurrentSeason({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output integer
CurrentSeasonDetails
Current Season Details
sportsdata_cfb_v3_scores.CurrentSeasonDetails({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output Season
CurrentSeasontype
Current SeasonType
sportsdata_cfb_v3_scores.CurrentSeasontype({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output string
CurrentWeek
Current Week
sportsdata_cfb_v3_scores.CurrentWeek({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output integer
Schedules
Schedules
sportsdata_cfb_v3_scores.Schedules({
  "format": "",
  "season": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
- season required string: Year of the season (with optional season type).Examples: 2018, 2018PRE, 2018POST, 2018STAR, 2019, etc.
 
- format required 
Output
- output array- items Game
 
GamesByDate
Games by Date
sportsdata_cfb_v3_scores.GamesByDate({
  "format": "",
  "date": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
- date required string:
 
- format required 
Output
- output array- items Game
 
GamesByWeek
Games by Week
sportsdata_cfb_v3_scores.GamesByWeek({
  "format": "",
  "season": "",
  "week": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
- season required string:
- week required string:
 
- format required 
Output
- output array- items Game
 
ConferenceHierarchyWithTeams
Conference Hierarchy (with Teams)
sportsdata_cfb_v3_scores.ConferenceHierarchyWithTeams({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output array- items Conference
 
PlayerDetailsByPlayer
Player Details By Player
sportsdata_cfb_v3_scores.PlayerDetailsByPlayer({
  "format": "",
  "playerid": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- playerid required string:
 
- format required 
Output
- output array- items Player
 
PlayerDetailsByActive
Player Details By Active
sportsdata_cfb_v3_scores.PlayerDetailsByActive({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
 
- format required 
Output
- output array- items Player
 
PlayerDetailsByTeam
Player Details by Team
sportsdata_cfb_v3_scores.PlayerDetailsByTeam({
  "format": "",
  "team": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- team required string:
 
- format required 
Output
- output array- items Player
 
Stadiums
Stadiums
sportsdata_cfb_v3_scores.Stadiums({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output array- items Stadium
 
TeamGameStatsByWeek
Team Game Stats by Week
sportsdata_cfb_v3_scores.TeamGameStatsByWeek({
  "format": "",
  "season": "",
  "week": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
- season required string:
- week required string:
 
- format required 
Output
- output array- items TeamGame
 
TeamSeasonStatsStandings
Team Season Stats & Standings
sportsdata_cfb_v3_scores.TeamSeasonStatsStandings({
  "format": "",
  "season": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
- season required string: Year of the season (with optional season type).Examples: 2017, 2017POST, 2018.
 
- format required 
Output
- output array- items TeamSeason
 
Teams
Teams
sportsdata_cfb_v3_scores.Teams({
  "format": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are xml or json.
 
- format required 
Output
- output array- items Team
 
Definitions
Conference
- Conference object- ConferenceID integer
- ConferenceName string
- DivisionName string
- Name string
- Teams array- items Team
 
 
- ConferenceID 
Game
- Game object- AwayRotationNumber integer
- AwayTeam string
- AwayTeamID integer
- AwayTeamMoneyLine integer
- AwayTeamName string
- AwayTeamScore integer
- Channel string
- Created string
- DateTime string
- Day string
- Distance integer
- Down integer
- GameEndDateTime string
- GameID integer
- GlobalAwayTeamID integer
- GlobalGameID integer
- GlobalHomeTeamID integer
- HomeRotationNumber integer
- HomeTeam string
- HomeTeamID integer
- HomeTeamMoneyLine integer
- HomeTeamName string
- HomeTeamScore integer
- IsClosed boolean
- NeutralVenue boolean
- OverUnder number
- Period string
- Periods array- items Period
 
- PointSpread number
- Possession string
- Season integer
- SeasonType integer
- Stadium Stadium
- StadiumID integer
- Status string
- TimeRemainingMinutes integer
- TimeRemainingSeconds integer
- Title string
- Updated string
- Week integer
- YardLine integer
- YardLineTerritory string
 
- AwayRotationNumber 
Period
- Period object- AwayScore integer
- GameID integer
- HomeScore integer
- Name string
- Number integer
- PeriodID integer
 
- AwayScore 
Player
- Player object- BirthCity string
- BirthState string
- Class string
- Created string
- FirstName string
- GlobalTeamID integer
- Height integer
- InjuryBodyPart string
- InjuryNotes string
- InjuryStartDate string
- InjuryStatus string
- Jersey integer
- LastName string
- PlayerID integer
- Position string
- PositionCategory string
- Team string
- TeamID integer
- Updated string
- Weight integer
 
- BirthCity 
Season
- Season object- ApiSeason string
- ApiWeek integer
- Description string
- EndYear integer
- Season integer
- StartYear integer
 
- ApiSeason 
Stadium
- Stadium object- Active boolean
- City string
- Dome boolean
- Name string
- StadiumID integer
- State string
 
- Active 
Team
- Team object- Active boolean
- ApRank integer
- CoachesRank integer
- Conference string
- ConferenceID integer
- ConferenceLosses integer
- ConferenceWins integer
- GlobalTeamID integer
- Losses integer
- Name string
- PlayoffRank integer
- RankSeason integer
- RankSeasonType integer
- RankWeek integer
- School string
- ShortDisplayName string
- StadiumID integer
- TeamID integer
- TeamLogoUrl string
- Wins integer
- Key string
 
- Active 
TeamGame
- TeamGame object- AssistedTackles number
- Created string
- DateTime string
- Day string
- ExtraPointsAttempted number
- ExtraPointsMade number
- FantasyPoints number
- FieldGoalPercentage number
- FieldGoalsAttempted number
- FieldGoalsLongestMade number
- FieldGoalsMade number
- FirstDowns integer
- FourthDownAttempts integer
- FourthDownConversions integer
- FumbleReturnTouchdowns number
- Fumbles number
- FumblesLost number
- FumblesRecovered number
- GameID integer
- Games integer
- GlobalGameID integer
- GlobalOpponentID integer
- GlobalTeamID integer
- HomeOrAway string
- InterceptionReturnTouchdowns number
- InterceptionReturnYards number
- Interceptions number
- IsGameOver boolean
- KickReturnLong number
- KickReturnTouchdowns number
- KickReturnYards number
- KickReturnYardsPerAttempt number
- KickReturns number
- Name string
- Opponent string
- OpponentID integer
- OpponentScore integer
- PassesDefended number
- PassingAttempts number
- PassingCompletionPercentage number
- PassingCompletions number
- PassingInterceptions number
- PassingRating number
- PassingTouchdowns number
- PassingYards number
- PassingYardsPerAttempt number
- PassingYardsPerCompletion number
- Penalties integer
- PenaltyYards integer
- PuntAverage number
- PuntLong number
- PuntReturnLong number
- PuntReturnTouchdowns number
- PuntReturnYards number
- PuntReturnYardsPerAttempt number
- PuntReturns number
- PuntYards number
- Punts number
- QuarterbackHurries number
- ReceivingLong number
- ReceivingTouchdowns number
- ReceivingYards number
- ReceivingYardsPerReception number
- Receptions number
- RushingAttempts number
- RushingLong number
- RushingTouchdowns number
- RushingYards number
- RushingYardsPerAttempt number
- Sacks number
- Score integer
- Season integer
- SeasonType integer
- SoloTackles number
- StatID integer
- TacklesForLoss number
- Team string
- TeamID integer
- ThirdDownAttempts integer
- ThirdDownConversions integer
- TimeOfPossessionMinutes integer
- TimeOfPossessionSeconds integer
- Updated string
- Week integer
 
- AssistedTackles 
TeamSeason
- TeamSeason object- AssistedTackles number
- ConferenceLosses integer
- ConferencePointsAgainst integer
- ConferencePointsFor integer
- ConferenceRank integer
- ConferenceWins integer
- Created string
- DivisionRank integer
- ExtraPointsAttempted number
- ExtraPointsMade number
- FantasyPoints number
- FieldGoalPercentage number
- FieldGoalsAttempted number
- FieldGoalsLongestMade number
- FieldGoalsMade number
- FirstDowns integer
- FourthDownAttempts integer
- FourthDownConversions integer
- FumbleReturnTouchdowns number
- Fumbles number
- FumblesLost number
- FumblesRecovered number
- Games integer
- GlobalTeamID integer
- HomeLosses integer
- HomeWins integer
- InterceptionReturnTouchdowns number
- InterceptionReturnYards number
- Interceptions number
- KickReturnLong number
- KickReturnTouchdowns number
- KickReturnYards number
- KickReturnYardsPerAttempt number
- KickReturns number
- Losses integer
- Name string
- OpponentScore integer
- PassesDefended number
- PassingAttempts number
- PassingCompletionPercentage number
- PassingCompletions number
- PassingInterceptions number
- PassingRating number
- PassingTouchdowns number
- PassingYards number
- PassingYardsPerAttempt number
- PassingYardsPerCompletion number
- Penalties integer
- PenaltyYards integer
- PointsAgainst integer
- PointsFor integer
- PuntAverage number
- PuntLong number
- PuntReturnLong number
- PuntReturnTouchdowns number
- PuntReturnYards number
- PuntReturnYardsPerAttempt number
- PuntReturns number
- PuntYards number
- Punts number
- QuarterbackHurries number
- ReceivingLong number
- ReceivingTouchdowns number
- ReceivingYards number
- ReceivingYardsPerReception number
- Receptions number
- RoadLosses integer
- RoadWins integer
- RushingAttempts number
- RushingLong number
- RushingTouchdowns number
- RushingYards number
- RushingYardsPerAttempt number
- Sacks number
- Score integer
- Season integer
- SeasonType integer
- SoloTackles number
- StatID integer
- Streak integer
- TacklesForLoss number
- Team string
- TeamID integer
- ThirdDownAttempts integer
- ThirdDownConversions integer
- TimeOfPossessionMinutes integer
- TimeOfPossessionSeconds integer
- Updated string
- Wins integer
 
- AssistedTackles 
3.0.0
5 years ago