3.0.0 • Published 5 years ago
@datafire/sportsdata_mlb_v3_scores v3.0.0
@datafire/sportsdata_mlb_v3_scores
Client library for MLB v3 Scores
Installation and Usage
npm install --save @datafire/sportsdata_mlb_v3_scoreslet sportsdata_mlb_v3_scores = require('@datafire/sportsdata_mlb_v3_scores').create({
  apiKeyHeader: "",
  apiKeyQuery: ""
});
.then(data => {
  console.log(data);
});Description
MLB scores API.
Actions
TeamsAll
Teams (All)
sportsdata_mlb_v3_scores.TeamsAll({
  "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
 
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_mlb_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_mlb_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 Season
PlayerDetailsByFreeAgents
Player Details by Free Agents
sportsdata_mlb_v3_scores.PlayerDetailsByFreeAgents({
  "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
 
Schedules
Schedules
sportsdata_mlb_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_mlb_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: The date of the game(s).
 
- format required 
Output
- output array- items Game
 
News
News
sportsdata_mlb_v3_scores.News({
  "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 News
 
NewsByDate
News by Date
sportsdata_mlb_v3_scores.NewsByDate({
  "format": "",
  "date": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- date required string: The date of the news.
 
- format required 
Output
- output array- items News
 
NewsByPlayer
News by Player
sportsdata_mlb_v3_scores.NewsByPlayer({
  "format": "",
  "playerid": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- playerid required string: Unique FantasyData Player ID.
 
- format required 
Output
- output array- items News
 
PlayerDetailsByPlayer
Player Details by Player
sportsdata_mlb_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: Unique FantasyData Player ID.
 
- format required 
Output
- output Player
PlayerDetailsByActive
Player Details by Active
sportsdata_mlb_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
 
PlayersByTeam
Players by Team
sportsdata_mlb_v3_scores.PlayersByTeam({
  "format": "",
  "team": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- team required string: The abbreviation of the requested team.
 
- format required 
Output
- output array- items Player
 
Stadiums
Stadiums
sportsdata_mlb_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
 
Standings
Standings
sportsdata_mlb_v3_scores.Standings({
  "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.
 
- format required 
Output
- output array- items Standing
 
TeamGameStatsByDate
Team Game Stats by Date
sportsdata_mlb_v3_scores.TeamGameStatsByDate({
  "format": "",
  "date": ""
}, context)Input
- input object- format required string(values: XML, JSON): Desired response format. Valid entries are XML or JSON.
- date required string: The date of the game(s).
 
- format required 
Output
- output array- items TeamGame
 
TeamSeasonStats
Team Season Stats
sportsdata_mlb_v3_scores.TeamSeasonStats({
  "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.
 
- format required 
Output
- output array- items TeamSeason
 
TeamsActive
Teams (Active)
sportsdata_mlb_v3_scores.TeamsActive({
  "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
Game
- Game object- Attendance integer
- AwayRotationNumber integer
- AwayTeam string
- AwayTeamErrors integer
- AwayTeamHits integer
- AwayTeamID integer
- AwayTeamMoneyLine integer
- AwayTeamProbablePitcherID integer
- AwayTeamRuns integer
- AwayTeamStartingPitcher string
- AwayTeamStartingPitcherID integer
- Balls integer
- Channel string
- CurrentHitter string
- CurrentHitterID integer
- CurrentHittingTeamID integer
- CurrentPitcher string
- CurrentPitcherID integer
- CurrentPitchingTeamID integer
- DateTime string
- Day string
- DueUpHitterID1 integer
- DueUpHitterID2 integer
- DueUpHitterID3 integer
- ForecastDescription string
- ForecastTempHigh integer
- ForecastTempLow integer
- ForecastWindChill integer
- ForecastWindDirection integer
- ForecastWindSpeed integer
- GameEndDateTime string
- GameID integer
- GlobalAwayTeamID integer
- GlobalGameID integer
- GlobalHomeTeamID integer
- HomeRotationNumber integer
- HomeTeam string
- HomeTeamErrors integer
- HomeTeamHits integer
- HomeTeamID integer
- HomeTeamMoneyLine integer
- HomeTeamProbablePitcherID integer
- HomeTeamRuns integer
- HomeTeamStartingPitcher string
- HomeTeamStartingPitcherID integer
- Inning integer
- InningDescription string
- InningHalf string
- Innings array- items Inning
 
- IsClosed boolean
- LastPlay string
- LosingPitcher string
- LosingPitcherID integer
- NeutralVenue boolean
- Outs integer
- OverUnder number
- PointSpread number
- PointSpreadAwayTeamMoneyLine integer
- PointSpreadHomeTeamMoneyLine integer
- RescheduledFromGameID integer
- RescheduledGameID integer
- RunnerOnFirst boolean
- RunnerOnSecond boolean
- RunnerOnThird boolean
- SavingPitcher string
- SavingPitcherID integer
- Season integer
- SeasonType integer
- StadiumID integer
- Status string
- Strikes integer
- Updated string
- WinningPitcher string
- WinningPitcherID integer
 
- Attendance 
Inning
- Inning object- AwayTeamRuns integer
- GameID integer
- HomeTeamRuns integer
- InningID integer
- InningNumber integer
 
- AwayTeamRuns 
News
- News object- Author string
- Categories string
- Content string
- NewsID integer
- OriginalSource string
- OriginalSourceUrl string
- PlayerID integer
- PlayerID2 integer
- Source string
- Team string
- Team2 string
- TeamID integer
- TeamID2 integer
- TermsOfUse string
- TimeAgo string
- Title string
- Updated string
- Url string
 
- Author 
Player
- Player object- BatHand string
- BirthCity string
- BirthCountry string
- BirthDate string
- BirthState string
- College string
- DraftKingsName string
- DraftKingsPlayerID integer
- Experience string
- FanDuelName string
- FanDuelPlayerID integer
- FantasyAlarmPlayerID integer
- FantasyDraftName string
- FantasyDraftPlayerID integer
- FirstName string
- GlobalTeamID integer
- Height integer
- HighSchool string
- InjuryBodyPart string
- InjuryNotes string
- InjuryStartDate string
- InjuryStatus string
- Jersey integer
- LastName string
- MLBAMID integer
- PhotoUrl string
- PlayerID integer
- Position string
- PositionCategory string
- ProDebut string
- RotoWirePlayerID integer
- RotoworldPlayerID integer
- Salary integer
- SportRadarPlayerID string
- SportsDataID string
- SportsDirectPlayerID integer
- StatsPlayerID integer
- Status string
- Team string
- TeamID integer
- ThrowHand string
- UpcomingGameID integer
- UsaTodayHeadshotNoBackgroundUpdated string
- UsaTodayHeadshotNoBackgroundUrl string
- UsaTodayHeadshotUpdated string
- UsaTodayHeadshotUrl string
- UsaTodayPlayerID integer
- Weight integer
- XmlTeamPlayerID integer
- YahooName string
- YahooPlayerID integer
 
- BatHand 
Season
- Season object- ApiSeason string
- PostSeasonStartDate string
- RegularSeasonStartDate string
- Season integer
- SeasonType string
 
- ApiSeason 
Stadium
- Stadium object- Active boolean
- Altitude integer
- Capacity integer
- CenterField integer
- City string
- Country string
- GeoLat number
- GeoLong number
- HomePlateDirection integer
- LeftCenterField integer
- LeftField integer
- MidLeftCenterField integer
- MidLeftField integer
- MidRightCenterField integer
- MidRightField integer
- Name string
- RightCenterField integer
- RightField integer
- StadiumID integer
- State string
- Surface string
- Type string
 
- Active 
Standing
- Standing object- AwayLosses integer
- AwayWins integer
- City string
- DayLosses integer
- DayWins integer
- Division string
- DivisionLosses integer
- DivisionRank integer
- DivisionWins integer
- GamesBehind number
- GlobalTeamID integer
- HomeLosses integer
- HomeWins integer
- Key string
- LastTenGamesLosses integer
- LastTenGamesWins integer
- League string
- LeagueRank integer
- Losses integer
- Name string
- NightLosses integer
- NightWins integer
- Percentage number
- RunsAgainst integer
- RunsScored integer
- Season integer
- SeasonType integer
- Streak string
- TeamID integer
- WildCardGamesBehind number
- WildCardRank integer
- Wins integer
 
- AwayLosses 
Team
- Team object- Active boolean
- City string
- Division string
- GlobalTeamID integer
- League string
- Name string
- PrimaryColor string
- QuaternaryColor string
- SecondaryColor string
- StadiumID integer
- TeamID integer
- TertiaryColor string
- WikipediaLogoUrl string
- WikipediaWordMarkUrl string
- Key string
 
- Active 
TeamGame
- TeamGame object- AtBats number
- BallsInPlay number
- BattingAverage number
- BattingAverageOnBallsInPlay number
- BattingOrderConfirmed boolean
- CaughtStealing number
- DateTime string
- Day string
- DoublePlays number
- Doubles number
- EarnedRunAverage number
- Errors number
- FantasyPoints number
- FantasyPointsDraftKings number
- FantasyPointsFanDuel number
- FantasyPointsFantasyDraft number
- FantasyPointsYahoo number
- FieldingIndependentPitching number
- FlyOuts number
- GameID integer
- Games integer
- GlobalGameID integer
- GlobalOpponentID integer
- GlobalTeamID integer
- GrandSlams number
- GroundIntoDoublePlay number
- GroundOuts number
- HitByPitch number
- Hits number
- HomeOrAway string
- HomeRuns number
- InningsPitchedDecimal number
- InningsPitchedFull number
- InningsPitchedOuts number
- IntentionalWalks number
- IsGameOver boolean
- IsolatedPower number
- LeftOnBase number
- LineOuts number
- Losses number
- Name string
- OnBasePercentage number
- OnBasePlusSlugging number
- Opponent string
- OpponentID integer
- Outs number
- PitchesSeen number
- PitchesThrown number
- PitchesThrownStrikes number
- PitchingBallsInPlay number
- PitchingBattingAverageAgainst number
- PitchingBattingAverageOnBallsInPlay number
- PitchingBlownSaves number
- PitchingCatchersInterference number
- PitchingCompleteGames number
- PitchingDoublePlays number
- PitchingDoubles number
- PitchingEarnedRuns number
- PitchingFlyOuts number
- PitchingGrandSlams number
- PitchingGroundIntoDoublePlay number
- PitchingGroundOuts number
- PitchingHitByPitch number
- PitchingHits number
- PitchingHolds number
- PitchingHomeRuns number
- PitchingInningStarted integer
- PitchingIntentionalWalks number
- PitchingLineOuts number
- PitchingNoHitters number
- PitchingOnBasePercentage number
- PitchingOnBasePlusSlugging number
- PitchingPerfectGames number
- PitchingPlateAppearances number
- PitchingPopOuts number
- PitchingQualityStarts number
- PitchingReachedOnError number
- PitchingRuns number
- PitchingSacrificeFlies number
- PitchingSacrifices number
- PitchingShutOuts number
- PitchingSingles number
- PitchingSluggingPercentage number
- PitchingStrikeouts number
- PitchingStrikeoutsPerNineInnings number
- PitchingTotalBases number
- PitchingTriples number
- PitchingWalks number
- PitchingWalksPerNineInnings number
- PitchingWeightedOnBasePercentage number
- PlateAppearances number
- PopOuts number
- ReachedOnError number
- Runs number
- RunsBattedIn number
- SacrificeFlies number
- Sacrifices number
- Saves number
- Season integer
- SeasonType integer
- Singles number
- SluggingPercentage number
- StatID integer
- StolenBases number
- Strikeouts number
- SubstituteBattingOrder integer
- SubstituteBattingOrderSequence integer
- Team string
- TeamID integer
- TotalBases number
- TotalOutsPitched number
- Triples number
- Updated string
- Walks number
- WalksHitsPerInningsPitched number
- WeightedOnBasePercentage number
- Wins number
 
- AtBats 
TeamSeason
- TeamSeason object- AtBats number
- BallsInPlay number
- BattingAverage number
- BattingAverageOnBallsInPlay number
- BattingOrderConfirmed boolean
- CaughtStealing number
- DoublePlays number
- Doubles number
- EarnedRunAverage number
- Errors number
- FantasyPoints number
- FantasyPointsDraftKings number
- FantasyPointsFanDuel number
- FantasyPointsFantasyDraft number
- FantasyPointsYahoo number
- FieldingIndependentPitching number
- FlyOuts number
- Games integer
- GlobalTeamID integer
- GrandSlams number
- GroundIntoDoublePlay number
- GroundOuts number
- HitByPitch number
- Hits number
- HomeRuns number
- InningsPitchedDecimal number
- InningsPitchedFull number
- InningsPitchedOuts number
- IntentionalWalks number
- IsolatedPower number
- LeftOnBase number
- LineOuts number
- Losses number
- Name string
- OnBasePercentage number
- OnBasePlusSlugging number
- Outs number
- PitchesSeen number
- PitchesThrown number
- PitchesThrownStrikes number
- PitchingBallsInPlay number
- PitchingBattingAverageAgainst number
- PitchingBattingAverageOnBallsInPlay number
- PitchingBlownSaves number
- PitchingCatchersInterference number
- PitchingCompleteGames number
- PitchingDoublePlays number
- PitchingDoubles number
- PitchingEarnedRuns number
- PitchingFlyOuts number
- PitchingGrandSlams number
- PitchingGroundIntoDoublePlay number
- PitchingGroundOuts number
- PitchingHitByPitch number
- PitchingHits number
- PitchingHolds number
- PitchingHomeRuns number
- PitchingInningStarted integer
- PitchingIntentionalWalks number
- PitchingLineOuts number
- PitchingNoHitters number
- PitchingOnBasePercentage number
- PitchingOnBasePlusSlugging number
- PitchingPerfectGames number
- PitchingPlateAppearances number
- PitchingPopOuts number
- PitchingQualityStarts number
- PitchingReachedOnError number
- PitchingRuns number
- PitchingSacrificeFlies number
- PitchingSacrifices number
- PitchingShutOuts number
- PitchingSingles number
- PitchingSluggingPercentage number
- PitchingStrikeouts number
- PitchingStrikeoutsPerNineInnings number
- PitchingTotalBases number
- PitchingTriples number
- PitchingWalks number
- PitchingWalksPerNineInnings number
- PitchingWeightedOnBasePercentage number
- PlateAppearances number
- PopOuts number
- ReachedOnError number
- Runs number
- RunsBattedIn number
- SacrificeFlies number
- Sacrifices number
- Saves number
- Season integer
- SeasonType integer
- Singles number
- SluggingPercentage number
- StatID integer
- StolenBases number
- Strikeouts number
- SubstituteBattingOrder integer
- SubstituteBattingOrderSequence integer
- Team string
- TeamID integer
- TotalBases number
- TotalOutsPitched number
- Triples number
- Updated string
- Walks number
- WalksHitsPerInningsPitched number
- WeightedOnBasePercentage number
- Wins number
 
- AtBats 
3.0.0
5 years ago