/

/1,000,000+ Recipe and Grocery List API (v2)

APIs
Generators
Stacks
Projects

Docs
History
Schema

Checked 8h ago · Updated 1mo ago

Collection3

GroceryList10

Images6

Me7

Note5

Recipe23

getGet the recipe/comment tuples for those recipes with 4 or 5 star ratings
getZaps the recipe.
getReturn full Recipe detail. Returns 403 if the recipe is owned by someone else.
deleteDeletes specified recipe (you must be authenticated as the owner of the recipe)
getSame as GET recipe but also includes the recipe videos (if any)
getReturn full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.
postStores recipe step number and returns saved step data
postReturns stored step number and number of steps in recipe
getReturns last active recipe for the user
postGets recipe single step as text
getGet recipes related to the given recipeId
postFeedback on a Recipe -- for internal BigOven editors
getGet a random, home-page-quality Recipe.
getSearch for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. Use any_kw to search across the entire recipe. If you'd like to limit by course, set the parameter "include_primarycat" to one of (appetizers,bread,breakfast,dessert,drinks,maindish,salad,sidedish,soup,marinades,other). If you'd like to exclude a category, set exclude_cat to one or more (comma-separated) list of those categories to exclude. If you'd like to include a category, set include_cat to one or more (comma-separated) of those categories to include. To explicitly include an ingredient in your search, set the parameter "include_ing" to a CSV of up to three ingredients, e.g.:include_ing=mustard,chicken,beef%20tips To explicitly exclude an ingredient in your search, set the parameter "exclude_ing" to a CSV of up to three ingredients. All searches must contain the paging parameters pg and rpp, which are integers, and represent the page number (1-based) and results per page (rpp). So, to get the third page of a result set paged with 25 recipes per page, you'd pass pg=3&rpp=25 If you'd like to target searches to just a single target user's recipes, set userId=the target userId (number). Or, you can set username=theirusername vtn;vgn;chs;glf;ntf;dyf;sff;slf;tnf;wmf;rmf;cps cuisine photos filter=added,try,favorites,myrecipes\r\n\r\n folder=FolderNameCaseSensitive coll=ID of Collection
getSearch for recipes. There are many parameters that you can apply. Starting with the most common, use title_kw to search within a title. Use any_kw to search across the entire recipe. If you'd like to limit by course, set the parameter "include_primarycat" to one of (appetizers,bread,breakfast,dessert,drinks,maindish,salad,sidedish,soup,marinades,other). If you'd like to exclude a category, set exclude_cat to one or more (comma-separated) list of those categories to exclude. If you'd like to include a category, set include_cat to one or more (comma-separated) of those categories to include. To explicitly include an ingredient in your search, set the parameter "include_ing" to a CSV of up to three ingredients, e.g.:include_ing=mustard,chicken,beef%20tips To explicitly exclude an ingredient in your search, set the parameter "exclude_ing" to a CSV of up to three ingredients. All searches must contain the paging parameters pg and rpp, which are integers, and represent the page number (1-based) and results per page (rpp). So, to get the third page of a result set paged with 25 recipes per page, you'd pass pg=3&rpp=25 If you'd like to target searches to just a single target user's recipes, set userId=the target userId (number). Or, you can set username=theirusername vtn;vgn;chs;glf;ntf;dyf;sff;slf;tnf;wmf;rmf;cps cuisine photos filter=added,try,favorites,myrecipes\r\n\r\n folder=FolderNameCaseSensitive coll=ID of Collection
getGet a list of recipe categories (the ID field can be used for include_cat in search parameters)
getGiven a query, return recipe titles starting with query. Query must be at least 3 chars in length.
getAutomatics the complete my recipes.
getAutomatics the complete all recipes.
postPOST an image as a new RecipeScan request 1) Fetch the filename -- DONE 2) Copy it to the pics/scan folder - ENSURE NO NAMING COLLISIONS -- DONE 3) Create 120 thumbnail size in pics/scan/120 -- DONE 4) Insert the CloudTasks record 5) Create the HIT 6) Update the CloudTasks record with the HIT ID 7) Email the requesing user 8) Call out to www.bigoven.com to fetch the image and re-create the thumbnail
putUpdate a recipe
postAdd a new recipe
getGet a list of recipes that the authenticated user has most recently viewed

Review12

Recipe

Feedback on a Recipe -- for internal BigOven editors

post/recipe/{recipeId}/feedback

Path parameters

recipeIdinteger required

Request body

feedbackstring

Response

OK

SystemObject required