Football Butler
This gem enables API requests against multiple different football APIs, with direct requests or using normalized endpoint Class methods. Currently supported APis:
- football-data.org [current default api]
- apifootball.com
- api-football.com
To use the API you need an API token, get it for free @
- http://api.football-data.org/register
- https://apifootball.com/register
- https://dashboard.api-football.com/register
Depending on you Payment Plan / Subscription you can access international Competitions, Teams, Matches, Scores, Players, Odds, and Standings.
Also see the following Links:
www.football-butler.de (Offical Gem Homepage)
www.code-butler.de (More Projects & Solutions with Rails & Flutter)
Twitter/code_butler
Tiers
This Gem supports two ways of using the APIs:
- direct calls to the API with path & filters
- „comfort“ functions (one class for each endpoint with semantic methods)
Update May 2021 (v2.0.0): Multiple APIs are now supported and all endpoints for football-data.org are now implemented. See below for more info on usage.
Update April 10th 2021: The Tier packages of football-data.org have been adjusted – Standings are now part of TIER_ONE and also of the newest Gem Version 1.1.0
Installation
Add this line to your application’s Gemfile:
gem 'football-butler'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install football-butler
Configuration
The quickest way to start
Note: football-data.org (api_name: :football_data_org) ist set as the default API.
To use the API you need to configure the API token.
You can do this „on the fly“ or in your application configuration:
Initializer
Create your own initializer file config\initializers\football_butler.rb and add:
Football::Butler::Configuration.configure do |config|
config.api_token = "<YOUR_API_TOKEN_HERE>"
end
On the Fly
As a function (use this line first in the rails console if you dont use the above initilaizer!)
Football::Butler.Configure.reconfigure(
api_token: "<YOUR_API_TOKEN_HERE>"
)
Get you first data from the rails console
Get all matches of current Bundesliga season:
rails c
Football::Butler::Matches.by_competition(id: 2002)
Change the target API
See the available api names:
Football::Butler::Configuration::AVAILABLE_APIS
[:football_data_org, :apifootball_com, :api_football_com]
To set the target API:
Football::Butler::Configuration.configure do |config|
config.api_name = :api_football_com
config.api_token = "<YOUR_API_TOKEN_HERE>"
end
To change the target API:
Football::Butler.Configure.reconfigure(
api_name: :api_football_com
api_token: "<YOUR_API_TOKEN_HERE>"
)
Configure the Request Header
*Note: Since Versiob 2.1.0 it is now possible to overwrite the default HEADER name (key) of the API Token. So, in case you need to adjust to a different name (e.g. for RAPID API with api-football.com) you can do so!
Default Names:
case api_name
when :apifootball_com
# not used in header
nil
when :football_data_org
"X-Auth-Token"
when :api_football_com
"x-apisports-key"
end
To change the name of the Api Token Key:
Football::Butler.Configure.reconfigure(
header_token_name: 'x-rapidapi-key'
)
Also, you can add additional header keys and values:
Football::Butler.Configure.reconfigure(
header_token_name: 'x-rapidapi-key',
header_additional: { my_key: 'my_value" }
)
The advanced way to go (more options)
Available Configuration Values
| Name | Default Value | Data Type | Explanation |
|---|---|---|---|
| api_token | nil | String | Your API Token (required to set by you) |
| api_name | :football_data_org | String | must be one of: [:football_data_org, :apifootball_com, :api_football_com] |
| api_version | 2 | Integer | API Version |
| api_endpoint | Depends on api_name | String | URL String |
| header_token_name | Depends on api_name | String | e.g. X-Auth-Token |
| header_additional | {} | Hash | You can add additional header data |
| tier_plan | nil | String | TIER_ONE TIER_TWO TIER_THREE TIER_FOUR |
| wait_on_limit | false | Boolean | Uses ’sleep‘ to wait if request is limited |
The tier_plan is only used in Football::Butler::Competitions.all as a default filter. You can use „plan“ filter manually on Competition calls.
Example
Football::Butler::Configuration.configure do |config|
config.api_token = "<YOUR_API_TOKEN_HERE>"
config.api_version = 2
config.api_endpoint = "https://api.football-data.org/v2"
config.tier_plan = 'TIER_TWO'
config.wait_on_limit = true
end
or
Football::Butler.Configure.reconfigure(
api_token: "<YOUR_API_TOKEN_HERE>",
api_version = 2,
api_endpoint = "https://api.football-data.org/v2",
tier_plan = 'TIER_TWO',
wait_on_limit = true
)
Usage
Direct API Calls with path and filters
football_data_org
Example:
# Resources
# https://www.football-data.org/documentation/quickstart#available-resources
path = 'competitions/BL1/matches' # (or path = 'competitions/2002/matches')
# Filtering
# https://www.football-data.org/documentation/quickstart#filtering
filters = { matchday: 1 }
response = Football::Butler.get(path: path, filters: filters)
Will call
http://api.football-data.org/v2/competitions/BL1/matches?matchday=1
and return all matches of match day 1 of the german Bundesliga, current season:
response['count']
=> 9
response['filters']
=> {"matchday"=>"1"}
response['competition']
=> {"id"=>2002, "area"=>{"id"=>2088, "name"=>"Germany"}, "name"=>"Bundesliga", ... }
response['matches']
=> [{"id"=>303007, "season"=>{"id"=>599, "startDate"=>"2020-09-18", "endDate"=>"2021-05-15", "currentMatchday"=>27}, "utcDate"=>"2020-09-18T18:30:00Z", "status"=>"FINISHED", ...}]
If you performed a bad request, e.g. invalid api_token configured, you will get an error hash:
response['message']
=> "Your API token is invalid."
response['errorCode']
=> 400
apifootball_com
Example:
# Resources
# https://apifootball.com/documentation
path = 'action=get_events'
filters = { league_id: 149, from: '2021-05-16', to: '2021-05-16' }
response = Football::Butler.get(path: path, filters: filters)
Will call
https://apiv2.apifootball.com/?action=get_events&from=2021-05-16&to=2021-05-16&league_id=149&APIkey=<YOUR_API_TOKEN>
and return all matches of 2021-05-16 of the english Premiere League for the given time range:
response.parsed_response
=> [{"match_id"=>"497362", "country_id"=>"41", "country_name"=>"England", "league_id"=>"149", "league_name"=>"Championship", ....]
If you performed a bad request, e.g. invalid api_token configured, you will get an error hash:
response['message']
=> "No event found (please check your plan)!"
api_football_com
Example:
# Resources
# https://www.api-football.com/documentation-v3
path = 'fixtures'
filters = { league: 78, season: 2021 }
response = Football::Butler.get(path: path, filters: filters)
Will call
https://v3.football.api-sports.io/fixtures?season=2021&league=78
and return all matches of 2021-05-16 of the english Premiere League for the given time range:
response
=> HTTParty::Response
response.parsed_response
=> Hash with Meta Data and response key
response.parsed_response['response']
=> [{"fixture"=>{"id"=>719349,"referee"=>"M. Fritz","timezone"=>"UTC","date"=>"2021-08-13T18:30:00+00:00","timestamp"=>1628879400, ....]
Comfort Functions (Endpoint Classes)
Instead of using the direct API calls you can use endpoint classes with semantic methods to get results. This list may be expanded in future versions.
I tried to normalize endpoint classes (with aliases) and methods across different target APIs. If an endpoint class is not available (such as Predictions and Statistics in API :football_data_org) you will get an error message:
"The Endpoint 'Predictions' is not supported by this API: football_data_org"
If a method is not available for that target API, you will also get an error message:
"Method 'by_name' is not supported for the endpoint 'Countries' by this API: apifootball_com"
NOTE: I did not normalize the returned data-types yet as I wanted to keep straight with the target API. Let me know if you would like to have a Configuration option to return same data types for all returns and target APIs. Until then: use „result: :default“ where available and work with the normalized HTTParty Response Type.
football_data_org
Most methods return the result directly (e.g. :matches), but you can also get the complete HTTParty response (as shown above in the direct API call) by using the „result: :default“ option:
Directly returns an Array with all areas:
Football::Butler::Areas.all
=> [{"id"=>2000, "name"=>"Afghanistan", "countryCode"=>"AFG", "ensignUrl"=>nil, "parentAreaId"=>2014, "parentArea"=>"Asia"}, ... ]
Returns a Hash with full API response:
response = Football::Butler::Areas.all(result: :default)
=> response.keys
=> ["count", "filters", "areas"]
=> response['areas']
=> [{"id"=>2000, "name"=>"Afghanistan", "countryCode"=>"AFG", "ensignUrl"=>nil, "parentAreaId"=>2014, "parentArea"=>"Asia"}, ... ]
If you request a single Object (e.g. „by_id“) the Object is returned by football-data.org directly as a Hash (not in an Array)! Exception: Match.by_id returns Hash with Keys [„head2head“, „match“]
Note: You can also use „Countries“, as this is an alias Class from :apifootball_com.
apifootball_com
Most methods return the result directly (result: :parsed_response), but you can also get the complete HTTParty response (as shown above in the direct API call) by using the „result: :default“ option:
Directly returns an Array with all areas:
Football::Butler::Countries.all
=> [{"country_id"=>"41", "country_name"=>"England", "country_logo"=>"https://apiv2.apifootball.com/badges/logo_country/41_england.png"}, {"country_id"=>"46", "country_name"=>"France", "country_logo"=>"https://apiv2.apifootball.com/badges/logo_country/46_france.png"}]
Returns a full API response:
response = Football::Butler::Countries.all(result: :default)
=> response.parsed_response
=> [{"country_id"=>"41", "country_name"=>"England", "country_logo"=>"https://apiv2.apifootball.com/badges/logo_country/41_england.png"}, {"country_id"=>"46", "country_name"=>"France", "country_logo"=>"https://apiv2.apifootball.com/badges/logo_country/46_france.png"}]
=> response.code
=> 200
Note: You can also use „Areas“, as this is an alias Class from :football_data_org.
result: option explained
The default return type is defined by the way the target API works. You have the following options, if you want to adjust the behaviour of the returned object:
football_data_org
case result
when :default
response
when :parsed_response
response.parsed_response
else
response&.keys&.include?(result.to_s) ? response[result.to_s] : nil
end
api_football_com
case result
when :default
response
when :parsed_response
response.parsed_response
when :array_first
response&.keys&.include?('response') && response['response'].is_a?(Array) ?
response['response'].first : nil
else
response&.keys&.include?('response') ? response['response'] : nil
end
apifootball_com
case result
when :default
response
when :array_first
response.parsed_response.is_a?(Array) ? response.parsed_response.first : nil
else
response.parsed_response
end
Default from api_switch in some endpoints
case api_name
when :apifootball_com
:parsed_response
when :football_data_org
klass::PATH
when :api_football_com
:response
end
Overview of all available Endpoint Classes
| Class | football-data.org | apifootball.com | api-football.com |
|---|---|---|---|
| Areas | YES | YES alias from Countries | YES alias from Countries |
| Coachs | NO | NO | YES |
| Competitions | YES | YES | YES alias from Leagues |
| Countries | YES alias from Areas | YES | YES |
| Events | YES alias from Matches | YES | YES alias from Fixtures |
| Fixtures | YES alias from Matches | YES alias from Events | YES |
| HeadToHead | YES | YES | YES |
| Injuries | NO | NO | YES |
| Leagues | YES alias from Competitions | YES alias from Competitions | YES |
| Lineups | YES | YES | YES |
| Matches | YES | YES alias from Events | YES alias from Fixtures |
| Odds | YES | YES | YES |
| Players | YES | YES | YES |
| Predictions | NO | YES | YES |
| Scorers | YES | YES alias from TopScorers | YES alias from TopScorers |
| Sidelineds | NO | NO | YES |
| Standings | YES | YES | YES |
| Statistics | NO | YES | YES |
| Teams | YES | YES | YES |
| Timezones | NO | NO | YES |
| TopScorers | YES alias from Scorers | YES | YES |
| Transfers | NO | NO | YES |
| Trophies | NO | NO | YES |
| Venues | NO | NO | YES |
Areas
Football::Butler::Areas
alias: Football::Butler::Countries
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_id | id: Integer | – | HTTParty::Response (Hash) | N/A | N/A |
| all | – | result (Symbol) | Array | Array | Array |
| by_name | name: String | result (Symbol) filters (Hash) | HTTParty::Response (Hash) | N/A | Array |
| by_code | code: String | result (Symbol) filters (Hash) | HTTParty::Response (Hash) | N/A | Array |
| search_by_name | name: String | result (Symbol) filters (Hash) | N/A | N/A | Array |
Examples:
Football::Butler::Areas.by_id(id: 2088)
Football::Butler::Areas.by_name(name: 'Germany')
Football::Butler::Areas.all
Football::Butler::Areas.by_code(code: 'DE')
Football::Butler::Areas.search_by_name(name: 'Ger')
Coachs (added in version 2.1.0)
Football::Butler::Coachs
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_id | id: Integer season: Integer | result (Symbol) | N/A | N/A | Array |
| search_by_name | name: String | result (Symbol) | N/A | N/A | Array |
| by_team | team: Integer | result (Symbol) | N/A | N/A | Array |
Examples:
Football::Butler::Coachs.by_id(id: 1540)
Football::Butler::Coachs.search_by_name(name: 'Rose')
Football::Butler::Coachs.by_team(team: 165)
Competitions
Football::Butler::Competitions
alias: Football::Butler::Leagues
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_id | id: Integer | – | HTTParty::Response (Hash) | N/A | Array |
| by_country | id: Integer | – | N/A | Array | N/A |
| by_country_name | name: String | – | N/A | N/A | Array |
| all | – | result (Symbol) filters (Hash) | Array | Array | Array |
| by_plan | plan: String | result (Symbol) filters (Hash) | Array | N/A | N/A |
| by_areas | ids: Array | result (Symbol) filters (Hash) | Array | N/A | N/A |
| current_match_day | id: Integer | – | Integer | N/A | N/A |
| seasons | id: Integer | – | Array | N/A | N/A |
| all_seasons | – | – | N/A | N/A | Array |
| search_by_name | name: String | result (Symbol) filters (Hash) | N/A | N/A | Array |
| all_leagues | – | result (Symbol) filters (Hash) | N/A | N/A | Array |
| all_cups | – | result (Symbol) filters (Hash) | N/A | N/A | Array |
Examples:
Football::Butler::Competitions.by_id(id: 2002)
Football::Butler::Competitions.all(filters: { plan: 'TIER_ONE' })
Football::Butler::Competitions.by_plan(plan: 'TIER_ONE')
Football::Butler::Competitions.by_areas(ids: [2088, 2081])
Football::Butler::Competitions.current_match_day(id: 2002)
Football::Butler::Competitions.seasons(id: 2002)
Football::Butler::Competitions.all_season
Football::Butler::Competitions.by_country(id: 49)
Football::Butler::Competitions.by_country_name(name: 'Germany')
Football::Butler::Competitions.search_by_name(name: 'Ger')
Football::Butler::Competitions.all_leagues
Football::Butler::Competitions.all_cups
Countries
Football::Butler::Countries
NOTE: alias of/see Football::Butler::Areas
Events
Football::Butler::Events
**NOTE: alias of/see Football::Butler::Matches / Football::Butler::Fixtures **
HeadToHead (added in version 2.0.0)
Football::Butler::HeadToHead
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_match | id: Integer | – | Hash | N/A | N/A |
| by_teams | team_id: Integer second_team_id | result (Symbol) filters (Hash) | N/A | Hash | Array |
Examples:
Football::Butler::HeadToHead.by_match(id: 2002)
Football::Butler::HeadToHead.by_teams(team_id: 7275, second_team_id: 151)
Injuries (added in version 2.1.0)
Football::Butler::Injuries
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_competition_and_season | competition: Integer season: Integer | result (Symbol) | N/A | N/A | Array |
| by_team_and_season | team: Integer season: Integer | result (Symbol) | N/A | N/A | Array |
| by_match | match: Integer | result (Symbol) | N/A | N/A | Array |
Examples:
Football::Butler::Injuries.by_competition_and_season(competition: 78, season: 2021)
Football::Butler::Injuries.by_team_and_season(team: 78, season: 2021)
Football::Butler::Injuries.by_match(match: 719364)
Lineups (added in version 2.0.0)
Football::Butler::Lineups
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_match | id: Integer | – | Hash | Hash | Array |
Examples:
Football::Butler::Lineups.by_match(id: 2002)
Matches
Football::Butler::Matches
*alias: * Football::Butler::Events, Football::Butler::Fixtures
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_id | id: Integer | – | HTTParty::Response (Hash) | Array | Array |
| all | – | result (Symbol) filters (Hash) | Array | Array | N/A |
| by_competition_and_year | id: Integer year: Integer | result (Symbol) filters (Hash) | Array | Array | Array |
| by_competition_and_match_day | id: Integer match_day: Integer | result (Symbol) filters (Hash) | Array | N/A | N/A |
| by_team | id: Integer | result (Symbol) filters (Hash) | Array | Array | N/A |
| by_team_and_status | id: Integer status: String | result (Symbol) filters (Hash) | Array | N/A | N/A |
| by_team_finished | id: Integer | result (Symbol) filters (Hash) | Array | N/A | N/A |
| by_team_scheduled | id: Integer | result (Symbol) filters (Hash) | Array | N/A | N/A |
| by_player | id: Integer | result (Symbol) filters (Hash) | Array | N/A | N/A |
Examples:
Football::Butler::Matches.by_id(id: 297886)
Football::Butler::Matches.all
Football::Butler::Matches.by_competition_and_year(id: 2002, year: 2019)
Football::Butler::Matches.by_competition_and_match_day(id: 297886, match_day: 1)
Football::Butler::Matches.by_team(id: 18)
Football::Butler::Matches.by_team_and_status(id: 18, status: 'FINISHED')
Football::Butler::Matches.by_team_finished(id: 18)
Football::Butler::Matches.by_team_scheduled(id: 18)
Football::Butler::Matches.by_player(id: 18)
Odds (added in version 2.0.0)
Football::Butler::Odds
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_match | id: Integer from: Date as String (‚2021-05-17‘) to: Date as String (‚2021-05-17‘) (from and to only used (required) in apifootbal.com) | – | Hash | Hash | Array |
Examples:
Football::Butler::Odds.by_match(id: 2002)
Players (added in version 2.0.0)
Football::Butler::Players
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_id | id: Integer | – | Hash | Hash | N/A |
| by_name | name: String | result (Symbol) | N/A | Hash | N/A |
| by_id_and_season | id: Integer season: Integer | result (Symbol) filters (Hash) | N/A | N/A | Array |
Examples:
Football::Butler::Players.by_id(id: 2002)
Football::Butler::Players.by_name(name: 'Ronaldo')
Football::Butler::Players.by_id_and_season(id: 7190, season: 2020)
Predictions (added in version 2.0.0)
Football::Butler::Predictions
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_match | id: Integer | result (Symbol) filters (Hash) | N/A | Hash | Array |
Examples:
Football::Butler::Predictions.by_match(id: 2002)
Scorers (added in version 2.0.0)
Football::Butler::Scorers
alias: Football::Butler::TopScorers
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_competition | id: Integer | result (Symbol) filters (Hash) | Array | Hash | N/A |
| by_competition_and_year | id: Integer year: Integer | result (Symbol) filters (Hash) | N/A | N/A | Array |
Examples:
Football::Butler::Scorers.by_competition(id: 2002)
Football::Butler::Scorers.by_competition_and_year(id: 2002, year: 2002)
Sidelineds (added in version 2.1.0)
Football::Butler::Sidelineds
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_player | id: Integer | result (Symbol) | N/A | N/A | Array |
| by_coach | coach: Integer | result (Symbol) | N/A | N/A | Array |
Examples:
Football::Butler::Sidelineds.by_player(player 1540)
Football::Butler::Sidelineds.by_coach(coach: 154)
Standings (added in version 1.1.0)
Football::Butler::Standings
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_competition | id: Integer | result (Symbol) filters (Hash) | Array | Array | N/A |
| home_by_competition | id: Integer | result (Symbol) filters (Hash) | Array | N/A | N/A |
| away_by_competition | id: Integer | result (Symbol) filters (Hash) | Array | N/A | N/A |
| by_competition_and_year | id: Integer year: Integer | result (Symbol) filters (Hash) | Array | N/A | Array |
Football::Butler::Standings.by_competition(id: 2002)
Football::Butler::Standings.home_by_competition(id: 2002)
Football::Butler::Standings.away_by_competition(id: 2002)
Football::Butler::Standings.by_competition_and_year(id: 2002, year: 2020)
Statistics (added in version 2.0.0)
Football::Butler::Statistics
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_match | id: Integer | result (Symbol) | N/A | Hash | Array |
Examples:
Football::Butler::Statistics.by_match(id: 2002)
Teams
Football::Butler::Teams
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_id | id: Integer | – | HTTParty::Response (Hash) | Array | Array |
| by_competition | id: Integer | result (Symbol) filters (Hash) | Array | Array | N/A |
| by_competition_and_year | id: Integer year: Integer | result (Symbol) filters (Hash) | Array | N/A | Array |
| by_name | name: String | – | N/A | N/A | Array |
| by_country_name | name: String | – | N/A | N/A | Array |
Examples:
Football::Butler::Teams.by_id(id: 2002)
Football::Butler::Teams.by_competition(id: 2002)
Football::Butler::Teams.by_competition_and_year(id: 2002, year: 2019)
Football::Butler::Teams.by_name(name: 'Wolves')
Football::Butler::Teams.by_country_name(name: 'Germany')
Timezones (added in version 2.1.0)
Football::Butler::Timezones
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| all | – | result (Symbol) | N/A | N/A | Array |
Examples:
Football::Butler::Timezones.all
TopScorers
Football::Butler::TopScorers
NOTE: alias of/see Football::Butler::Scorers
Transfers (added in version 2.1.0)
Football::Butler::Transfers
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_player | id: Integer | result (Symbol) | N/A | N/A | Array |
| by_team | team: Integer | result (Symbol) | N/A | N/A | Array |
Examples:
Football::Butler::Transfers.by_player(player 1540)
Football::Butler::Transfers.by_team(team: 154)
Trophies (added in version 2.1.0)
Football::Butler::Trophies
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_player | id: Integer | result (Symbol) | N/A | N/A | Array |
| by_coach | coach: Integer | result (Symbol) | N/A | N/A | Array |
Examples:
Football::Butler::Trophies.by_player(player 1540)
Football::Butler::Trophies.by_coach(coach: 154)
Venues (added in version 2.1.0)
Football::Butler::Venues
Return Values if the result option is not set explicitly!
| Method | Params required | Params optional | football-data | apifootball | api-football |
|---|---|---|---|---|---|
| by_city | city: String | result (Symbol) filters (Hash) | N/A | N/A | Array |
| by_name | name: String | result (Symbol) filters (Hash) | N/A | N/A | Array |
| by_country | country: String | result (Symbol) filters (Hash) | N/A | N/A | Array |
| by_id | id: Integer | result (Symbol) filters (Hash) | N/A | N/A | Array |
| search | search: String | result (Symbol) filters (Hash) | N/A | N/A | Array |
Examples:
Football::Butler::Venues.by_city(city: 'Hamburg')
Football::Butler::Venues.by_name(name: 'Millerntor')
Football::Butler::Venues.by_country(country: 'Germany')
Football::Butler::Venues.by_id(id: 745)
Football::Butler::Venues.search(search: 'Millern')
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/frontimax/football-butler. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.
License
The gem is available as open source under the terms of the MIT License.
Code of Conduct
Everyone interacting in the Football Butler project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.