chess.com 1.7.0

Python Wrapper around Chess.com API

Python wrapper for Chess.com Public API

Python wrapper for Chess.com API which provides public data from the chess.com website. All endpoints provided by Chess.com's API are available in the respectively named methods.

Installation

The package requires Python 3.7 or higher.

Install from PyPI: pip install chess.com

Usage

Refer to readthedocs and offical api documentation docs for more information on the usage.

Retrieving Data

All the functions return a ChessDotComResponse object. The data can be accessed in dictionary format or via attributes. All functions can be made asynchronous. The package uses aiohttp to send requests to the API.

Synchronous

from chessdotcom import get_player_profile

response = get_player_profile("fabianocaruana")

player_name = response.json['player']['name']
#or
player_name = response.player.name

Asynchronous

from asyncio import gather

from chessdotcom.aio import get_player_profile, Client
#or
from chessdotcom import get_player_profile, Client
Client.aio = True

usernames = ["fabianocaruana", "GMHikaruOnTwitch", "MagnusCarlsen", "GarryKasparov"]
cors = [get_player_profile(name) for name in usernames]
responses = Client.loop.run_until_complete(gather(*cors))

important: The API will begin to rate limit the client if too many requests are made at once.

Configuring the Client object

Headers and and other request parameters can be set through the Client object. Official Chess.com documentation recommends adding a User-Agent header.

#optional
from chessdotcom import Client

Client.config["headers"]["User-Agent"] = (
    "My Python Application. "
    "Contact me at [e-mail]"
)

All the methods from the module will now include the header when making a request to the API.