{"id":21431038,"url":"https://github.com/radkomih/football_api","last_synced_at":"2025-07-14T11:31:46.671Z","repository":{"id":172943878,"uuid":"284252398","full_name":"radkomih/football_api","owner":"radkomih","description":"A Ruby interface to the https://www.api-football.com.","archived":false,"fork":false,"pushed_at":"2023-07-24T00:56:46.000Z","size":39,"stargazers_count":4,"open_issues_count":3,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T07:38:40.231Z","etag":null,"topics":["analytics","api","api-client","api-football","api-wrapper","football","football-data","rails","ruby","sports-api","sports-data","sports-stats","worldcup"],"latest_commit_sha":null,"homepage":"https://www.api-football.com","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/radkomih.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-08-01T12:07:26.000Z","updated_at":"2024-06-30T15:21:36.000Z","dependencies_parsed_at":null,"dependency_job_id":"47b8dea2-2898-4f06-8864-32ca5a92ef26","html_url":"https://github.com/radkomih/football_api","commit_stats":null,"previous_names":["radkomih/football_api"],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/radkomih/football_api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radkomih%2Ffootball_api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radkomih%2Ffootball_api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radkomih%2Ffootball_api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radkomih%2Ffootball_api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/radkomih","download_url":"https://codeload.github.com/radkomih/football_api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/radkomih%2Ffootball_api/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265285440,"owners_count":23740525,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","api","api-client","api-football","api-wrapper","football","football-data","rails","ruby","sports-api","sports-data","sports-stats","worldcup"],"created_at":"2024-11-22T22:29:28.238Z","updated_at":"2025-07-14T11:31:46.664Z","avatar_url":"https://github.com/radkomih.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# FootballApi\n\nA Ruby interface to the [www.api-football.com](https://www.api-football.com) API v2.3.9 (current).\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n`gem 'football_api'`\n\nAnd then execute:\n\n`$ bundle install`\n\nOr install it yourself as:\n\n`$ gem install football_api`\n\n## Configuration\n\n```\nFootballApi.configure do |config|\n  config.api_host = 'https://www.api-football.com/demo/v2'\n  config.api_key = 'XXXXXXXXXXXXXXXXXXXXXXXXX'\nend\n```\n\n## Usage\n[Status](https://www.api-football.com/documentation#status-requests)\n\nThis endpoint does not require any parameters\n\n`FootballApi::Status.info`\n\n___\n\n[Timezones](https://www.api-football.com/documentation#timezone-requests)\n\nThis endpoint does not require any parameters\n\n`FootballApi::Timezone.all`\n\n___\n\n[Seasons](https://www.api-football.com/documentation#seasons-requests)\n\nThis endpoint does not require any parameters\n\n`FootballApi::Season.all`\n\n___\n\n[Contries](https://www.api-football.com/documentation#countries-requests)\n\nThis endpoint does not require any parameters\n\n`FootballApi::Country.all`\n\n___\n\n[Leagues](https://www.api-football.com/documentation#leagues-requests)\n\n|Parameter | Type | Required | Description|\n|----------|------|----------|------------|\n|league_id | integer | false | Fails if field contains anything other than an integer|\n|team_id | integer | false | Fails if field contains anything other than an integer|\n|search | string | false | 3 characters minimum | Fails if field has anything other than alphabetic characters|\n|country | string | false | Fails if field contains anything other than alpha-numeric characters, underscores or dashes|\n|code | string | false | 2 characters | Fails if field has anything other than alphabetic characters | Ex : FR, GB, IT…|\n|season | integer | false | Fails if field contains anything other than an integer [YYYY]|\n|current | string | false | Fails if field has anything other than alphabetic characters|\n|type | string | false | Fails if field has anything other than alphabetic characters|\n\n```\nFootballApi::League.find\nFootballApi::League.all\nFootballApi::League.all_by_team\nFootballApi::League.all_by_team_and_season\nFootballApi::League.search\nFootballApi::League.all_by_country\nFootballApi::League.all_by_country_and_season\nFootballApi::League.all_by_code\nFootballApi::League.all_by_code_and_season\nFootballApi::League.all_by_season\nFootballApi::League.all_seasons_by_league\nFootballApi::League.all_by_league_and_season\nFootballApi::League.all_current\nFootballApi::League.all_current_by_country\nFootballApi::League.all_by_type\nFootballApi::League.all_by_type_and_country\nFootballApi::League.all_by_type_and_country_and_season\nFootballApi::League.all_by_type_and_season\n```\n\n___\n\n\n[Teams](https://www.api-football.com/documentation#teams-data-requests)\n\n| Parameter | Type | Required | Description |\n|-----------|------|----------|-------------|\n|team_id | integer false | Fails if field contains anything other than an integer|\n|league_id | integer | false | Fails if field contains anything other than an integer|\n|search | string | false | 3 characters minimum | Fails if field has anything other than alphabetic characters|\n\n\n```\nFootballApi::Teams::Data.find\nFootballApi::Teams::Data.all_by_league\nFootballApi::Teams::Data.search\n```\n\n___\n\n\n[Team Statistics](https://www.api-football.com/documentation#teams-statistics-requests)\n\n| Parameter | Type | Required | Description |\n|----------|-------|----------|-------------|\n| league_id | integer | true | Fails if field contains anything other than an integer |\n| team_id | integer | true | Fails if field contains anything other than an integer |\n| date | string | false | Fails if field does not contain a valid date : [YYYY-MM-DD] |\n\n\n```\nFootballApi::Teams::Statistic.all_by_league_and_team\nFootballApi::Teams::Statistic.all_by_league_and_team_and_date\n```\n\n___\n\n\n[Standings](https://www.api-football.com/documentation#standings-requests)\n\n| Parameter | Type    | Required | Description |\n|-----------|---------|----------|-------------|\n| league_id | integer | true | Fails if field contains anything other than an integer |\n\n\n```\nFootballApi::Standing.all_by_league\n```\n\n___\n\n\n[Rounds](https://www.api-football.com/documentation#fixtures-rounds-requests)\n\n```\nFootballApi::Fixtures::Round.all_by_league\nFootballApi::Fixtures::Round.all_by_league_and_current\n```\n\n___\n\n\n[Fixtures](https://www.api-football.com/documentation#fixtures-fixtures-requests)\n\n```\nFootballApi::Fixtures::Fixture.find\nFootballApi::Fixtures::Fixture.all_live\nFootballApi::Fixtures::Fixture.all_live_and_several_leagues\nFootballApi::Fixtures::Fixture.all_by_date\nFootballApi::Fixtures::Fixture.all_by_league\nFootballApi::Fixtures::Fixture.all_by_league_and_date\nFootballApi::Fixtures::Fixture.all_by_league_and_round\nFootballApi::Fixtures::Fixture.next_n_by_league\nFootballApi::Fixtures::Fixture.last_n_by_league\n```\n\n___\n\n[H2h](https://www.api-football.com/documentation#fixtures-h2h-requests)\n\n```\nFootballApi::Fixtures::H2h.all_by_team\n```\n\n___\n\n[Fixture Statistics](https://www.api-football.com/documentation#fixtures-statistics-requests)\n\n```\nFootballApi::Fixtures::Statistic.all_by_fixture\n```\n\n___\n\n[Fixtures Events](https://www.api-football.com/documentation#fixtures-events-requests)\n\n```\nFootballApi::Fixtures::Event.all_by_fixture\n```\n\n___\n\n[Fixtures Lineups](https://www.api-football.com/documentation#fixtures-lineups-requests)\n\n```\nFootballApi::Fixtures::Lineup.all_by_fixture\n```\n\n___\n\n[Predictions](https://www.api-football.com/documentation#predictions-requests)\n\n|Parameter  | Type | Required | Description|\n|-----------|------|----------|------------|\n|fixture_id | integer | true | Fails if field contains anything other than an integer|\n\n```\nFootballApi::Prediction.all_by_fixture\n```\n\n___\n\n\n[Coachs](https://www.api-football.com/documentation#coachs-requests)\n\n|Parameter | Type | Required | Description|\n|----------|------|----------|------------|\n|coach_id | integer | false | Fails if field contains anything other than an integer|\n|team_id | integer  | false | Fails if field contains anything other than an integer|\n|search | string | false | 3 characters minimum | Fails if field has anything other than alphabetic characters|\n\n\n```\nFootballApi::Coach.find\nFootballApi::Coach.all_by_team\nFootballApi::Coach.search\n```\n\n___\n\n\n[Players Seasons](https://www.api-football.com/documentation#players-seasons-requests)\n\n```\nFootballApi::Players::Season.all\n```\n\n___\n\n\n[Players Top Scorers](https://www.api-football.com/documentation#players-top-scorers-requests)\n\n```\nFootballApi::Players::TopScorer.all_by_league\n```\n\n___\n\n\n[Players Search](https://www.api-football.com/documentation#players-search-requests)\n\n```\nFootballApi::Players::Search.all_by_name\n```\n\n___\n\n\n[Players Squad](https://www.api-football.com/documentation#players-squad-requests)\n\n```\nFootballApi::Players::Squad.all_by_team_and_season\n```\n\n___\n\n\n[Players Statistics Seasons](https://www.api-football.com/documentation#players-statistics-seasons-requests)\n\n```\nFootballApi::Players::StatisticsSeason.all_by_player\nFootballApi::Players::StatisticsSeason.all_by_player_and_season\nFootballApi::Players::StatisticsSeason.all_by_team_and_season\n```\n\n___\n\n\n[Players Statistics Fixtures](https://www.api-football.com/documentation#players-statistics-fixtures-requests)\n\n```\nFootballApi::Players::StatisticsFixture.by_fixture\n```\n\n___\n\n\n[Transfers](https://www.api-football.com/documentation#transfers-requests)\n\n|Parameter | Type | Required | Description|\n|----------|------|----------|------------|\n|player | integer |  false  | Fails if field contains anything other than an integer|\n|team | integer | false | Fails if field contains anything other than an integer|\n\n```\nFootballApi::Transfer.all_by_player\nFootballApi::Transfer.all_by_team\n```\n\n___\n\n\n[Trophies](https://www.api-football.com/documentation#trophies-requests)\n\n|Parameter | Type | Required | Description|\n|----------|------|----------|------------|\n|player | integer | true | Fails if field contains anything other than an integer|\n|coach | integer | true | Fails if field contains anything other than an integer|\n\n```\nFootballApi::Trophey.all_by_player\nFootballApi::Trophey.all_by_coach\n```\n\n___\n\n\n[Sidelined](https://www.api-football.com/documentation#sidelined-requests)\n\n```\nFootballApi::Sideline.all_by_player\nFootballApi::Sideline.all_by_coach\n```\n\n___\n\n\n[Odds Bookmakers](https://www.api-football.com/documentation#odds-bookmakers-requests)\n\n```\nFootballApi::Odds::Bookmaker.all\nFootballApi::Odds::Bookmaker.find\n```\n\n___\n\n\n[Odds Labels](https://www.api-football.com/documentation#odds-labels-requests)\n\n```\nFootballApi::Odds::Label.all\nFootballApi::Odds::Label.find\n```\n\n___\n\n\n[Odds Mapping](https://www.api-football.com/documentation#odds-mapping-requests)\n\n```\nFootballApi::Odds::Mapping.all\n```\n\n___\n\n\n[Odds](https://www.api-football.com/documentation#odds-odds-requests)\n\n\n|Parameter | Type | Required | Description|\n|----------|------|----------|------------|\n|fixture_id | integer | false | Fails if field contains anything other than an integer|\n|league_id | integer | false | Fails if field contains anything other than an integer|\n|date | string | false | Fails if field does not contain a valid date : [YYYY-MM-DD]|\n|page | integer | false | Fails if field contains anything other than an integer|\n|bookmaker_id | integer | false | Fails if field contains anything other than an integer|\n|label_id | integer | false | Fails if field contains anything other than an integer|\n|timezone | string | false | Fails if field is not a result of the endpoint timezone|\n\n\n```\nFootballApi::Odds::Odd.all_by_fixture\nFootballApi::Odds::Odd.all_by_date\nFootballApi::Odds::Odd.all_by_date_and_bookmaker\nFootballApi::Odds::Odd.all_by_fixture_and_bookmaker\nFootballApi::Odds::Odd.all_by_fixture_and_label\nFootballApi::Odds::Odd.all_by_league\nFootballApi::Odds::Odd.all_by_league_and_bookmaker\nFootballApi::Odds::Odd.all_by_league_and_label\n```\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).\n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/radkomih/football_api.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradkomih%2Ffootball_api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fradkomih%2Ffootball_api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fradkomih%2Ffootball_api/lists"}