SRP Tracker API Documentation

SRP Tracker is a webapp used to track various data on the official SRP timing leaderboards. Currently, it is tracking point leaderboard changes. The SRP Tracker API is open source, entirely public, and free to use provided the following:

  1. You MUST credit SRP Tracker and/or Jonathan Lo.
  2. You CANNOT run ads or paid services.
  3. You CANNOT exceed a limit of 2 requests per second per IP address.

API Reference

/status

Method: GET

Description: Handles requests to the /status endpoint. This endpoint can be used to check the health of the server. It responds with a message indicating that the server is running.

Responses:

200 OK
{
    "msg": "Status OK, server is running"
}

/leaderboard

Method: GET

Description: Retrieves the leaderboard data from the MongoDB collection. This endpoint fetches documents from the leaderboard collection, filtered by a required leaderboard identifier provided as a query parameter.

Query Parameters:

leaderboard (string, required) - A required query parameter to filter the leaderboard data based on its identifier.

Responses:

200 OK
[
  {
    "data": [
      {
        "name": "Jonathan",
        "points": 4237,
        "rank": 1
      },
      {
        "name": "OFFIS",
        "points": 3963,
        "rank": 2
      },
      ...
    ],
    "datetime": "Sun, 06 Oct 2024 19:32:36 GMT",
    "leaderboard": "Combined"
  },
  {
    "data": [
      {
        "name": "Jonathan",
        "points": 4237,
        "rank": 1
      },
      {
        "name": "OFFIS",
        "points": 3963,
        "rank": 2
      },
      ...
    ],
    "datetime": "Monday, 07 Oct 2024 19:32:36 GMT",
    "leaderboard": "Combined"
  }
]
400 Bad Request
{
    "error": "The 'leaderboard' query parameter is required."
}
404 Not Found
{
    "data": []
}