Module: Fantasydata::API::BoxScore

Includes:
Utils
Included in:
Client
Defined in:
lib/fantasydata/api/box_score.rb

Constant Summary

Constants included from Utils

Utils::API_KEY_CANNOT_CALL_THIS_METHOD, Utils::INVALID_PARAMETER, Utils::MISSING_OR_INVALID_KEY, Utils::MISSING_PARAMETER, Utils::RATE_LIMIT_EXCEEDED, Utils::SUCCESS

Instance Method Summary collapse

Instance Method Details

#box_score_individual_game(season, week, hometeam) ⇒ Fantasydata::BoxScore

This method returns individual box scores for a given season, week and home team.

Examples:

box_score_individual_game

Fantasydata.box_score_individual_game('2015REG', 15, 'MIN')

Parameters:

  • season (String) —

    Year of the season and the season type. If no season type is provided, then the default is regular season Examples: 2015REG, 2015PRE, 2015POST, 2015

  • week (Integer) —

    Week of the season. Valid values are as follows: Preseason 0 to 4, Regular Season 1 to 17, Postseason 1 to 4

  • hometeam (String) —

    Abbreviation of the home team. Example: WAS

Returns:

  • (Fantasydata::BoxScore)

Raises:

See Also:



20
21
 
# File 'lib/fantasydata/api/box_score.rb', line 20

def box_score_individual_game(season, week, hometeam)
end

#box_scores_active ⇒ Array<Fantasydata::BoxScore>

This method returns box scores for all games that are either in-progress or have been updated within the last 30 minutes.

Examples:

box_scores_active

Fantasydata.box_scores_active

Returns:

  • (Array<Fantasydata::BoxScore>)

Raises:

See Also:



47
48
 
# File 'lib/fantasydata/api/box_score.rb', line 47

def box_scores_active
end

#box_scores_delta(season, week, minutes) ⇒ Array<Fantasydata::BoxScore>

This method returns all box scores for a given season and week, but only returns player stats that have changed in the last X minutes.

Examples:

box_scores_delta

Fantasydata.box_scores_delta('2014REG', 1, 5)

Parameters:

  • season (String) —

    Year of the season and the season type. If no season type is provided, then the default is regular season Examples: 2015REG, 2015PRE, 2015POST, 2015

  • week (Integer) —

    Week of the season. Valid values are as follows: Preseason 0 to 4, Regular Season 1 to 17, Postseason 1 to 4

  • minutes (Integer) —

    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 or 2 (etc.)

Returns:

  • (Array<Fantasydata::BoxScore>)

Raises:

See Also:



62
63
 
# File 'lib/fantasydata/api/box_score.rb', line 62

def box_scores_delta(season, week, minutes)
end

#box_scores_delta_current_week(minutes) ⇒ Array<Fantasydata::BoxScore>

This method returns all box scores for the current week, but only returns player stats that have changed in the last X minutes.

Examples:

box_scores_delta_current_week

Fantasydata.box_scores_delta_current_week(5)

Parameters:

  • minutes (Integer) —

    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 or 2 (etc.)

Returns:

  • (Array<Fantasydata::BoxScore>)

Raises:

See Also:



75
76
 
# File 'lib/fantasydata/api/box_score.rb', line 75

def box_scores_delta_current_week(minutes)
end

#box_scores_final ⇒ Array<Fantasydata::BoxScore>

Examples:

box_scores_final

Fantasydata.box_scores_final

Returns:

  • (Array<Fantasydata::BoxScore>)

Raises:

See Also:



87
88
 
# File 'lib/fantasydata/api/box_score.rb', line 87

def box_scores_final
end

#box_scores_live ⇒ Array<Fantasydata::BoxScore>

Examples:

box_scores_live

Fantasydata.box_scores_live

Returns:

  • (Array<Fantasydata::BoxScore>)

Raises:

See Also:



99
100
 
# File 'lib/fantasydata/api/box_score.rb', line 99

def box_scores_live
end

#box_scores_week(season, week) ⇒ Array<Fantasydata::BoxScore>

This method returns all box scores for a given season and week.

Examples:

box_scores_week

Fantasydata.box_scores_week('2015REG', 15)

Parameters:

  • season (String) —

    Year of the season and the season type. If no season type is provided, then the default is regular season Examples: 2015REG, 2015PRE, 2015POST, 2015

  • week (Integer) —

    Week of the season. Valid values are as follows: Preseason 0 to 4, Regular Season 1 to 17, Postseason 1 to 4

Returns:

  • (Array<Fantasydata::BoxScore>)

Raises:

See Also:



35
36
 
# File 'lib/fantasydata/api/box_score.rb', line 35

def box_scores_week(season, week)
end