Bigoven

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

Documentation This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API. The update brings with it Swagger-based…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

#Documentation

This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API.

The update brings with it Swagger-based documentation. Swagger is an emerging standard for describing REST-based APIs, and with this Swagger-compliant endpoint (above), you can make ready-to-go interface libraries for your code via swagger-codegen. For instance, it's easy to generate libraries for Node.js, Java, Ruby, ASP.NET MVC, jQuery, php and more!

You can also try out the endpoint calls with your own api_key right here on this page. Be sure to enter your api_key above to use the "Try it out!" buttons on this page.

##Start Here

Developers new to the BigOven API should start with this version, not with the legacy API. We'll be making improvements to this API over time, and doing only bug fixes on the v1 API.

To pretend you're a BigOven user (for instance, to get your recently viewed recipes or your grocery list), you need to pass in Basic Authentication information in the header, just as with the v1 API. We do now require that you make all calls via https. You need to pass your api_key in with every call, though this can now be done on the header (send a request header "X-BigOven-API-Key" set to your api_key value, e.g., Request["X-BigOven-API-Key"]="your-key-here".)

##Migration Notes

For existing partners, we encourage you to migrate, and while at this writing we have no hard-and-fast termination date for the v1 API, we strongly prefer that you migrate by January 1, 2017. While the changes aren't overly complex, there are several breaking changes, including refactoring of recipe search and results and removal of support for XML. This is not a simply plug-and-play replacement to the v1 API. With respect to an exclusive focus on JSON, the world has spoken, and it prefers JSON for REST-based API's. We've taken numerous steps to refactor the API to make it more REST-compliant. Note that this v2 API will be the preferred API from this point onward, so we encourage developers to migrate to this new format. We have put together some migration notes that we encourage you to read carefully.

##Photos

See our photos documentation.

For more information on usage of this API, including features, pricing, rate limits, terms and conditions, please visit the BigOven API website.

Endpoints 66

Collection

  • GETGets a recipe collection. A recipe collection is a curated set of recipes./collection/:id?rpp=0&pg=0&test=true&sessionForLogging=string
  • GETGets a recipe collection metadata. A recipe collection is a curated set of recipes./collection/:id/meta
  • GETGet the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections./collections?test=string

GroceryList

  • GETGet the user's grocery list. User is determined by Basic Authentication./grocerylist
  • DELETEDelete all the items on a grocery list; faster operation than a sync with deleted items./grocerylist
  • POSTClears the checked lines./grocerylist/clearcheckedlines
  • POSTDepartmentalize a list of strings -- used for ad-hoc grocery list item addition/grocerylist/department
  • POSTAdd a single line item to the grocery list/grocerylist/item
  • PUTUpdate a grocery item by GUID/grocerylist/item/:guid
  • DELETE/grocerylist/item/{guid} DELETE will delete this item assuming you own it./grocerylist/item/:guid
  • POSTAdd a single line item to the grocery list/grocerylist/line
  • POSTAdd 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 "pending" (unconfirmed by user) state./grocerylist/recipe
  • POSTSynchronize the grocery list. Call this with a POST to /grocerylist/sync/grocerylist/sync

Images

  • POSTPOST: /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 item with "key" column set to "file" and on the right, change the type of the input from Text to File. Browse and choose a JPG./image/avatar
  • GETGets the pending by user./recipe/photos/pending
  • POSTPOST: /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 multipart/mime content header and will not parse JSON in the body along with it. 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 item with "key" column set to "file" and on the right, change the type of the input from Text to File. Browse and choose a JPG./recipe/:recipeId/image?caption=string&lat=0.0&lng=0.0
  • GETGet all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos./recipe/:recipeId/images
  • GETGet all the photos for a recipe/recipe/:recipeId/photos?pg=0&rpp=0
  • GETGets a list of RecipeScan images for the recipe. There will be at most 3 per recipe./recipe/:recipeId/scans

Me

  • GETIndexes this instance./me
  • PUTPuts me./me
  • PUTPuts me personal./me/personal
  • PUTPuts me preferences./me/preferences
  • GETGets the options./me/preferences/options
  • PUTPuts me./me/profile
  • GETSkinnies this instance./me/skinny

