espn_pub is a lightweight Ruby client for the public ESPN API. It provides a simple interface for fetching league teams, team rosters, players, and game scoreboards.
- Fetch NBA and NFL teams
- Retrieve team rosters and player metadata
- Query league scoreboards for a specific date
- Wraps ESPN public API endpoints with Ruby objects
Add this line to your application's Gemfile:
gem 'espn_pub'Then run:
bundle installOr install directly with:
gem install espn_pub- Ruby
>= 3.3.0
Require the gem and instantiate entities directly:
require 'espn_pub'
league = EspnPub::Entities::League.new(EspnPub::Entities::League::NAME::NBA)teams = league.teams
puts teams.map(&:name)team = teams.first
players = team.players
players.each do |player|
puts "#{player.full_name} (#{player.position})"
endrequire 'date'
games = league.games(date: Date.today)
games.each do |game|
puts "Game ID: #{game.id} | Home: #{game.home_team_id} | Away: #{game.away_team_id} | Date: #{game.date}"
endclient = EspnPub::Client.new(
base_uri: EspnPub::Client::BASE_URI,
version: EspnPub::Client::API_VERSION
)
response = client.send_request('/apis/site/v2/sports/basketball/nba/teams')
puts response['sports'][0]['leagues'][0]['teams'].map { |team| team.dig('team', 'name') }The client raises EspnPub::Client::UnexpectedResponseCodeError when the API response status is not 200.
begin
client.send_request('/invalid/path')
rescue EspnPub::Client::UnexpectedResponseCodeError => e
warn "API request failed: #{e.message}"
endClone the repository and install development dependencies:
git clone https://github.com/bowmanje/espn-pub-rb.git
cd espn-pub-rb
bundle installRun the test suite with:
bundle exec rspecespn_pub is licensed under the MIT License.
