api-ninjas-com Exercises API

openapi: 3.2.0
info:
  title: Ninjas Exercises API
  description: 'Combined OpenAPI specification for every API Ninjas endpoint. Requests go to https://api.api-ninjas.com with an `X-Api-Key` header; get a free key at https://api-ninjas.com/register. Human-readable docs: https://api-ninjas.com/api. Index for LLMs: https://api-ninjas.com/llms.txt.'
  version: 1.0.0
  contact:
    name: API Ninjas
    url: https://api-ninjas.com
  license:
    name: Proprietary
servers:
- url: https://api.api-ninjas.com
  description: API Ninjas Production
security:
- ApiKeyAuth: []
tags:
- name: Exercises
  description: The Exercises API provides access to a comprehensive list of thousands of exercises targeting every major muscle group.
paths:
  /v1/exercises:
    get:
      summary: Get exercises
      description: Returns up to 5 exercises that satisfy the given parameters.
      operationId: getExercises
      parameters:
      - name: name
        in: query
        description: Name of exercise. This value can be partial.
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: Exercise type.
        required: false
        schema:
          type: string
          enum:
          - cardio
          - olympic_weightlifting
          - plyometrics
          - powerlifting
          - strength
          - stretching
          - strongman
      - name: muscle
        in: query
        description: Muscle group targeted by the exercise.
        required: false
        schema:
          type: string
          enum:
          - abdominals
          - abductors
          - adductors
          - biceps
          - calves
          - chest
          - forearms
          - glutes
          - hamstrings
          - lats
          - lower_back
          - middle_back
          - neck
          - quadriceps
          - traps
          - triceps
      - name: difficulty
        in: query
        description: Difficulty level of the exercise.
        required: false
        schema:
          type: string
          enum:
          - beginner
          - intermediate
          - expert
      - name: equipments
        in: query
        description: Equipment required for the exercise. Multiple equipments can be specified using comma separation (e.g. dumbbell,flat bench). This value can be partial.
        required: false
        schema:
          type: string
      - name: offset
        in: query
        description: Number of results to offset for pagination. Default is 0.
        required: false
        schema:
          type: integer
          default: 0
      responses:
        '200':
          $ref: '#/components/responses/ExerciseList'
        '400':
          $ref: '#/components/responses/ExercisesOpenapi_BadRequest'
        '401':
          $ref: '#/components/responses/ExercisesOpenapi_Unauthorized'
        '500':
          $ref: '#/components/responses/ExercisesOpenapi_InternalServerError'
      security:
      - ApiKeyAuth: []
      tags:
      - Exercises
  /v1/allexercises:
    get:
      summary: Get all exercises for a muscle group
      description: Returns a comprehensive list of exercises that target a specific muscle group. Available on Business, Professional, or annual subscriptions only.
      operationId: getAllExercises
      parameters:
      - name: muscle
        in: query
        description: Muscle group targeted by the exercise.
        required: true
        schema:
          type: string
          enum:
          - abdominals
          - abductors
          - adductors
          - biceps
          - calves
          - chest
          - forearms
          - glutes
          - hamstrings
          - lats
          - lower_back
          - middle_back
          - neck
          - quadriceps
          - traps
          - triceps
      - name: limit
        in: query
        description: Maximum number of results to return. Default is 10, maximum is 100.
        required: false
        schema:
          type: integer
          default: 10
          maximum: 100
      - name: offset
        in: query
        description: Number of results to offset for pagination. Default is 0.
        required: false
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: A list of exercise names.
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
        '400':
          $ref: '#/components/responses/ExercisesOpenapi_BadRequest'
        '401':
          $ref: '#/components/responses/ExercisesOpenapi_Unauthorized'
        '500':
          $ref: '#/components/responses/ExercisesOpenapi_InternalServerError'
      security:
      - ApiKeyAuth: []
      tags:
      - Exercises
components:
  schemas:
    ExercisesOpenapi_Error:
      type: object
      properties:
        message:
          type: string
          description: Error message describing the issue.
    Exercise:
      type: object
      properties:
        name:
          type: string
          description: Name of the exercise.
        type:
          type: string
          description: Exercise type.
          enum:
          - cardio
          - olympic_weightlifting
          - plyometrics
          - powerlifting
          - strength
          - stretching
          - strongman
        muscle:
          type: string
          description: Muscle group targeted by the exercise.
          enum:
          - abdominals
          - abductors
          - adductors
          - biceps
          - calves
          - chest
          - forearms
          - glutes
          - hamstrings
          - lats
          - lower_back
          - middle_back
          - neck
          - quadriceps
          - traps
          - triceps
        difficulty:
          type: string
          description: Difficulty level of the exercise.
          enum:
          - beginner
          - intermediate
          - expert
        instructions:
          type: string
          description: Text instructions describing how to perform the exercise.
        equipments:
          type: array
          description: Array of equipment names required for the exercise.
          items:
            type: string
        safety_info:
          type: string
          description: Additional safety guidance and cues for performing the exercise safely.
        images:
          type: array
          description: 'Image URLs showing the exercise, in movement order (usually the start and finish positions). Premium only: Learner, Developer, Business, and Professional subscriptions.'
          items:
            type: string
            format: uri
          example:
          - https://media.api-ninjas.com/exercise_images/incline-hammer-curls-01.png
          - https://media.api-ninjas.com/exercise_images/incline-hammer-curls-02.png
          x-premium: true
      required:
      - name
      - type
      - muscle
      - difficulty
      - instructions
  responses:
    ExercisesOpenapi_Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExercisesOpenapi_Error'
    ExercisesOpenapi_BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExercisesOpenapi_Error'
    ExerciseList:
      description: A list of exercises.
      content:
        application/json:
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Exercise'
    ExercisesOpenapi_InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ExercisesOpenapi_Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api