We plan to continue to support the legacy version of the API well into 2017 (and later if you let us know), but we do recommend all developers migrate to the new api2 format as your development cycle allows. We strongly recommend that all new recipe and grocery API developers begin with https://api2.bigoven.com
API OVERVIEW
AUTHENTICATION
API PROTOCOL
API DATA
DATA MANAGEMENT
BRANDING, LEGAL & FINANCIAL
Recipes
The Recipe object refers to a recipe within the BigOven collection. The following methods are supported for the Recipe object.
Like all calls, you need to append ?api_key={your api key issued to you by BigOven} to your call.
CREATE | READ | UPDATE | DELETE | |
Recipe | No | Yes | No | No |
Creating a Recipe (HTTP POST)
This method is not supported at this time.
Reading a Recipe (HTTP GET)
GET https://api.bigoven.com/recipe/{id}
Parameter | Description | Required? |
id | Primary key(ID) of recipe. | Yes |
Updating a Recipe (HTTP PUT)
This method is not supported at this time.
Deleting a Recipe (HTTP DELETE)
This method is not supported at this time.
Example
Here's a sample call to /recipe?rid=530115. JSON format is shown. Be sure to set "Accept" and "Content-Type" headers in your request to "application/json", otherwise you'll get back XML.
{ "RecipeID": 530115, "Title": "Teriyaki Chicken", "Description": "Great basic Chicken Teriyaki recipe. Why use the bottled stuff when the make-it-yourself marinade is easy and so much tastier?", "Cuisine": "Japanese", "Category": "Main Dish", "Subcategory": "Grill and BBQ", "PrimaryIngredient": "Chicken", "StarRating": 4.6, "WebURL": "https://www.bigoven.com/recipe/teriyaki-chicken/530115", "ImageURL": "https://redirect.bigoven.com/pics/rs/640/chicken-teriyaki-10.jpg", "ReviewCount": 5, "MedalCount": 0, "FavoriteCount": 568, "Poster": { "UserID": 29, "UserName": "stevemur", "ImageURL48": "https://bigoven-res.cloudinary.com/image/upload/f_auto,q_auto/t_recipe-48,d_avatar-default.png/uchantyakshfoptvjvrz", "PhotoUrl": "https://photos.bigoven.com/avatar/uchantyakshfoptvjvrz", "IsPremium": true, "IsKitchenHelper": true, "PremiumExpiryDate": "\\/Date(1480444911497)\\/", "MemberSince": "\\/Date(1074527940000)\\/", "IsUsingRecurly": true }, "Ingredients": [ { "IngredientID": 5247317, "DisplayIndex": 0, "IsHeading": false, "Name": "Soy Sauce", "HTMLName": "Soy Sauce", "Quantity": 0.333333333333333, "DisplayQuantity": "1/3", "Unit": "cup", "MetricQuantity": 79, "MetricDisplayQuantity": "79", "MetricUnit": "ml", "PreparationNotes": null, "IngredientInfo": { "Name": "Soy Sauce", "Department": "Asian" }, "IsLinked": true }, { "IngredientID": 5247318, "DisplayIndex": 1, "IsHeading": false, "Name": "Dry sherry", "HTMLName": "Dry sherry", "Quantity": 0.25, "DisplayQuantity": "1/4", "Unit": "cup", "MetricQuantity": 59, "MetricDisplayQuantity": "59", "MetricUnit": "ml", "PreparationNotes": null, "IngredientInfo": { "Name": "Dry sherry", "Department": "Wines" }, "IsLinked": true }, { "IngredientID": 5247319, "DisplayIndex": 2, "IsHeading": false, "Name": "Vegetable Oil", "HTMLName": "Vegetable Oil", "Quantity": 0.333333333333333, "DisplayQuantity": "1/3", "Unit": "cup", "MetricQuantity": 79, "MetricDisplayQuantity": "79", "MetricUnit": "ml", "PreparationNotes": null, "IngredientInfo": { "Name": "Vegetable Oil", "Department": "Oils" }, "IsLinked": true }, { "IngredientID": 5247320, "DisplayIndex": 3, "IsHeading": false, "Name": "Brown Sugar", "HTMLName": "Brown Sugar", "Quantity": 1.5, "DisplayQuantity": "1 1/2", "Unit": "tablespoons", "MetricQuantity": 22, "MetricDisplayQuantity": "22", "MetricUnit": "ml", "PreparationNotes": null, "IngredientInfo": { "Name": "Brown Sugar", "Department": "Baking" }, "IsLinked": true }, { "IngredientID": 5247321, "DisplayIndex": 4, "IsHeading": false, "Name": "Fresh Ginger", "HTMLName": "Fresh Ginger", "Quantity": 1, "DisplayQuantity": "1", "Unit": "tablespoon", "MetricQuantity": 15, "MetricDisplayQuantity": "15", "MetricUnit": "ml", "PreparationNotes": "grated", "IngredientInfo": { "Name": "Fresh Ginger", "Department": "Produce" }, "IsLinked": true }, { "IngredientID": 5247322, "DisplayIndex": 5, "IsHeading": false, "Name": "boneless chicken breast halves", "HTMLName": "boneless chicken breast halves", "Quantity": 4, "DisplayQuantity": "4", "Unit": null, "MetricQuantity": 4, "MetricDisplayQuantity": "4", "MetricUnit": "", "PreparationNotes": "trimmed of fat", "IngredientInfo": { "Name": "boneless chicken breast halves", "Department": "Poultry" }, "IsLinked": true }, { "IngredientID": 5247323, "DisplayIndex": 6, "IsHeading": true, "Name": "Optional garnish", "HTMLName": "", "Quantity": 1, "DisplayQuantity": null, "Unit": null, "MetricQuantity": 0, "MetricDisplayQuantity": "", "MetricUnit": "", "PreparationNotes": null, "IngredientInfo": null, "IsLinked": false }, { "IngredientID": 5247324, "DisplayIndex": 7, "IsHeading": false, "Name": "Sesame seeds", "HTMLName": "Sesame seeds", "Quantity": 1, "DisplayQuantity": null, "Unit": null, "MetricQuantity": 0, "MetricDisplayQuantity": "", "MetricUnit": "", "PreparationNotes": null, "IngredientInfo": { "Name": "Sesame seeds", "Department": "Spices" }, "IsLinked": true }, { "IngredientID": 5247325, "DisplayIndex": 8, "IsHeading": false, "Name": "Scallions", "HTMLName": "Scallions", "Quantity": 1, "DisplayQuantity": null, "Unit": null, "MetricQuantity": 0, "MetricDisplayQuantity": "", "MetricUnit": "", "PreparationNotes": null, "IngredientInfo": { "Name": "Scallions", "Department": "Produce" }, "IsLinked": true } ], "Instructions": "Prepare marinade:\\\r\\\n\\\r\\\nMix soy sauce, dry sherry, vegetable oil, brown sugar and ginger. Whisk to incorporate. \\\r\\\n\\\r\\\nAdd to plastic ziptop bag with chicken breasts. Gently press to remove air, and place in a bowl in the fridge for at least 2 hours, up to 6. \\\r\\\n\\\r\\\nTurn on grill to medium heat. Oil grill. Place chicken breasts on grill, and let cook for 2 minutes. Then turn 90 degrees. Cook for 2 more minutes and flip. Cook for 2 more minutes. Turn 90 degrees. Check for doneness, remove from grill when done. Let rest on cutting board for 2 minutes. Slice on bias and serve atop white rice. Sprinkle with sesame seeds and or grilled scallions to garnish. ", "YieldNumber": 4, "YieldUnit": "Servings", "TotalMinutes": 180, "ActiveMinutes": 20, "NutritionInfo": { "SingularYieldUnit": "1 Serving (466g)", "TotalCalories": 528, "TotalFat": 23.316175517769967, "CaloriesFromFat": 210, "TotalFatPct": 0.3108823402369329, "SatFat": 3.3890373011313577, "SatFatPct": 0.1694518650565679, "MonoFat": 14.082038863021811, "PolyFat": 4.383178452679457, "TransFat": 1.4619209009373422, "Cholesterol": 55.68, "CholesterolPct": 0.1713230769230769, "Sodium": 18999.911704439695, "SodiumPct": 6.5516936911861015, "Potassium": 968.8308271141401, "PotassiumPct": 0.2549554808195105, "TotalCarbs": 38.39837382837061, "TotalCarbsPct": 0.11293639361285474, "DietaryFiber": 3.0802700533532446, "DietaryFiberPct": 0.12321080213412978, "Sugar": 35.31810377501736, "Protein": 39.84860956070838, "ProteinPct": 0.5692658508672626 }, "IsPrivate": false, "CreationDate": "\\/Date(1369489301000)\\/", "LastModified": "\\/Date(1429035195983)\\/", "IsBookmark": false, "BookmarkURL": null, "BookmarkSiteLogo": "", "BookmarkImageURL": null, "IsRecipeScan": null, "MenuCount": 4, "NotesCount": 4, "AdTags": "simplypotatoes15", "IngredientsTextBlock": null, "AllCategoriesText": "collsxgrillm", "IsSponsored": false, "VariantOfRecipeID": null, "Collection": "collsxgrillm", "AdminBoost": 100, "VerifiedDateTime": "\\/Date(1369507313000)\\/", "MaxImageSquare": null, "ImageSquares": [], "HeroPhotoUrl": "https://photos.bigoven.com/recipe/hero/chicken-teriyaki-10.jpg", "VerifiedByClass": "editor" }