Skip to content

OpenSource ExerciseDB API is an exercises dataset api that allows users to access high-quality exercises data which consists 1300+ exercises. This API offers extensive information on each exercise, including target body parts, equipment needed, GIFs for visual guidance, and step-by-step instructions.

License

Notifications You must be signed in to change notification settings

cyberboyanmol/exercisedb-api

Repository files navigation

ExerciseDB API

GitHub License GitHub Release

ExerciseDB API, accessible at exercisedb-api.vercel.app, is an exercises API that allows users to access high-quality exercises data which consists 1300+ exercises. This API offers extensive information on each exercise, including target body parts, equipment needed, GIFs for visual guidance, and step-by-step instructions.

⚠️ Important Notice

The unauthorized downloading, scraping, or bulk collection of data from this API is strictly prohibited. This API is intended for individual exercise lookups and legitimate application integration only. If you need access to the complete dataset or have specific requirements, please contact via Telegram at @cyberboyanmol. We're happy to discuss proper data usage and potential collaborations.

📚 Documentation

Check out the API documentation for detailed information on how to use the API.

Sample Dataset

 {
        "exerciseId": "guT8YnS",
        "name": "biceps pull-up",
        "gifUrl": "https://cdn-exercisedb.vercel.app/api/v1/images/guT8YnS.gif",
        "instructions": [
          "Step:1 Hang from a pull-up bar with your palms facing away from you and your hands shoulder-width apart.",
          "Step:2 Engage your core and pull yourself up by bending your elbows, bringing your chest towards the bar.",
          "Step:3 Pause at the top of the movement, then slowly lower yourself back down to the starting position.",
          "Step:4 Repeat for the desired number of repetitions."
        ],
        "targetMuscles": [
          "biceps"
        ],
        "bodyParts": [
          "upper arms"
        ],
        "equipments": [
          "body weight"
        ],
        "secondaryMuscles": [
          "forearms",
          "shoulders"
        ]
 }

Chest Dip Exercise

📰 Changelog

For a detailed list of changes, see the CHANGELOG.

🔌 Running Locally

Note

You need Bun(1.1.25+) or Node.js(v20+)

  1. Clone the repository:

    git clone https://github.com/cyberboyanmol/exercisedb-api
    cd exercisedb-api
  2. Install the required dependencies:

    bun install
  3. Launch the development server:

    bun run dev

☁️ Deploying Your Own Instance

You can easily deploy your own instance of the API by clicking the button below:

Deploy with Vercel

📜 License

This project is distributed under the MIT License. For more information, see the issue ISSUE included in this repository.

About

OpenSource ExerciseDB API is an exercises dataset api that allows users to access high-quality exercises data which consists 1300+ exercises. This API offers extensive information on each exercise, including target body parts, equipment needed, GIFs for visual guidance, and step-by-step instructions.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published