Skip to content

mjniday/footy_data

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

FootyData

Installation

Add this line to your application's Gemfile:

gem 'footy_data'

And then execute:

bundle

Or install it yourself with:

gem install footy_data

Usage

This gem works with all of the endpoints documented at football-data.org. Register an API key and add the key by doing:

FootyData.api_key = "YOUR_KEY"

The Football-Data API has three main resources: Competition, Fixture, and Team, and these can be accessed via:

FootyData::Competition
FootyData::Fixture
FootyData::Team

Calling '.all' or '.find' on a class will return all items for that resource or allow you to locate a discrete record.

FootyData::Fixture.all

FootyData::Team.find(64)

Sub-resources are accessible by passing the resource ID along with the method

FootyData::Competition.table(426) # => 426 is the Competition ID for the English Premier League and .table returns the league table.

FootyData::Team.players(64)       # => A list of players for the team with ID = 64

These methods also take a second parameter for filters, which should be passed in via a hash. Full documentation for these filters can be found here: Football-Data#Filters.

FootyData::Team.search({:name => "liver"}) # => Search by team name

FootyData::Fixture.all({:timeFrame => "n2"}) # => All fixtures in the database taking place over the next two days

FootyData::Team.fixtures(64,{:timeFrame => "p30"}) # => All fixtures for this team that took place in the past 30 days.

About

API wrapper for Football-Data.org

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages