Skip to content

wajeht/close-powerlifting

Repository files navigation

🏋🏻 Close Powerlifting

Node.js CI License: MIT Open Source Love svg1

An intuitive REST API for the OpenPowerlifting database.

📃 API Endpoints

Endpoint Description
/api/rankings Global powerlifting rankings sorted by DOTS score
/api/federations Powerlifting federation data and meet results
/api/meets Individual competition/meet results with attempt data
/api/records All-time powerlifting records by equipment and weight class
/api/users Athlete profiles and competition history
/api/status Data source status and statistics (no auth required)
/api/health-check API health monitoring (no auth required)

Full API documentation available at close-powerlifting.jaw.dev/docs/api

🔐 Authentication

All endpoints except /api/status and /api/health-check require an API key:

curl -H "Authorization: Bearer YOUR_API_KEY" https://close-powerlifting.jaw.dev/api/rankings

Request an API key at close-powerlifting.jaw.dev

📦 Example Response

curl -H "Authorization: Bearer YOUR_API_KEY" "https://close-powerlifting.jaw.dev/api/rankings?per_page=100&current_page=1"
{
  "status": "success",
  "request_url": "/api/rankings",
  "message": "The resource was returned successfully!",
  "data": [
    {
      "rank": 1,
      "full_name": "John Haack",
      "username": "johnhaack",
      "user_profile": "/api/users/johnhaack"
    }
  ],
  "pagination": {
    "items": 415567,
    "pages": 4155,
    "per_page": 100,
    "current_page": 1,
    "last_page": 4155,
    "first_page": 1,
    "from": 0,
    "to": 100
  }
}

📑 Docs

📊 Data Attribution

This project uses data from the OpenPowerlifting project, a community service to create a permanent, open archive of the world's powerlifting data.

All competition data is contributed to the Public Domain. You can download a copy of the raw data at data.openpowerlifting.org.

If you find this API useful, please consider supporting OpenPowerlifting.

📜 License

Distributed under the MIT License © wajeht. See LICENSE for more information.

Sponsor this project

Contributors 3

  •  
  •  
  •