API Documentation for RecipeDB 3.0 Backend.
\nID Padding: All IDs (Recipe_ID, Ing_ID) are 8-digit zero-padded strings (Except FlavorDB_ID).
1 is automatically treated as 00000001.Pagination: Most list endpoints accept a page parameter (default: 1). The page size is fixed at 7 items.
Images: Images are returned as URLs. If a recipe has no image, the field may be empty or missing.
\nContact Support:
Name: RecipeDB Team
Email: bagler@iiitd.ac.in
Source File: lists.js
Enum values for Diet, Flavors, Ingredients, Cuisine, Category (of the 20K test dataset)
\nSource File: recipesinfo.js
Fetches a paginated list of recipes. Supports optional filtering by Cuisine or Category.
\nUse this for the main 'Browse' or 'Catalog' page.
\npage (Optional): integer (1, 5)
\ncuisine (Optional): string (\"Indian\", \"American\", \"Mexican\")
\ncategory (Optional): string (\"Lunch\", \"Snack\", \"Dessert\", \"Asian\")
\nSource File: recipeofday.js
Deterministically selects a single recipe based on the current date.
\nUse this on the Home Page hero section.
\nSource File: search-recipe.js
Fetches the complete details of a single recipe by its ID.
\nUse this to display the details of a particular recipe, i.e., for the Recipe Detail Page.
\nSource File: instructions.js
Fetches step-by-step cooking instructions with metadata (Utensils, Action) of a recipe by its ID.
\nUse this alongside the Recipe Detail view.
\nSource File: meal-plan.js
Generates a set of recipes fitting a daily calorie target.
\nUse for the Diet Planner feature.
\nSource File: recipeByTitle.js
Performs a partial match search on recipe titles.
\nUse for the global Search Page to display all the partial and complete matched recipes by title.
\nSource File: by-ingredients.js
Finds recipes containing specific ingredients.
\nUse for Fridge Search to display all the recipes containing and excluding particular ingredients.
\nSource File: by-ingredients-categories-title.js
Combines Ingredient, Diet, Flavor, Category, and Title filters.
\nUse for Advanced Search.
\nincludeDiet (Optional): string (\"Vegetarian\", \"Vegan\")
\ntitle (Optional): string (\"Salad\", \"Curry\")
\nincludeFlavor (Optional): string (\"Spice\", \"Herb\", \"Fruit\")
\nexcludeFlavor (Optional): string (\"Bitter\", \"Sour\")
\ncategory (Optional): string (\"Lunch\", \"Breakfast\")
\nincludeIngredient (Optional): string (\"garlic\")
\nexcludeIngredient (Optional): string (\"beef\")
\ncuisine (Optional): string (\"American\")
\npage (Optional): integer
\nSource File: recipe-diet.js
Filters recipes based on strict dietary rules (Vegan, Vegetarian, etc.).
\nUse for Dietary Preference toggles.
\nSource File: nutritioninfo.js
Fetches macro-nutrients (Calories, Fat, Protein) of a recipe by its ID.
\nUse for the Nutrition Label component.
\nSource File: micronutritioninfo.js
Fetches micro-nutrients: Sodium, Cholesterol, Fiber, Sugar of a recipe by its ID.
\nUse for detailed health analysis.
\nSource File: similar.js
Finds other recipes with the same Cuisine, Category, and similar Calorie count as the current recipe by its ID.
\nUse for 'You May Also Like' sections.
\nSource File: top-rated.js
Fetches recipes sorted by Popularity.
\nUse for 'Trending Now' sections.
\nSource File: random.js
Returns 7 completely random recipes.
\nUse for a 'Surprise Me' button.
\nSource File: facets.js
Returns statistical counts of Recipes by Cuisine and Category.
\nUse to populate Sidebar Filters.
\nSource File: with-image.js
Filters recipes to show only those with images.
\nTo be later used for displaying an image alongside every recipe and to use for visual galleries.
\nSource File: category.js
Filters recipes by a specific category (e.g., 'Lunch' or 'Dinner').
\nUse for Category landing pages.
\nSource File: recipes-cuisine.js
Filters recipes by specific region/cuisine.
\nUse for Cuisine browsing.
\nSource File: recipe-day-category.js
Picks a deterministic 'Recipe of the Day' restricted to a category.
\nUse for 'Dessert/Lunch/Dinner of the Day' and similar sections.
\nSource File: recipe-day-with-ingredients-categories.js
'Recipe of the Day' with flavor/diet filters.
\nUse for personalized recommendations.
\nSource File: region-diet.js
Combines Region (Cuisine) and Diet filters.
\nUse for drill-down navigation.
\nSource File: calories.js
Finds recipes within a min/max calorie range (Sorted by Calories).
\nUse for 'Low Calorie' filters.
\nSource File: byenergy.js
Filter by calories, but sorts results by Popularity.
\nUse for 'Best rated recipes under X cal'.
\nSource File: recipes-by-carbs.js
Filters recipes by Carbohydrate content.
\nUse for Low-Carb / Keto filters.
\nSource File: protein-range.js
Filters recipes by Protein content.
\nUse for High-Protein filters.
\nSource File: recipes-range.js
Allows filtering by BOTH Calories and Protein ranges.
\nUse for Precision Nutrition filtering.
\nSource File: ingredients-flavor.js
Finds recipes from a specific FlavorDB category (e.g., 'Spice', 'Herb').
\nUse for Flavor-based exploration.
\nSource File: byutensils.js
Finds recipes that use specific utensils (e.g., 'wok').
\nUse for Equipment-based filtering.
\nSource File: recipes-method.js
Finds recipes that involve a specific action (e.g., 'fry').
\nUse for Technique-based filtering.
\nSource File: ingredient-info.js
Fetches a comprehensive profile for a specific ingredient. Includes its internal Ing_ID, Metadata (Flavor/Diet categories), Wikipedia links and images, FlavorDB links, and Usage Statistics (Total recipes).
Use this to populate a rich 'Ingredient Details' page.
\nSource File: recipes-per-country.js
Aggregates the database and returns a count of how many recipes belong to each region/cuisine.
\nNote on Data: Because of how the dataset was compiled, a large portion of recipes where a specific geographic cuisine could not be identified are grouped under the 'Other' category. The country key in the response maps directly to these geographic and cultural regions (e.g., 'Indian', 'Asian', 'Other').
Source File: atlas-search.js
Performs a full text search on recipe titles with advanced fuzzy matching (typo tolerance). E.g., searching for 'chikcen' will successfully return 'chicken' recipes.
\nUse this to power the main Search Results Page when a user hits 'Enter' on their query.
\nq (query, Mandatory): string (\"chikcen\", \"chicken\", \"garlic\")
\npage (Optional): integer (1,5)
\n