4.0.0 • Published 5 years ago
@datafire/fantasydata_soccer_v3_stats v4.0.0
@datafire/fantasydata_soccer_v3_stats
Client library for Soccer v3 Stats
Installation and Usage
npm install --save @datafire/fantasydata_soccer_v3_statslet fantasydata_soccer_v3_stats = require('@datafire/fantasydata_soccer_v3_stats').create({
apiKeyHeader: "",
apiKeyQuery: ""
});
.then(data => {
console.log(data);
});Description
Actions
MembershipsActive
Memberships (Active)
fantasydata_soccer_v3_stats.MembershipsActive({
"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 Membership
AreasCountries
Areas (Countries)
fantasydata_soccer_v3_stats.AreasCountries({
"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 Area
BoxScore
Box Score
fantasydata_soccer_v3_stats.BoxScore({
"format": "",
"gameid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - gameid required
string: The GameID of a Soccer game. GameIDs can be found in the Games API. Valid entries are 702, 1274, etc.
- format required
Output
- output BoxScore
BoxScoresByDate
Box Scores by Date
fantasydata_soccer_v3_stats.BoxScoresByDate({
"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 BoxScore
BoxScoresByDateByCompetition
Box Scores by Date by Competition
fantasydata_soccer_v3_stats.BoxScoresByDateByCompetition({
"format": "",
"competition": "",
"date": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - competition required
string: 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. - date required
string: The date of the game(s).
- format required
Output
- output
array- items BoxScore
BoxScoresByDateDelta
Box Scores by Date Delta
fantasydata_soccer_v3_stats.BoxScoresByDateDelta({
"format": "",
"date": "",
"minutes": ""
}, 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). - minutes required
string: 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:
- format required
Output
- output
array- items BoxScore
BoxScoresDeltaByDateByCompetition
Box Scores Delta by Date by Competition
fantasydata_soccer_v3_stats.BoxScoresDeltaByDateByCompetition({
"format": "",
"competition": "",
"date": "",
"minutes": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - competition required
string: 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. - date required
string: The date of the game(s). - minutes required
string: 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:
- format required
Output
- output
array- items BoxScore
CompetitionFixturesLeagueDetails
Competition Fixtures (League Details)
fantasydata_soccer_v3_stats.CompetitionFixturesLeagueDetails({
"format": "",
"competition": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - competition required
string: 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.
- format required
Output
- output CompetitionDetail
CompetitionHierarchyLeagueHierarchy
Competition Hierarchy (League Hierarchy)
fantasydata_soccer_v3_stats.CompetitionHierarchyLeagueHierarchy({
"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 Area
CompetitionsLeagues
Competitions (Leagues)
fantasydata_soccer_v3_stats.CompetitionsLeagues({
"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 Competition
GamesByDate
Games by Date
fantasydata_soccer_v3_stats.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
MembershipsHistorical
Memberships (Historical)
fantasydata_soccer_v3_stats.MembershipsHistorical({
"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 Membership
MembershipsByTeamHistorical
Memberships by Team (Historical)
fantasydata_soccer_v3_stats.MembershipsByTeamHistorical({
"format": "",
"teamid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - teamid required
string: Unique FantasyData Team ID.
- format required
Output
- output
array- items Membership
MembershipsByTeamActive
Memberships by Team (Active)
fantasydata_soccer_v3_stats.MembershipsByTeamActive({
"format": "",
"teamid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - teamid required
string: Unique FantasyData Team ID.
- format required
Output
- output
array- items Membership
Player
Player
fantasydata_soccer_v3_stats.Player({
"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
PlayerGameStatsByDate
Player Game Stats by Date
fantasydata_soccer_v3_stats.PlayerGameStatsByDate({
"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 PlayerGame
PlayerGameStatsByPlayer
Player Game Stats by Player
fantasydata_soccer_v3_stats.PlayerGameStatsByPlayer({
"format": "",
"date": "",
"playerid": ""
}, 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). - playerid required
string: Unique FantasyData Player ID.
- format required
Output
- output
array- items PlayerGame
PlayerSeasonStats
Player Season Stats
fantasydata_soccer_v3_stats.PlayerSeasonStats({
"format": "",
"roundid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - roundid required
string: Unique FantasyData Round ID. RoundIDs can be found in the Competition Hierarchy (League Hierarchy).
- format required
Output
- output
array- items PlayerSeason
PlayerSeasonStatsByPlayer
Player Season Stats by Player
fantasydata_soccer_v3_stats.PlayerSeasonStatsByPlayer({
"format": "",
"roundid": "",
"playerid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - roundid required
string: Unique FantasyData Round ID. RoundIDs can be found in the Competition Hierarchy (League Hierarchy). - playerid required
string: Unique FantasyData Player ID.
- format required
Output
- output
array- items PlayerSeason
PlayerSeasonStatsByTeam
Player Season Stats by Team
fantasydata_soccer_v3_stats.PlayerSeasonStatsByTeam({
"format": "",
"roundid": "",
"team": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - roundid required
string: Unique FantasyData Round ID. RoundIDs can be found in the Competition Hierarchy (League Hierarchy). - team required
string: Unique FantasyData Team ID.
- format required
Output
- output
array- items PlayerSeason
Players
Players
fantasydata_soccer_v3_stats.Players({
"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
fantasydata_soccer_v3_stats.PlayersByTeam({
"format": "",
"teamid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - teamid required
string: Unique FantasyData Team ID.
- format required
Output
- output
array- items Player
Schedule
Schedule
fantasydata_soccer_v3_stats.Schedule({
"format": "",
"roundid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - roundid required
string: Unique FantasyData Round ID. RoundIDs can be found in the Competition Hierarchy (League Hierarchy).
- format required
Output
- output
array- items Game
SeasonTeams
Season Teams
fantasydata_soccer_v3_stats.SeasonTeams({
"format": "",
"seasonid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - seasonid required
string: Unique FantasyData Season ID. SeasonIDs can be found in the Competition Hierarchy (League Hierarchy).
- format required
Output
- output
array- items SeasonTeam
Standings
Standings
fantasydata_soccer_v3_stats.Standings({
"format": "",
"roundid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - roundid required
string: Unique FantasyData Round ID. RoundIDs can be found in the Competition Hierarchy (League Hierarchy).
- format required
Output
- output
array- items Standing
TeamGameStatsByDate
Team Game Stats by Date
fantasydata_soccer_v3_stats.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
fantasydata_soccer_v3_stats.TeamSeasonStats({
"format": "",
"roundid": ""
}, context)Input
- input
object- format required
string(values: xml, json): Desired response format. Valid entries are XML or JSON. - roundid required
string: Unique FantasyData Round ID. RoundIDs can be found in the Competition Hierarchy (League Hierarchy).
- format required
Output
- output
array- items TeamSeason
Teams
Teams
fantasydata_soccer_v3_stats.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
Venues
Venues
fantasydata_soccer_v3_stats.Venues({
"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 Venue
Definitions
Area
- Area
object- AreaId
integer - Competitions
array- items Competition
- CountryCode
string - Name
string
- AreaId
Booking
- Booking
object- BookingId
integer - GameId
integer - GameMinute
integer - GameMinuteExtra
integer - Name
string - PlayerId
integer - TeamId
integer - Type
string
- BookingId
BoxScore
- BoxScore
object- AdditionalAssistantReferee1 Referee
- AdditionalAssistantReferee2 Referee
- AssistantReferee1 Referee
- AssistantReferee2 Referee
- AwayTeamCoach Coach
- Bookings
array- items Booking
- FourthReferee Referee
- Game Game
- Goals
array- items Goal
- HomeTeamCoach Coach
- Lineups
array- items Lineup
- MainReferee Referee
- PenaltyShootouts
array- items PenaltyShootout
- PlayerGames
array- items PlayerGame
- TeamGames
array- items TeamGame
Coach
- Coach
object- CoachId
integer - FirstName
string - LastName
string - Nationality
string - ShortName
string
- CoachId
Competition
- Competition
object- AreaId
integer - AreaName
string - CompetitionId
integer - Format
string - Gender
string - Name
string - Seasons
array- items Season
- Type
string
- AreaId
CompetitionDetail
- CompetitionDetail
object- AreaId
integer - AreaName
string - CompetitionId
integer - CurrentSeason Season
- Format
string - Games
array- items Game
- Gender
string - Name
string - Seasons
array- items Season
- Teams
array- items TeamDetail
- Type
string
- AreaId
Game
- Game
object- Attendance
integer - AwayTeamCountryCode
string - AwayTeamId
integer - AwayTeamKey
string - AwayTeamMoneyLine
integer - AwayTeamName
string - AwayTeamPointSpreadPayout
integer - AwayTeamScore
integer - AwayTeamScoreExtraTime
integer - AwayTeamScorePenalty
integer - AwayTeamScorePeriod1
integer - AwayTeamScorePeriod2
integer - Clock
integer - DateTime
string - Day
string - DrawMoneyLine
integer - GameId
integer - GlobalAwayTeamId
integer - GlobalGameId
integer - GlobalHomeTeamId
integer - Group
string - HomeTeamCountryCode
string - HomeTeamId
integer - HomeTeamKey
string - HomeTeamMoneyLine
integer - HomeTeamName
string - HomeTeamPointSpreadPayout
integer - HomeTeamScore
integer - HomeTeamScoreExtraTime
integer - HomeTeamScorePenalty
integer - HomeTeamScorePeriod1
integer - HomeTeamScorePeriod2
integer - OverPayout
integer - OverUnder
number - Period
string - PointSpread
number - RoundId
integer - Season
integer - SeasonType
integer - Status
string - UnderPayout
integer - Updated
string - UpdatedUtc
string - VenueId
integer - VenueType
string - Week
integer - Winner
string
- Attendance
Goal
- Goal
object- AssistedByPlayerId1
integer - AssistedByPlayerId2
integer - AssistedByPlayerName1
string - AssistedByPlayerName2
string - GameId
integer - GameMinute
integer - GameMinuteExtra
integer - GoalId
integer - Name
string - PlayerId
integer - TeamId
integer - Type
string
- AssistedByPlayerId1
Lineup
- Lineup
object- GameId
integer - GameMinute
integer - GameMinuteExtra
integer - LineupId
integer - Name
string - PitchPositionHorizontal
integer - PitchPositionVertical
integer - PlayerId
integer - Position
string - ReplacedPlayerId
integer - ReplacedPlayerName
string - TeamId
integer - Type
string
- GameId
Membership
- Membership
object- Active
boolean - EndDate
string - MembershipId
integer - PlayerId
integer - PlayerName
string - StartDate
string - TeamArea
string - TeamId
integer - TeamName
string - Updated
string
- Active
PenaltyShootout
- PenaltyShootout
object- GameId
integer - Name
string - Order
integer - PenaltyShootoutId
integer - PlayerId
integer - Position
string - TeamId
integer - Type
string
- GameId
Player
- Player
object- BirthCity
string - BirthCountry
string - BirthDate
string - CommonName
string - DraftKingsPosition
string - FirstName
string - Foot
string - Gender
string - Height
integer - InjuryBodyPart
string - InjuryNotes
string - InjuryStartDate
string - InjuryStatus
string - Jersey
integer - LastName
string - Nationality
string - PhotoUrl
string - PlayerId
integer - Position
string - PositionCategory
string - RotoWirePlayerID
integer - ShortName
string - Updated
string - Weight
integer
- BirthCity
PlayerGame
- PlayerGame
object- Assists
number - BlockedShots
number - Captain
boolean - CornersWon
number - Crosses
number - DateTime
string - Day
string - DefenderCleanSheets
number - DraftKingsPosition
string - DraftKingsSalary
integer - FanDuelPosition
string - FanDuelSalary
integer - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsMondogoal
number - FantasyPointsYahoo
number - Fouled
number - Fouls
number - GameId
integer - Games
integer - GlobalGameId
integer - GlobalOpponentId
integer - GlobalTeamId
integer - GoalkeeperCleanSheets
number - GoalkeeperGoalsAgainst
number - GoalkeeperSaves
number - GoalkeeperSingleGoalAgainst
number - GoalkeeperWins
number - Goals
number - HomeOrAway
string - InjuryBodyPart
string - InjuryNotes
string - InjuryStartDate
string - InjuryStatus
string - Interceptions
number - IsGameOver
boolean - Jersey
integer - LastManTackle
number - Minutes
number - MondogoalPosition
string - MondogoalSalary
integer - Name
string - Offsides
number - Opponent
string - OpponentId
integer - OpponentScore
number - OwnGoals
number - Passes
number - PassesCompleted
number - PenaltiesConceded
number - PenaltiesWon
number - PenaltyKickGoals
number - PenaltyKickMisses
number - PenaltyKickSaves
number - PlayerId
integer - Position
string - PositionCategory
string - RedCards
number - RoundId
integer - Score
number - Season
integer - SeasonType
integer - ShortName
string - Shots
number - ShotsOnGoal
number - Started
integer - StatId
integer - Suspension
boolean - SuspensionReason
string - TacklesWon
number - Team
string - TeamId
integer - Touches
number - Updated
string - UpdatedUtc
string - YahooPosition
string - YahooSalary
integer - YellowCards
number - YellowRedCards
number
- Assists
PlayerSeason
- PlayerSeason
object- Assists
number - BlockedShots
number - CornersWon
number - Crosses
number - DefenderCleanSheets
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsMondogoal
number - FantasyPointsYahoo
number - Fouled
number - Fouls
number - Games
integer - GlobalTeamId
integer - GoalkeeperCleanSheets
number - GoalkeeperGoalsAgainst
number - GoalkeeperSaves
number - GoalkeeperSingleGoalAgainst
number - GoalkeeperWins
number - Goals
number - Interceptions
number - LastManTackle
number - Minutes
number - Name
string - Offsides
number - OpponentScore
number - OwnGoals
number - Passes
number - PassesCompleted
number - PenaltiesConceded
number - PenaltiesWon
number - PenaltyKickGoals
number - PenaltyKickMisses
number - PenaltyKickSaves
number - PlayerId
integer - Position
string - PositionCategory
string - RedCards
number - RoundId
integer - Score
number - Season
integer - SeasonType
integer - ShortName
string - Shots
number - ShotsOnGoal
number - Started
integer - StatId
integer - TacklesWon
number - Team
string - TeamId
integer - Touches
number - Updated
string - UpdatedUtc
string - YellowCards
number - YellowRedCards
number
- Assists
Referee
- Referee
object- FirstName
string - LastName
string - Nationality
string - RefereeId
integer - ShortName
string
- FirstName
Round
- Round
object- CurrentRound
boolean - CurrentWeek
integer - EndDate
string - Name
string - RoundId
integer - Season
integer - SeasonId
integer - SeasonType
integer - StartDate
string - Type
string
- CurrentRound
Season
- Season
object- CompetitionId
integer - CompetitionName
string - CurrentSeason
boolean - EndDate
string - Name
string - Rounds
array- items Round
- Season
integer - SeasonId
integer - StartDate
string
- CompetitionId
SeasonTeam
- SeasonTeam
object- Active
boolean - Gender
string - SeasonId
integer - SeasonTeamId
integer - Team Team
- TeamId
integer - TeamName
string - Type
string
- Active
Standing
- Standing
object- Draws
integer - Games
integer - GoalsAgainst
integer - GoalsDifferential
integer - GoalsScored
integer - Losses
integer - Name
string - Points
integer - RoundId
integer - Scope
string - ShortName
string - StandingId
integer - TeamId
integer - Wins
integer - Order
integer
- Draws
Team
- Team
object- Active
boolean - Address
string - AreaId
integer - AreaName
string - City
string - ClubColor1
string - ClubColor2
string - ClubColor3
string - Email
string - Fax
string - Founded
integer - FullName
string - Gender
string - GlobalTeamId
integer - Name
string - Nickname1
string - Nickname2
string - Nickname3
string - Phone
string - TeamId
integer - Type
string - VenueId
integer - VenueName
string - Website
string - WikipediaLogoUrl
string - WikipediaWordMarkUrl
string - Zip
string - Key
string
- Active
TeamDetail
- TeamDetail
object- Active
boolean - Address
string - AreaId
integer - AreaName
string - City
string - ClubColor1
string - ClubColor2
string - ClubColor3
string - Email
string - Fax
string - Founded
integer - FullName
string - Gender
string - GlobalTeamId
integer - Name
string - Nickname1
string - Nickname2
string - Nickname3
string - Phone
string - Players
array- items Player
- TeamId
integer - Type
string - VenueId
integer - VenueName
string - Website
string - WikipediaLogoUrl
string - WikipediaWordMarkUrl
string - Zip
string - Key
string
- Active
TeamGame
- TeamGame
object- Assists
number - BlockedShots
number - CornersWon
number - Crosses
number - DateTime
string - Day
string - DefenderCleanSheets
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsMondogoal
number - FantasyPointsYahoo
number - Fouled
number - Fouls
number - GameId
integer - Games
integer - GlobalGameId
integer - GlobalOpponentId
integer - GlobalTeamId
integer - GoalkeeperCleanSheets
number - GoalkeeperGoalsAgainst
number - GoalkeeperSaves
number - GoalkeeperSingleGoalAgainst
number - GoalkeeperWins
number - Goals
number - HomeOrAway
string - Interceptions
number - IsGameOver
boolean - LastManTackle
number - Minutes
number - Name
string - Offsides
number - Opponent
string - OpponentId
integer - OpponentScore
number - OwnGoals
number - Passes
number - PassesCompleted
number - PenaltiesConceded
number - PenaltiesWon
number - PenaltyKickGoals
number - PenaltyKickMisses
number - PenaltyKickSaves
number - RedCards
number - RoundId
integer - Score
number - Season
integer - SeasonType
integer - Shots
number - ShotsOnGoal
number - StatId
integer - TacklesWon
number - Team
string - TeamId
integer - Touches
number - Updated
string - UpdatedUtc
string - YellowCards
number - YellowRedCards
number
- Assists
TeamSeason
- TeamSeason
object- Assists
number - BlockedShots
number - CornersWon
number - Crosses
number - DefenderCleanSheets
number - FantasyPoints
number - FantasyPointsDraftKings
number - FantasyPointsFanDuel
number - FantasyPointsMondogoal
number - FantasyPointsYahoo
number - Fouled
number - Fouls
number - Games
integer - GlobalTeamId
integer - GoalkeeperCleanSheets
number - GoalkeeperGoalsAgainst
number - GoalkeeperSaves
number - GoalkeeperSingleGoalAgainst
number - GoalkeeperWins
number - Goals
number - Interceptions
number - LastManTackle
number - Minutes
number - Name
string - Offsides
number - OpponentScore
number - OwnGoals
number - Passes
number - PassesCompleted
number - PenaltiesConceded
number - PenaltiesWon
number - PenaltyKickGoals
number - PenaltyKickMisses
number - PenaltyKickSaves
number - RedCards
number - RoundId
integer - Score
number - Season
integer - SeasonType
integer - Shots
number - ShotsOnGoal
number - StatId
integer - TacklesWon
number - Team
string - TeamId
integer - Touches
number - Updated
string - UpdatedUtc
string - YellowCards
number - YellowRedCards
number
- Assists
Venue
- Venue
object- Address
string - Capacity
integer - City
string - Country
string - GeoLat
number - GeoLong
number - Name
string - Nickname1
string - Nickname2
string - Opened
integer - Surface
string - VenueId
integer - Zip
string - Open
boolean
- Address