Search Recipes

v1.0.0

Search through hundreds of thousands of recipes using advanced filtering and ranking. NOTE: This method combines searching by query, by ingredients, and by nutrients into one endpoint.

Input

{
  "type": "object",
  "properties": {
    "addRecipeInformation": {
      "type": "boolean"
    },
    "addRecipeNutrition": {
      "type": "boolean"
    },
    "author": {
      "type": "string"
    },
    "cuisine": {
      "type": "string"
    },
    "diet": {
      "type": "string"
    },
    "equipment": {
      "type": "string"
    },
    "excludeCuisine": {
      "type": "string"
    },
    "excludeIngredients": {
      "type": "string"
    },
    "fillIngredients": {
      "type": "boolean"
    },
    "ignorePantry": {
      "type": "boolean"
    },
    "includeIngredients": {
      "type": "string"
    },
    "instructionsRequired": {
      "type": "boolean"
    },
    "intolerances": {
      "type": "string"
    },
    "limitLicense": {
      "type": "boolean"
    },
    "maxAlcohol": {
      "type": "number"
    },
    "maxCaffeine": {
      "type": "number"
    },
    "maxCalcium": {
      "type": "number"
    },
    "maxCalories": {
      "type": "number"
    },
    "maxCarbs": {
      "type": "number"
    },
    "maxCholesterol": {
      "type": "number"
    },
    "maxCholine": {
      "type": "number"
    },
    "maxCopper": {
      "type": "number"
    },
    "maxFat": {
      "type": "number"
    },
    "maxFiber": {
      "type": "number"
    },
    "maxFluoride": {
      "type": "number"
    },
    "maxFolate": {
      "type": "number"
    },
    "maxFolicAcid": {
      "type": "number"
    },
    "maxIodine": {
      "type": "number"
    },
    "maxIron": {
      "type": "number"
    },
    "maxMagnesium": {
      "type": "number"
    },
    "maxManganese": {
      "type": "number"
    },
    "maxPhosphorus": {
      "type": "number"
    },
    "maxPotassium": {
      "type": "number"
    },
    "maxProtein": {
      "type": "number"
    },
    "maxReadyTime": {
      "type": "number"
    },
    "maxSaturatedFat": {
      "type": "number"
    },
    "maxSelenium": {
      "type": "number"
    },
    "maxSodium": {
      "type": "number"
    },
    "maxSugar": {
      "type": "number"
    },
    "maxVitaminA": {
      "type": "number"
    },
    "maxVitaminB1": {
      "type": "number"
    },
    "maxVitaminB12": {
      "type": "number"
    },
    "maxVitaminB2": {
      "type": "number"
    },
    "maxVitaminB3": {
      "type": "number"
    },
    "maxVitaminB5": {
      "type": "number"
    },
    "maxVitaminB6": {
      "type": "number"
    },
    "maxVitaminC": {
      "type": "number"
    },
    "maxVitaminD": {
      "type": "number"
    },
    "maxVitaminE": {
      "type": "number"
    },
    "maxVitaminK": {
      "type": "number"
    },
    "maxZinc": {
      "type": "number"
    },
    "minAlcohol": {
      "type": "number"
    },
    "minCaffeine": {
      "type": "number"
    },
    "minCalcium": {
      "type": "number"
    },
    "minCalories": {
      "type": "number"
    },
    "minCarbs": {
      "type": "number"
    },
    "minCholesterol": {
      "type": "number"
    },
    "minCholine": {
      "type": "number"
    },
    "minCopper": {
      "type": "number"
    },
    "minFat": {
      "type": "number"
    },
    "minFiber": {
      "type": "number"
    },
    "minFluoride": {
      "type": "number"
    },
    "minFolate": {
      "type": "number"
    },
    "minFolicAcid": {
      "type": "number"
    },
    "minIodine": {
      "type": "number"
    },
    "minIron": {
      "type": "number"
    },
    "minMagnesium": {
      "type": "number"
    },
    "minManganese": {
      "type": "number"
    },
    "minPhosphorus": {
      "type": "number"
    },
    "minPotassium": {
      "type": "number"
    },
    "minProtein": {
      "type": "number"
    },
    "minSaturatedFat": {
      "type": "number"
    },
    "minSelenium": {
      "type": "number"
    },
    "minSodium": {
      "type": "number"
    },
    "minSugar": {
      "type": "number"
    },
    "minVitaminA": {
      "type": "number"
    },
    "minVitaminB1": {
      "type": "number"
    },
    "minVitaminB12": {
      "type": "number"
    },
    "minVitaminB2": {
      "type": "number"
    },
    "minVitaminB3": {
      "type": "number"
    },
    "minVitaminB5": {
      "type": "number"
    },
    "minVitaminB6": {
      "type": "number"
    },
    "minVitaminC": {
      "type": "number"
    },
    "minVitaminD": {
      "type": "number"
    },
    "minVitaminE": {
      "type": "number"
    },
    "minVitaminK": {
      "type": "number"
    },
    "minZinc": {
      "type": "number"
    },
    "number": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "query": {
      "type": "string"
    },
    "recipeBoxId": {
      "type": "number"
    },
    "sort": {
      "type": "string"
    },
    "sortDirection": {
      "type": "string"
    },
    "tags": {
      "type": "string"
    },
    "titleMatch": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "number",
    "offset",
    "results",
    "totalResults"
  ],
  "properties": {
    "number": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "title",
          "calories",
          "carbs",
          "fat",
          "image",
          "imageType",
          "protein"
        ],
        "properties": {
          "calories": {
            "type": "number"
          },
          "carbs": {
            "type": "string"
          },
          "fat": {
            "type": "string"
          },
          "id": {
            "type": "integer"
          },
          "image": {
            "type": "string"
          },
          "imageType": {
            "type": "string"
          },
          "protein": {
            "type": "string"
          },
          "title": {
            "type": "string"
          }
        }
      }
    },
    "totalResults": {
      "type": "integer"
    }
  }
}