Skip to content

chrismaltais/chess-pub-api-client

Repository files navigation


Unofficial Ruby client for the Chess.com Published Data API

Overview

HitCount

chess-pub-api-client is an unofficial Ruby client for the Chess.com Published Data REST API. It's built with zero non-development dependencies to ensure your application remains lightweight.

Installation

Add this line to your application's Gemfile:

gem 'chess-pub-api-client'

And then execute:

$ bundle

Or install it yourself as:

$ gem install chess-pub-api-client

Usage

Using the client is easy:

require 'chess-pub-api-client'

# Check if a player is online
ChessPubApiClient.get_player_online_status("steezymalteezy") # Returns a hash of the parsed JSON result

# Get a player's current Daily Chess games where it's their turn to move
ChessPubApiClient.get_player_current_games_to_move("steezymalteezy") # Returns a hash of the parsed JSON result

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chrismaltais/chess-pub-api-client.

License

The gem is available as open source under the terms of the MIT License.

About

Unofficial wrapper of the Chess.com Published Data API in Ruby 💎

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published