class Football::Butler::ApiFootball::Leagues

Constants

PATH

Public Class Methods

all(result:, filters:) click to toggle source
LEAGUES

www.api-football.com/documentation-v3#operation/get-leagues

id integer The id of the league

name string The name of the league

country string The country name of the league

code string 2 characters FR, GB, IT… The Alpha2 code of the country

season integer 4 characters YYYY The season of the league

team integer The id of the team

type string Enum: “league” “cup” The type of the league

current string Enum: “true” “false” The state of the league

search string >= 3 characters The name or the country of the league

last integer <= 2 characters

/leagues

# File lib/football/butler/api_football/leagues.rb, line 75
def all(result:, filters:)
  Api.get(path: PATH, result: result, filters: filters)
end
all_cups(result:, filters:) click to toggle source

/leagues?type=cup

# File lib/football/butler/api_football/leagues.rb, line 92
def all_cups(result:, filters:)
  filters.merge!({ type: 'cup' })
  Api.get(path: PATH, result: result, filters: filters)
end
all_leagues(result:, filters:) click to toggle source

/leagues?type=league

# File lib/football/butler/api_football/leagues.rb, line 86
def all_leagues(result:, filters:)
  filters.merge!({ type: 'league' })
  Api.get(path: PATH, result: result, filters: filters)
end
all_seasons(result:) click to toggle source

/leagues/seasons

# File lib/football/butler/api_football/leagues.rb, line 25
def all_seasons(result:)
  path = "#{PATH}/seasons"
  Api.get(path: path, result: result)
end
by_country_name(name:, result:) click to toggle source

/leagues?country={country}

# File lib/football/butler/api_football/leagues.rb, line 19
def by_country_name(name:, result:)
  filters = { country: name }
  Api.get(path: PATH, filters: filters, result: result)
end
by_id(id:) click to toggle source
LEAGUE

/leagues?id={id}

# File lib/football/butler/api_football/leagues.rb, line 13
def by_id(id:)
  filters = { id: id }
  Api.get(path: PATH, filters: filters, result: :response)
end
search_by_name(name:, filters:, result:) click to toggle source

/leagues?search={name}

# File lib/football/butler/api_football/leagues.rb, line 80
def search_by_name(name:, filters:, result:)
  filters.merge!({ search: name })
  Api.get(path: PATH, filters: filters, result: result)
end