Developers API

The Ultimate Typing Championship provides a free public API to integrate live data in your projects.

Leaderboard

Live leaderboard is available via REST API at:

 GET   https://www.typrx.com/api/v1/contest/1/leaderboard

Note: You can limit leaderboard length
  e.g. https://www.typrx.com/api/v1/contest/1/leaderboard/10 will return 10 first rows only

Leaderboard is updated every 5 minutes, and provides following data:

• last_update_at  Last leaderboard update time (string, ISO 8601)
• next_update_at  Next leaderboard update time (string, ISO 8601)
• update_interval_in_seconds  Leaderboard update interval in seconds (unsigned integer)
• leaderboard
  • racer_id  Unique racer identifier (unsigned integer)
  • racer_username  Racer username (string)
  • racer_avg_speed  Racer average of best 30 typing speeds (unsigned integer)
      Note: speed is provided in tenth of WPM. Divide by 10 to have speed in words per minute.
        e.g. racer_avg_speed=123 --> 12.3 WPM
  • racer_profile_url  TyprX profile URL (string)
  • racer_country_code  Racer country code (string)
  • racer_country_name  Racer country name (string)
  • racer_country_flag_url  Racer country flag image URL (string)

Payload example:

{
    "last_update_at": "2020-06-04T12:50:07+02:00",
    "next_update_at": "2020-06-04T12:55:07+02:00",
    "update_interval_in_seconds": 300,
    "leaderboard": [
        {
            "id": null,
            "racer_id": 19,
            "racer_username": "john.doe",
            "racer_avg_speed": 300,
            "racer_profile_url": "https://www.typrx.com/profile/19",
            "racer_country_code": "FR",
            "racer_country_name": "France",
            "racer_country_flag_url": "https://www.typrx.com/country-flags/FR.png"
        }
    ]
}

Need more API data?

Contact us at utc@daskeyboard.com