ExerciseDB API

https://v2.exercisedb.dev/docs
Admin
ExerciseDB API is a comprehensive and developer-friendly database providing fast, modern, and...
Tokens:2,875
Snippets:11
Trust Score:5.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### GET /api/v1/liveness

Source: https://v2.exercisedb.dev/docs/index

Checks the liveness of the configured services. Returns the status of the services.

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

### Description
Checks the liveness of the configured services and returns their status.

### Method
GET

### Endpoint
/api/v1/liveness

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```shell
curl https://v2.exercisedb.dev/api/v1/liveness
```

### Response
#### Success Response (200)
- **status** (string) - The status of the configured services.

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

#### Error Responses
- **400**: Bad Request
- **401**: Unauthorized
- **403**: Forbidden
- **404**: Not Found
- **405**: Method Not Allowed
- **409**: Conflict
- **412**: Precondition Failed
- **429**: Too Many Requests
- **500**: Internal Server Error
```

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

### GET /api/v1/exercises

Source: https://v2.exercisedb.dev/docs/index

Retrieves a list of all exercises available in the database. Supports filtering and pagination.

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

### Description
Retrieves a list of all exercises. This endpoint may support filtering and pagination parameters to refine the results.

### Method
GET

### Endpoint
/api/v1/exercises

### Parameters
#### Query Parameters
* **limit** (integer) - Optional - The maximum number of exercises to return.
* **offset** (integer) - Optional - The number of exercises to skip before returning results.

#### Request Body
None

### Response
#### Success Response (200)
- **exercises** (array) - An array of exercise objects.
- **exercise** (object) - Represents a single exercise with its details.
  - **id** (integer) - The unique identifier for the exercise.
  - **name** (string) - The name of the exercise.
  - **instructions** (string) - Step-by-step instructions for performing the exercise.
  - **muscle_groups** (array) - An array of muscle groups targeted by the exercise.
  - **equipment** (array) - An array of equipment required for the exercise.
  - **images** (array) - An array of URLs to images of the exercise.
  - **videos** (array) - An array of URLs to videos of the exercise.

#### Response Example
```json
{
  "exercises": [
    {
      "id": 1,
      "name": "Push-up",
      "instructions": "Start in a plank position...",
      "muscle_groups": ["Chest", "Triceps", "Shoulders"],
      "equipment": ["None"],
      "images": ["url_to_image1.jpg"],
      "videos": ["url_to_video1.mp4"]
    }
  ]
}
```

#### Error Responses
- **400**: Bad Request
- **404**: Not Found
- **500**: Internal Server Error
```

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

### GET /api/v1/equipments

Source: https://v2.exercisedb.dev/docs/index

Retrieves a list of all types of equipment used in the exercises within the database.

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

### Description
Retrieves a list of all types of equipment that are required or used for performing exercises in the database.

### Method
GET

### Endpoint
/api/v1/equipments

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **equipments** (array) - An array of equipment objects.
  - **id** (integer) - The unique identifier for the equipment.
  - **name** (string) - The name of the equipment (e.g., 'Barbell', 'Dumbbells', 'Kettlebell', 'Bodyweight').

#### Response Example
```json
{
  "equipments": [
    {
      "id": 1,
      "name": "Barbell"
    },
    {
      "id": 2,
      "name": "Dumbbells"
    },
    {
      "id": 3,
      "name": "Bodyweight"
    }
  ]
}
```

#### Error Responses
- **404**: Not Found
- **500**: Internal Server Error
```

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

### GET /api/v1/exercisetypes

Source: https://v2.exercisedb.dev/docs/index

Retrieves a list of all categories or types of exercises available in the database.

```APIDOC
## GET /api/v1/exercisetypes

### Description
Retrieves a list of all distinct types or categories of exercises available in the database (e.g., 'Cardio', 'Strength Training', 'Flexibility').

### Method
GET

### Endpoint
/api/v1/exercisetypes

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **exerciseTypes** (array) - An array of exercise type objects.
  - **id** (integer) - The unique identifier for the exercise type.
  - **name** (string) - The name of the exercise type (e.g., 'Strength Training', 'Cardio').

#### Response Example
```json
{
  "exerciseTypes": [
    {
      "id": 1,
      "name": "Strength Training"
    },
    {
      "id": 2,
      "name": "Cardio"
    },
    {
      "id": 3,
      "name": "Flexibility"
    }
  ]
}
```

