ExerciseDB

https://oss.exercisedb.dev/docs
Admin
This project provides comprehensive documentation for ExerciseDB, an open-source platform offering a...
Tokens:1,456
Snippets:21
Trust Score:5.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### Quick Start Exercise Retrieval

Source: https://oss.exercisedb.dev/docs

Fetches the list of exercises from the API using a standard GET request.

```shell
curl -X GET "https://oss.exercisedb.dev/api/v1/exercises"
```

--------------------------------

### GET /api/v1/equipments

Source: https://oss.exercisedb.dev/docs

Retrieves a list of all available equipment.

```APIDOC
## GET /api/v1/equipments

### Description
Retrieves a list of all available equipment.

### Method
GET

### Endpoint
/api/v1/equipments
```

--------------------------------

### GET /api/v1/exercises

Source: https://oss.exercisedb.dev/docs

Retrieves a list of exercises.

```APIDOC
## GET /api/v1/exercises

### Description
Retrieves a list of exercises.

### Method
GET

### Endpoint
/api/v1/exercises
```

--------------------------------

### GET /api/v1/exercises/search

Source: https://oss.exercisedb.dev/docs

Searches for exercises.

```APIDOC
## GET /api/v1/exercises/search

### Description
Searches for exercises.

### Method
GET

### Endpoint
/api/v1/exercises/search
```

--------------------------------

### GET /api/v1/exercises/equipments

Source: https://oss.exercisedb.dev/docs

Retrieves a list of equipment associated with exercises.

```APIDOC
## GET /api/v1/exercises/equipments

### Description
Retrieves a list of equipment associated with exercises.

### Method
GET

### Endpoint
/api/v1/exercises/equipments
```

--------------------------------

### GET /api/v1/liveness

Source: https://oss.exercisedb.dev/docs

Checks the status of the configured services.

```APIDOC
## GET /api/v1/liveness

### Description
Returns the status of the configured services.

### Method
GET

### Endpoint
https://oss.exercisedb.dev/api/v1/liveness

### Request Example
curl https://oss.exercisedb.dev/api/v1/liveness

### Response
#### Success Response (200)
- **status** (string) - The configured services and their status

#### Response Example
{
  "status": "string"
}
```

--------------------------------

### GET /api/v1/liveness

Source: https://oss.exercisedb.dev/docs

Checks the liveness status of the API server.

```APIDOC
## GET /api/v1/liveness

### Description
Checks the liveness status of the API server.

### Method
GET

### Endpoint
/api/v1/liveness
```

--------------------------------

### GET /api/v1/exercises

Source: https://oss.exercisedb.dev/docs

Retrieves the list of exercises available in the ExerciseDB dataset.

```APIDOC
## GET /api/v1/exercises

### Description
Retrieves the full list of exercises from the ExerciseDB dataset.

### Method
GET

### Endpoint
https://oss.exercisedb.dev/api/v1/exercises

### Request Example
curl -X GET "https://oss.exercisedb.dev/api/v1/exercises"
```

--------------------------------

### GET /api/v1/muscles

Source: https://oss.exercisedb.dev/docs

Retrieves a list of all available muscles.

```APIDOC
## GET /api/v1/muscles

### Description
Retrieves a list of all available muscles.

### Method
GET

### Endpoint
/api/v1/muscles
```

--------------------------------

### GET /api/v1/bodyparts

Source: https://oss.exercisedb.dev/docs

Retrieves a list of all available body parts.

```APIDOC
## GET /api/v1/bodyparts

### Description
Retrieves a list of all available body parts.

### Method
GET

### Endpoint
/api/v1/bodyparts
```

--------------------------------

### GET /api/v1/exercises/{exerciseId}

Source: https://oss.exercisedb.dev/docs

Retrieves details for a specific exercise by its ID.

```APIDOC
## GET /api/v1/exercises/{exerciseId}

### Description
Retrieves details for a specific exercise by its ID.

### Method
GET

### Endpoint
/api/v1/exercises/{exerciseId}

### Parameters
#### Path Parameters
- **exerciseId** (string) - Required - The unique identifier of the exercise.
```

--------------------------------

### GET /api/v1/exercises/bodyparts

Source: https://oss.exercisedb.dev/docs

Retrieves a list of body parts associated with exercises.

```APIDOC
## GET /api/v1/exercises/bodyparts

### Description
Retrieves a list of body parts associated with exercises.

### Method
GET

### Endpoint
/api/v1/exercises/bodyparts
```

--------------------------------

### GET /api/v1/exercises/muscles

Source: https://oss.exercisedb.dev/docs

Retrieves a list of muscles associated with exercises.

```APIDOC
## GET /api/v1/exercises/muscles

### Description
Retrieves a list of muscles associated with exercises.

### Method
GET

### Endpoint
/api/v1/exercises/muscles
```

--------------------------------

### Exercise Data Structure

Source: https://oss.exercisedb.dev/docs

Represents the JSON schema for an individual exercise object within the database.

```json
{
  "exerciseId": "EIeI8Vf",
  "name": "barbell bench press",
  "gifUrl": "https://static.exercisedb.dev/media/EIeI8Vf.gif",
  "targetMuscles": ["pectorals"],
  "bodyParts": ["chest"],
  "equipments": ["barbell"],
  "secondaryMuscles": ["triceps", "shoulders"],
  "instructions": [
    "Step:1 Lie flat on a bench with your feet flat on the ground...",
    "Step:2 Grasp the barbell with an overhand grip...",
    "Step:3 Lift the barbell off the rack...",
    "Step:4 Lower the barbell slowly towards your chest...",
    "Step:5 Pause for a moment when the barbell touches your chest.",
    "Step:6 Push the barbell back up to the starting position...",
    "Step:7 Repeat for the desired number of repetitions."
  ]
}
```

--------------------------------

### Liveness Check Request

Source: https://oss.exercisedb.dev/docs

Verifies the status of the API services using the liveness endpoint.

```shell
curl https://oss.exercisedb.dev/api/v1/liveness
```

--------------------------------

### Liveness Response Schema

Source: https://oss.exercisedb.dev/docs

Defines the expected JSON structure for the liveness endpoint response.

```json
{
  "status": "string"
}
```
Tokens:
Raw