Recipe

  • PUTUpdate a recipe/recipe
  • POSTAdd a new recipe/recipe
  • GETGiven a query, return recipe titles starting with query. Query must be at least 3 chars in length./recipe/autocomplete?query=string&limit=0
  • GETAutomatics the complete all recipes./recipe/autocomplete/all?query=string&limit=0
  • GETAutomatics the complete my recipes./recipe/autocomplete/mine?query=string&limit=0
  • GETGet a list of recipe categories (the ID field can be used for include_cat in search parameters)/recipe/categories
  • GETReturns last active recipe for the user/recipe/get/active/recipe?userName=string
  • POSTGets recipe single step as text/recipe/get/saved/step?userName=string&recipeId=0&stepId=0
  • POSTReturns stored step number and number of steps in recipe/recipe/get/step/number?userName=string&recipeId=0
  • POSTStores recipe step number and returns saved step data/recipe/post/step?userName=string&recipeId=0&stepId=0
  • 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/recipe/scan?test=true&devicetype=string&lat=0.0&lng=0.0
  • GETReturn full Recipe detail with steps. Returns 403 if the recipe is owned by someone else./recipe/steps/:id?prefetch=true
  • GETReturn full Recipe detail. Returns 403 if the recipe is owned by someone else./recipe/:id?prefetch=true
  • DELETEDelete a Recipe (you must be authenticated as an owner of the recipe)/recipe/:id
  • GETZaps the recipe./recipe/:id/zap
  • POSTFeedback on a Recipe -- for internal BigOven editors/recipe/:recipeId/feedback
  • GETGet recipes related to the given recipeId/recipe/:recipeId/related?pg=0&rpp=0
  • 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/recipes?any_kw=string&folder=string&coll=0&filter=string&title_kw=string&userId=0&username=string&token=string&photos=true&boostmine=true&include_cat=string&exclude_cat=string&include_primarycat=string&exclude_primarycat=string&include_ing=string&exclude_ing=string&cuisine=string&db=string&userset=string&servingsMin=0.0&totalMins=0&maxIngredients=0&minIngredients=0&rpp=0&pg=0&vtn=0&vgn=0&chs=0&glf=0&ntf=0&dyf=0&sff=0&slf=0&tnf=0&wmf=0&rmf=0&cps=0&champion=0&synonyms=true
  • GETGet a random, home-page-quality Recipe./recipes/random
  • GETGet the recipe/comment tuples for those recipes with 4 or 5 star ratings/recipes/raves?pg=0&rpp=0
  • GETGet a list of recipes that the authenticated user has most recently viewed/recipes/recentviews?pg=0&rpp=0
  • 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/recipes/top25random?any_kw=string&folder=string&coll=0&filter=string&title_kw=string&userId=0&username=string&token=string&photos=true&boostmine=true&include_cat=string&exclude_cat=string&include_primarycat=string&exclude_primarycat=string&include_ing=string&exclude_ing=string&cuisine=string&db=string&userset=string&servingsMin=0.0&totalMins=0&maxIngredients=0&minIngredients=0&vtn=0&vgn=0&chs=0&glf=0&ntf=0&dyf=0&sff=0&slf=0&tnf=0&wmf=0&rmf=0&cps=0&champion=0&synonyms=true
  • GETSame as GET recipe but also includes the recipe videos (if any)/recipes/:id?prefetch=true

Review

  • PUTUpdate (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply./recipe/review/replies/:replyId
  • DELETEDELETE a reply to a given review. Authenticated user must be the one who originally posted the reply./recipe/review/replies/:replyId
  • GETGet 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 recent one for that rating./recipe/review/:reviewId
  • PUTUpdate a given top-level review./recipe/review/:reviewId
  • GETGet a paged list of replies for a given review./recipe/review/:reviewId/replies?pg=0&rpp=0
  • POSTPOST 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./recipe/review/:reviewId/replies
  • GETGet *my* review for the recipe {recipeId}, where "me" is determined by standard authentication headers/recipe/:recipeId/review
  • POSTAdd a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated./recipe/:recipeId/review
  • GETGet 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 also supporting more of a "Google Play" style model for Reviews and Replies. That is, there are top-level Reviews and then an unlimited list of replies (which do not carry star ratings) underneath existing reviews. Also, a given user can only have one review per recipe. Existing legacy endpoints will continue to work, but we strongly recommend you migrate to using the newer endpoints listed which do NOT carry the "DEPRECATED" flag./recipe/:recipeId/review/:reviewId
  • PUTHTTP 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./recipe/:recipeId/review/:reviewId
  • DELETEDEPRECATED! - Deletes a review by recipeId and reviewId. Please use recipe/review/{reviewId} instead./recipe/:recipeId/review/:reviewId
  • GETGet paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount./recipe/:recipeId/reviews?pg=0&rpp=0

Note

  • POSTHTTP POST a new note into the system./recipe/:recipeId/note
  • GETGet a given note. Make sure you're passing authentication information in the header for the user who owns the note./recipe/:recipeId/note/:noteId
  • PUTHTTP PUT (update) a Recipe note (RecipeNote)./recipe/:recipeId/note/:noteId
  • DELETEDelete a review do a DELETE Http request of /note/{ID}/recipe/:recipeId/note/:noteId
  • GETrecipe/100/notes/recipe/:recipeId/notes?pg=0&rpp=0

API details

Base URL
https://api2.bigoven.com
Authentication
An API key in the X-BigOven-API-Key header
HTTP Basic authentication (username and password)
Operations
66 operations on 53 pathsGET 33POST 17PUT 10DELETE 6
Main resources
Recipe 23Review 12GroceryList 10Me 7Images 6Note 5Collection 3
Response formats
application/json application/xml text/json
Description format
OpenAPI 3.0.0, API version partner
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the 1,000,000+ Recipe and Grocery List API (v2) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the 1,000,000+ Recipe and Grocery List API (v2) collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-BigOven-API-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Gets a recipe collection. A recipe collection is a curated set of recipes.” (GET /collection/:id?rpp=0&pg=0&test=true&sessionForLogging=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the 1,000,000+ Recipe and Grocery List API (v2)?

Documentation This is the documentation for the partner endpoint of the BigOven Recipe and Grocery List API. The update brings with it Swagger-based… It is listed under Other and has 66 endpoints.

Who publishes the 1,000,000+ Recipe and Grocery List API (v2)?

It is listed from Bigoven's public API description (an OpenAPI document), not published by Bigoven on Swastik Codes. Anyone who controls bigoven.com can claim the profile by adding a DNS TXT record.

What is the base URL of the 1,000,000+ Recipe and Grocery List API (v2)?

Requests go to https://api2.bigoven.com. Endpoint paths are added to this base URL.

How do I authenticate with the 1,000,000+ Recipe and Grocery List API (v2)?

It accepts 2 methods: an API key in the X-BigOven-API-Key header; HTTP Basic authentication (username and password).

How many endpoints does the 1,000,000+ Recipe and Grocery List API (v2) have?

66 operations on 53 paths (33 GET, 17 POST, 10 PUT, 6 DELETE). The largest groups are Recipe, Review, GroceryList, Me.

Is forking the 1,000,000+ Recipe and Grocery List API (v2) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.