FIDE ratings scraper

FIDE is the International Chess Federation. They have a ratings sub-domain where players can check their international ELO rating (in different categories), their perfomance history, et cetera.

This set of JS utility functions (built using NodeJS) aim to provide a sort-of-api to get info from their ratings pages.

I decided to implement this so that I could integrate it in a few of my chess-related projects. Maybe it can help other people in their personal projects as well 👍.

Running the API
Setup
Testing
API Documentation
Running Sample

Running the API

Start the API by running:

npm start

Setup

As in any NodeJS application:

npm install

Copy the .env template and configure the local environment setup:

cp .env .env.local

Testing

To run the test suites, simply run

npm test

API Documentation

GET Player Full Info

/player/{{fide_number}}/info

Get all the information provided by FIDE about the player.

{
    "name": "Doe, John",
    "federation": "Portugal",
    "birth_year": 1980,
    "sex": "Male",
    "title": "None",
    "standard_elo": 1700,
    "rapid_elo": 1650,
    "blitz_elo": 1750,
    "world_rank_all_players": 180000,
    "world_rank_active_players": 135200,
    "national_rank_all_players": 760,
    "national_rank_active_players": 325,
    "continental_rank_all_players": 132400,
    "continental_rank_active_players": 62405
}

GET Player Personal Data

/player/{{fide_number}}/personal-data

Get the player's personal data.

{
    "name": "Doe, John",
    "federation": "Portugal",
    "birth_year": 1980,
    "sex": "Male",
    "title": "None",
}

GET Player Rank

/player/{{fide_number}}/rank

Get the player's rank in different ranking lists.

{
    "world_rank_all_players": 180000,
    "world_rank_active_players": 135200,
    "national_rank_all_players": 760,
    "national_rank_active_players": 325,
    "continental_rank_all_players": 132400,
    "continental_rank_active_players": 62405
}

GET Player ELO

/player/{{fide_number}}/elo

Get the player's ELO in all the categories.

{
    "standard_elo": 1700,
    "rapid_elo": 1650,
    "blitz_elo": 1750,
}

GET Player History

/player/{{fide_number}}/history

Get a full list of all the player's ELO ratings (in all the categories) along the past years, ordered by date (most recent first).

[
    {
        "date": "2019-Oct",
        "numeric_date": 201910,
        "standard": "1700",
        "num_standard_games": "1",
        "rapid": "1650",
        "num_rapid_games": "0",
        "blitz": "1750",
        "num_blitz_games": "0"
    },
    {
        "date": "2019-Sep",
        "numeric_date": 201909,
        "standard": "1692",
        "num_standard_games": "1",
        "rapid": "1610",
        "num_rapid_games": "9",
        "blitz": "1750",
        "num_blitz_games": "0"
    },
    {
        "date": "2019-Aug",
        "numeric_date": 201908,
        "standard": "1680",
        "num_standard_games": "2",
        "rapid": "1610",
        "num_rapid_games": "0",
        "blitz": "1720",
        "num_blitz_games": "2"
    }
]

Running Sample

You may find a running sample in https://lit-wildwood-98645.herokuapp.com, deployed using Heroku's free deployments.

kirega/fide-ratings-scraper