#### Error Responses
- **404**: Not Found
- **500**: Internal Server Error
```

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

### GET /api/v1/muscles

Source: https://v2.exercisedb.dev/docs/index

Retrieves a list of all individual muscles that are targeted by the exercises in the database.

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

### Description
Retrieves a list of all individual muscles that are targeted by the exercises in the database. This list complements the broader body part categories.

### Method
GET

### Endpoint
/api/v1/muscles

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **muscles** (array) - An array of muscle objects.
  - **id** (integer) - The unique identifier for the muscle.
  - **name** (string) - The name of the muscle (e.g., 'Biceps Brachii', 'Vastus Lateralis', 'Gastrocnemius').
  - **bodypart_id** (integer) - The ID of the body part this muscle belongs to.

#### Response Example
```json
{
  "muscles": [
    {
      "id": 1,
      "name": "Biceps Brachii",
      "bodypart_id": 4 
    },
    {
      "id": 2,
      "name": "Triceps Brachii",
      "bodypart_id": 5
    },
    {
      "id": 3,
      "name": "Quadriceps Femoris",
      "bodypart_id": 6
    }
  ]
}
```

#### Error Responses
- **404**: Not Found
- **500**: Internal Server Error
```

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

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

Source: https://v2.exercisedb.dev/docs/index

Searches for exercises based on specified criteria. Allows for flexible querying of the exercise database.

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

### Description
Searches for exercises based on various criteria such as name, muscle group, or equipment. This endpoint allows for flexible querying of the exercise database.

### Method
GET

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

### Parameters
#### Query Parameters
* **query** (string) - Required - The search term to look for in exercise names or descriptions.
* **muscle_group** (string) - Optional - Filters exercises by a specific muscle group.
* **equipment** (string) - Optional - Filters exercises by required equipment.

#### Request Body
None

### Response
#### Success Response (200)
- **exercises** (array) - An array of exercise objects matching the search criteria.
  - **id** (integer) - The unique identifier for the exercise.
  - **name** (string) - The name of the exercise.
  - **instructions** (string) - Step-by-step instructions for performing the exercise.
  - **muscle_groups** (array) - An array of muscle groups targeted by the exercise.
  - **equipment** (array) - An array of equipment required for the exercise.
  - **images** (array) - An array of URLs to images of the exercise.
  - **videos** (array) - An array of URLs to videos of the exercise.

#### Response Example
```json
{
  "exercises": [
    {
      "id": 5,
      "name": "Bench Press",
      "instructions": "Lie on a flat bench...",
      "muscle_groups": ["Chest", "Triceps", "Shoulders"],
      "equipment": ["Barbell", "Bench"],
      "images": ["url_to_image5.jpg"],
      "videos": ["url_to_video5.mp4"]
    }
  ]
}
```

#### Error Responses
- **400**: Bad Request (e.g., missing required query parameter)
- **404**: Not Found
- **500**: Internal Server Error
```

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

### GET /api/v1/bodyparts

Source: https://v2.exercisedb.dev/docs/index

Retrieves a list of all primary and secondary muscle groups (body parts) covered in the exercise database.

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

### Description
Retrieves a list of all primary and secondary muscle groups (body parts) that are targeted by exercises in the database.

### Method
GET

### Endpoint
/api/v1/bodyparts

### Parameters
#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **bodyparts** (array) - An array of body part objects.
  - **id** (integer) - The unique identifier for the body part.
  - **name** (string) - The name of the body part (e.g., 'Chest', 'Back', 'Legs').
  - **category** (string) - Indicates if it's a 'primary' or 'secondary' muscle group.

#### Response Example
```json
{
  "bodyparts": [
    {
      "id": 1,
      "name": "Chest",
      "category": "primary"
    },
    {
      "id": 2,
      "name": "Back",
      "category": "primary"
    },
    {
      "id": 3,
      "name": "Biceps",
      "category": "secondary"
    }
  ]
}
```

#### Error Responses
- **404**: Not Found
- **500**: Internal Server Error
```

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

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

Source: https://v2.exercisedb.dev/docs/index

Retrieves detailed information about a specific exercise using its unique ID.

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

### Description
Retrieves detailed information about a specific exercise using its unique identifier.

### Method
GET

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

### Parameters
#### Path Parameters
* **exerciseId** (integer) - Required - The unique ID of the exercise to retrieve.

#### Query Parameters
None

#### Request Body
None

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier for the exercise.
- **name** (string) - The name of the exercise.
- **instructions** (string) - Step-by-step instructions for performing the exercise.
- **muscle_groups** (array) - An array of muscle groups targeted by the exercise.
- **equipment** (array) - An array of equipment required for the exercise.
- **images** (array) - An array of URLs to images of the exercise.
- **videos** (array) - An array of URLs to videos of the exercise.

#### Response Example
```json
{
  "id": 10,
  "name": "Squat",
  "instructions": "Stand with feet shoulder-width apart...",
  "muscle_groups": ["Quadriceps", "Glutes", "Hamstrings"],
  "equipment": ["Barbell", "Dumbbells", "Bodyweight"],
  "images": ["url_to_image10.jpg"],
  "videos": ["url_to_video10.mp4"]
}
```

#### Error Responses
- **400**: Bad Request
- **404**: Not Found (if the exerciseId does not exist)
- **500**: Internal Server Error
```
Tokens:
Raw