/
BI
bigoven
/
1,000,000+ Recipe and Grocery List API (v2)
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 3h ago · Updated 1mo ago
Details
Collection
3
GroceryList
10
Images
6
Me
7
Note
5
Recipe
23
get
Get the recipe/comment tuples for those recipes with 4 or 5 star ratings
get
Zaps the recipe.
get
Return full Recipe detail. Returns 403 if the recipe is owned by someone else.
delete
Deletes specified recipe (you must be authenticated as the owner of the recipe)
get
Same as GET recipe but also includes the recipe videos (if any)
get
Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.
post
Stores recipe step number and returns saved step data
post
Returns stored step number and number of steps in recipe
get
Returns last active recipe for the user
post
Gets recipe single step as text
get
Get recipes related to the given recipeId
post
Feedback on a Recipe -- for internal BigOven editors
get
Get a random, home-page-quality Recipe.
get
Search 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
get
Search 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
get
Get a list of recipe categories (the ID field can be used for include_cat in search parameters)
get
Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.
get
Automatics the complete my recipes.
get
Automatics the complete all recipes.
post
POST 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
put
Update a recipe
post
Add a new recipe
get
Get a list of recipes that the authenticated user has most recently viewed
Review
12
Recipe
Get a list of recipe categories (the ID field can be used for include_cat in search parameters)
get
/recipe/categories
Response
OK
BigOvenModelRecipeCategory[]
required
ID
integer
Category
string
ParentID
integer
ShortDescription
string
PrimaryImage
string
DefaultTotalMinutes
integer
DefaultActiveMinutes
integer