api-ninjas-com Recipe API

openapi: 3.2.0
info:
  title: Ninjas Recipe 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: Recipe
  description: The Recipe API provides access to hundreds of thousands of creative recipes from all cuisines with detailed nutrition information.
paths:
  /v3/recipe:
    get:
      tags:
      - Recipe
      summary: Get a list of recipes
      description: Get a list of recipes for a given recipe name or ingredient(s). Returns a list of recipes with nutrition information. To access more results, use the limit parameter to limit the number of results and the offset parameter to offset results for pagination in multiple API calls.
      operationId: getRecipes
      parameters:
      - $ref: '#/components/parameters/RecipeOpenapi_title'
      - $ref: '#/components/parameters/ingredients'
      - $ref: '#/components/parameters/RecipeOpenapi_limit'
      - $ref: '#/components/parameters/RecipeOpenapi_offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Recipe'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeOpenapi_Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeOpenapi_Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipeOpenapi_Error'
      security:
      - ApiKeyAuth: []
components:
  schemas:
    Nutrition:
      type: object
      properties:
        calories:
          type: number
          description: Total calories
        total_fat:
          type: number
          description: Total fat in grams
        saturated_fat:
          type: number
          description: Saturated fat in grams
        protein:
          type: number
          description: Protein in grams
        sodium:
          type: number
          description: Sodium in milligrams
        potassium:
          type: number
          description: Potassium in milligrams
        dietary_fiber:
          type: number
          description: Dietary fiber in grams
        cholesterol:
          type: number
          description: Cholesterol in milligrams
        sugars:
          type: number
          description: Total sugars in grams
        total_carbohydrate:
          type: number
          description: Total carbohydrates in grams
    RecipeOpenapi_Error:
      type: object
      properties:
        message:
          type: string
          description: Error message
    Recipe:
      type: object
      properties:
        title:
          type: string
          description: Title of the recipe
        ingredients:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Ingredient name
              quantity:
                type: number
                description: Ingredient quantity
              unit:
                type: string
                description: Unit of measurement for the quantity
          description: Array of ingredient objects, each containing name, quantity, and unit.
        servings:
          type: string
          description: Number of servings
        instructions:
          type: array
          items:
            type: string
          description: Array of instruction step strings.
        nutrition:
          $ref: '#/components/schemas/Nutrition'
          description: Nutrition information. Premium only.
  parameters:
    ingredients:
      name: ingredients
      in: query
      description: Comma-separated list of ingredients to search for. Premium subscribers only.
      required: false
      schema:
        type: string
    RecipeOpenapi_limit:
      name: limit
      in: query
      description: Number of results to return. Must be between 1 and 10. If not set, a default value of 1 will be used. Premium subscribers only.
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
        maximum: 10
    RecipeOpenapi_title:
      name: title
      in: query
      description: Recipe title to search for.
      required: false
      schema:
        type: string
    RecipeOpenapi_offset:
      name: offset
      in: query
      description: Number of results to offset for pagination. Premium subscribers only.
      required: false
      schema:
        type: integer
        minimum: 0
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
externalDocs:
  description: API Ninjas documentation
  url: https://api-ninjas.com/api