api-ninjas-com Calories Burned API

openapi: 3.2.0
info:
  title: Ninjas Calories Burned 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: Calories Burned
  description: The Calories Burned API calculates the total calories burned for thousands of sports, exercises, jobs, and everyday activities. It supports custom weight and duration, and can personalize estimates with age, sex, and height or a known resting metabolic rate.
paths:
  /v1/caloriesburned:
    get:
      summary: Calculate calories burned
      description: Calculates calories burned from an activity, weight in pounds, and duration in minutes. Requires an activity. For valid names use /caloriesburnedactivities. The image_url and icon_url fields are premium only.
      operationId: calculateCaloriesBurned
      parameters:
      - name: activity
        in: query
        required: true
        description: Name of the activity. Accepts activity names, common synonyms, and fitness-platform workout type identifiers. This value can be partial.
        schema:
          type: string
      - name: weight
        in: query
        description: Weight of the user performing the activity in pounds. Must be between 50 and 500. Default value is 160.
        schema:
          type: integer
          default: 160
          minimum: 50
          maximum: 500
      - name: duration
        in: query
        description: How long the activity was performed in minutes. Must be 1 or greater. Default value is 60 (1 hour).
        schema:
          type: integer
          default: 60
          minimum: 1
      - name: age
        in: query
        description: Age of the user in years. Must be between 13 and 120. To personalize the estimate, provide age, sex, and height together (or rmr instead).
        schema:
          type: integer
          minimum: 13
          maximum: 120
      - name: sex
        in: query
        description: Sex of the user. Use together with age and height.
        schema:
          type: string
          enum:
          - male
          - female
      - name: height
        in: query
        description: Height of the user in inches. Must be between 36 and 96. Use together with age and sex.
        schema:
          type: number
          minimum: 36
          maximum: 96
      - name: rmr
        in: query
        description: Resting metabolic rate of the user in calories per day, if known. Must be between 500 and 5000. When provided, it is used instead of age, sex, and height.
        schema:
          type: integer
          minimum: 500
          maximum: 5000
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaloriesBurnedResponse'
              example:
              - name: Running, 10 mph (6 min mile)
                calories_per_hour: 1162
                duration_minutes: 60
                total_calories: 1162
                image_url: https://media.api-ninjas.com/activity_images/298a1f4fc68196e32526c99689d5c9aa62b9918dfbd600f86af2ec971b710fec.png
                icon_url: https://media.api-ninjas.com/activity_images/e99f715ce23fd73e5b79d2796b63b3f61eb5c9b991a0bd51aaa1e9a9bdfe8a5f.png
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      tags:
      - Calories Burned
  /v1/caloriesburnedactivities:
    get:
      summary: List all supported activities
      description: Returns the names of all activities supported by the calories-burned calculation. To compute calories for one of them use /caloriesburned.
      operationId: listActivities
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActivitiesListResponse'
        '400':
          description: Bad Request
        '401':
          description: Unauthorized
        '500':
          description: Internal Server Error
      security:
      - ApiKeyAuth: []
      tags:
      - Calories Burned
components:
  schemas:
    ActivitiesListResponse:
      type: array
      items:
        type: string
        description: Name of the supported activity.
    CaloriesBurnedResponse:
      type: array
      items:
        type: object
        properties:
          name:
            type: string
            description: Name of the activity.
          calories_per_hour:
            type: integer
            description: Calories burned per hour.
          duration_minutes:
            type: integer
            description: Duration of the activity in minutes.
          total_calories:
            type: integer
            description: Total calories burned.
          image_url:
            type: string
            format: uri
            description: 'Photorealistic image of the activity. Premium only: Learner, Developer, Business, and Professional subscriptions.'
            example: https://media.api-ninjas.com/activity_images/298a1f4fc68196e32526c99689d5c9aa62b9918dfbd600f86af2ec971b710fec.png
            x-premium: true
          icon_url:
            type: string
            format: uri
            description: 'Consistent activity pictogram with a transparent background. Premium only: Learner, Developer, Business, and Professional subscriptions.'
            example: https://media.api-ninjas.com/activity_images/e99f715ce23fd73e5b79d2796b63b3f61eb5c9b991a0bd51aaa1e9a9bdfe8a5f.png
            x-premium: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api