500,000+ Recipe and Grocery List API (v2)
Article
Copy Page
500,000+ Recipe and Grocery List API (v2)
Article
Get a food article
GET
Collection
Gets a recipe collection. A recipe collection is a curated set of recipes.
GET
Gets a recipe collection metadata. A recipe collection is a curated set of recipes.
GET
Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections.
GET
GroceryList
Delete all the items on a grocery list; faster operation than a sync with deleted items.
DELETE
Get the user's grocery list. User is determined by Basic Authentication.
GET
Clears the checked lines.
POST
Departmentalize a list of strings -- used for ad-hoc grocery list item addition
POST
Add a single line item to the grocery list
POST
/grocerylist/item/{guid} DELETE will delete this item assuming you own it.
DELETE
Update a grocery item by GUID
PUT
Add a single line item to the grocery list
POST
Add a Recipe to the grocery list. In the request data, pass in recipeId, scale (scale=1.0 says to keep the recipe the same size as originally posted), markAsPending (true/false) to indicate that the lines in the recipe should be marked in a
POST
Synchronize the grocery list. Call this with a POST to /grocerylist/sync
POST
Images
POST: /image/avatar Testing with Postman (validated 11/20/2015): 1) Remove the Content-Type header; add authentication information 2) On the request, click Body and choose "form-data", then add a line
POST
Gets the pending by user.
GET
POST: /recipe/{recipeId}/image?lat=42&lng=21&caption=this%20is%20my%20caption Note that caption, lng and lat are all optional, but must go on the request URI as params because this endpoint needs a multip
POST
Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos.
GET
Get all the photos for a recipe
GET
Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.
GET
Me
Indexes this instance.
GET
Puts me.
PUT
Puts me personal.
PUT
Puts me preferences.
PUT
Gets the options.
GET
Puts me.
PUT
Skinnies this instance.
GET
Recipe
Add a new recipe
Update a recipe
Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.
Automatics the complete all recipes.
Automatics the complete my recipes.
Get a list of recipe categories (the ID field can be used for include_cat in search parameters)
Returns last active recipe for the user
Gets recipe single step as text
Returns stored step number and number of steps in recipe
Stores recipe step number and returns saved step data
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
Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.
Delete a Recipe (you must be authenticated as an owner of the recipe)
Return full Recipe detail. Returns 403 if the recipe is owned by someone else.
Zaps the recipe.
Feedback on a Recipe -- for internal BigOven editors
Get recipes related to the given recipeId
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 para
Get a random, home-page-quality Recipe.
Get the recipe/comment tuples for those recipes with 4 or 5 star ratings
Get a list of recipes that the authenticated user has most recently viewed
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 para
Same as GET recipe but also includes the recipe videos (if any)
Review
DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply.
Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply.
Get a given review by string-style ID. This will return a payload with FeaturedReply, ReplyCount. Recommended display is to list top-level reviews with one featured reply underneath. Currently, the FeaturedReply is the most rece
Update a given top-level review.
Get a paged list of replies for a given review.
POST a reply to a given review. The date will be set by server. Note that replies no longer have star ratings, only top-level reviews do.
Get *my* review for the recipe {recipeId}, where "me" is determined by standard authentication headers
Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated.
DEPRECATED! - Deletes a review by recipeId and reviewId. Please use recipe/review/{reviewId} instead.
Get a given review - DEPRECATED. See recipe/review/{reviewId} for the current usage. Beginning in January 2017, BigOven moded from an integer-based ID system to a GUID-style string-based ID system for reviews and replies. We are
HTTP PUT (update) a recipe review. DEPRECATED. Please see recipe/review/{reviewId} PUT for the new endpoint. We are moving to a string-based primary key system, no longer integers, for reviews and replies.
Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount.
Note
HTTP POST a new note into the system.
Delete a review do a DELETE Http request of /note/{ID}
Get a given note. Make sure you're passing authentication information in the header for the user who owns the note.
HTTP PUT (update) a Recipe note (RecipeNote).
recipe/100/notes
Article
MCP
Copy Page
Get a food article
GET
/article/{uniqueKeyword}
Try it
Run in Apidog
Run in Apidog
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'https://api2.bigoven.com/article/'
Response
Response Example
200 -
Example 1
{
}
Request
Path Params
Generate Code
uniqueKeyword
string
Â
required
The article unique keyword
Responses
🟢
200
Article successfully returned
application/json
Generate Code
Body
Generate Code
object
Â
{0}
ðŸŸ
404
Article not found
Modified atÂ
2022-09-11 17:38:59
Next
Gets a recipe collection. A recipe collection is a curated set of recipes.