Skip to content

agoblet/chesscompubapi

Repository files navigation

Go Reference codecov Go Report Card License

♟️ chesscompubapi

Go client for the chess.com Published-Data API (PubAPI). This package depends on the standard library only. It uses

Installation

$ go get -u github.com/agoblet/chesscompubapi

Quick Start

c := chesscompubapi.NewClient()
profile, err := c.GetPlayerProfile("hikaru")

Endpoint Implementation Status

  • ✅ /club/{url-ID}
  • ✅ /club/{url-ID}/matches
  • ✅ /club/{url-ID}/members
  • ✅ /country/{iso}
  • ✅ /country/{iso}/clubs
  • ✅ /country/{iso}/players
  • ✅ /leaderboards
  • ✅ /player/{username}
  • ✅ /player/{username}/clubs
  • ✅ /player/{username}/games/archives
  • ✅ /player/{username}/games/to-move
  • ✅ /player/{username}/games/{YYYY}/{MM}
  • ✅ /player/{username}/games/{YYYY}/{MM}/pgn
  • ✅ /player/{username}/stats
  • ✅ /puzzle
  • ✅ /puzzle/random
  • ✅ /streamers
  • ✅ /titled/{title-abbrev}
  • ❌ /match/{ID}
  • ❌ /match/{ID}/{board}
  • ❌ /match/live/{ID}
  • ❌ /match/live/{ID}/{board}
  • ❌ /player/{username}/games
  • ❌ /player/{username}/matches
  • ❌ /player/{username}/tournaments
  • ❌ /tournament/{url-ID}
  • ❌ /tournament/{url-ID}/{round}
  • ❌ /tournament/{url-ID}/{round}/{group}

Contributing

Dev dependencies

Testing your changes locally

$ make

Links