https://github.com/wajeht/close-powerlifting
an intuitive api for open-powerlifting database
https://github.com/wajeht/close-powerlifting
bench deadlift ejs express jsdom node powerlifting squat tailwind typescript
Last synced: 3 months ago
JSON representation
an intuitive api for open-powerlifting database
- Host: GitHub
- URL: https://github.com/wajeht/close-powerlifting
- Owner: wajeht
- License: mit
- Created: 2022-10-14T22:02:03.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-22T07:20:12.000Z (almost 2 years ago)
- Last Synced: 2025-05-13T17:08:49.965Z (about 1 year ago)
- Topics: bench, deadlift, ejs, express, jsdom, node, powerlifting, squat, tailwind, typescript
- Language: TypeScript
- Homepage: https://close-powerlifting.jaw.dev/
- Size: 1.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/code-of-conduct.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Close Powerlifting
[](https://github.com/wajeht/close-powerlifting/actions/workflows/ci.yml)
[](https://opensource.org/licenses/ISC)
[](https://github.com/wajeht/close-powerlifting)
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) |
See full query parameters, sort options, and filtering docs at [closepowerlifting.com/docs/api](https://closepowerlifting.com/docs/api)
## Authentication
All endpoints except `/api/status` and `/api/health-check` require an API key:
```bash
curl -H "Authorization: Bearer YOUR_API_KEY" https://closepowerlifting.com/api/rankings
```
Request an API key at [closepowerlifting.com](https://closepowerlifting.com)
## Example Response
```bash
curl -H "Authorization: Bearer YOUR_API_KEY" "https://closepowerlifting.com/api/rankings?per_page=100¤t_page=1&units=kg"
```
```json
{
"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
- See [DEVELOPMENT](./docs/getting-started.md) for `development` guide.
- See [CONTRIBUTION](./docs/contribution.md) for `contribution` guide.
## Data Attribution
This project uses data from the [OpenPowerlifting](https://www.openpowerlifting.org) 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](https://data.openpowerlifting.org).
If you find this API useful, please consider [supporting OpenPowerlifting](https://www.patreon.com/join/openpowerlifting).
## License
Distributed under the MIT License © [wajeht](https://github.com/wajeht). See [LICENSE](./LICENSE) for more information.