500,000+ Recipe and Grocery List API (v2)
  1. Recipe
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.
    • Get the user's grocery list. User is determined by Basic Authentication.
    • Clears the checked lines.
    • Departmentalize a list of strings -- used for ad-hoc grocery list item addition
    • Add a single line item to the grocery list
    • /grocerylist/item/{guid} DELETE will delete this item assuming you own it.
    • Update a grocery item by GUID
    • Add a single line item to the grocery list
    • 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
    • Synchronize the grocery list. Call this with a POST to /grocerylist/sync
  • 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
    • Gets the pending by user.
    • 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
    • Get all the images for a recipe. DEPRECATED. Please use /recipe/{recipeId}/photos.
    • Get all the photos for a recipe
    • Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.
  • Me
    • Indexes this instance.
    • Puts me.
    • Puts me personal.
    • Puts me preferences.
    • Gets the options.
    • Puts me.
    • Skinnies this instance.
  • Recipe
    • Add a new recipe
      POST
    • Update a recipe
      PUT
    • Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.
      GET
    • Automatics the complete all recipes.
      GET
    • Automatics the complete my recipes.
      GET
    • Get a list of recipe categories (the ID field can be used for include_cat in search parameters)
      GET
    • Returns last active recipe for the user
      GET
    • Gets recipe single step as text
      POST
    • Returns stored step number and number of steps in recipe
      POST
    • Stores recipe step number and returns saved step data
      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
      POST
    • Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.
      GET
    • Delete a Recipe (you must be authenticated as an owner of the recipe)
      DELETE
    • Return full Recipe detail. Returns 403 if the recipe is owned by someone else.
      GET
    • Zaps the recipe.
      GET
    • Feedback on a Recipe -- for internal BigOven editors
      POST
    • Get recipes related to the given recipeId
      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 para
      GET
    • Get a random, home-page-quality Recipe.
      GET
    • Get the recipe/comment tuples for those recipes with 4 or 5 star ratings
      GET
    • Get a list of recipes that the authenticated user has most recently viewed
      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 para
      GET
    • Same as GET recipe but also includes the recipe videos (if any)
      GET
  • 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
  1. Recipe

Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.

GET
/recipe/steps/{id}
Recipe
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api2.bigoven.com/recipe/steps/'
Response Response Example
{
    "ActiveMinutes": 0,
    "AdTags": "string",
    "AdminBoost": 0,
    "AllCategoriesText": "string",
    "BookmarkImageURL": "string",
    "BookmarkSiteLogo": "string",
    "BookmarkURL": "string",
    "Category": "string",
    "Collection": "string",
    "CollectionID": 0,
    "CreationDate": "2019-08-24T14:15:22Z",
    "Cuisine": "string",
    "Description": "string",
    "FavoriteCount": 0,
    "ImageSquares": [
        0
    ],
    "ImageURL": "string",
    "Ingredients": [
        {
            "DisplayIndex": 0,
            "DisplayQuantity": "string",
            "HTMLName": "string",
            "IngredientID": 0,
            "IngredientInfo": {
                "Department": "string",
                "MasterIngredientID": 0,
                "Name": "string",
                "UsuallyOnHand": true
            },
            "IsHeading": true,
            "IsLinked": true,
            "MetricDisplayQuantity": "string",
            "MetricQuantity": 0,
            "MetricUnit": "string",
            "Name": "string",
            "PreparationNotes": "string",
            "Quantity": 0,
            "Unit": "string"
        }
    ],
    "IngredientsTextBlock": "string",
    "Instructions": "string",
    "IsBookmark": true,
    "IsPrivate": true,
    "IsRecipeScan": true,
    "IsSponsored": true,
    "LastModified": "2019-08-24T14:15:22Z",
    "MaxImageSquare": 0,
    "MedalCount": 0,
    "MenuCount": 0,
    "Microcategory": "string",
    "NotesCount": 0,
    "NutritionInfo": {
        "CaloriesFromFat": 0,
        "Cholesterol": 0,
        "CholesterolPct": 0,
        "DietaryFiber": 0,
        "DietaryFiberPct": 0,
        "MonoFat": 0,
        "PolyFat": 0,
        "Potassium": 0,
        "PotassiumPct": 0,
        "Protein": 0,
        "ProteinPct": 0,
        "SatFat": 0,
        "SatFatPct": 0,
        "SingularYieldUnit": "string",
        "Sodium": 0,
        "SodiumPct": 0,
        "Sugar": 0,
        "TotalCalories": 0,
        "TotalCarbs": 0,
        "TotalCarbsPct": 0,
        "TotalFat": 0,
        "TotalFatPct": 0,
        "TransFat": 0
    },
    "PhotoUrl": "string",
    "Poster": {
        "FirstName": "string",
        "ImageUrl48": "string",
        "IsKitchenHelper": true,
        "IsPremium": true,
        "IsUsingRecurly": true,
        "LastName": "string",
        "MemberSince": "2019-08-24T14:15:22Z",
        "PhotoUrl": "string",
        "PhotoUrl48": "string",
        "PremiumExpiryDate": "2019-08-24T14:15:22Z",
        "UserID": 0,
        "UserName": "string",
        "WebUrl": "string"
    },
    "PrimaryIngredient": "string",
    "RecipeID": 0,
    "ReviewCount": 0,
    "StarRating": 0,
    "Steps": [
        {
            "EndGantt": 0,
            "StartGantt": 0,
            "Text": "string"
        }
    ],
    "Subcategory": "string",
    "Title": "string",
    "TotalMinutes": 0,
    "VariantOfRecipeID": 0,
    "VerifiedByClass": "string",
    "VerifiedDateTime": "2019-08-24T14:15:22Z",
    "WebURL": "string",
    "YieldNumber": 0,
    "YieldUnit": "string"
}

Request

Path Params
id
integer 
required
the Recipe ID to retrieve
Query Params
prefetch
string 
optional

Responses

🟢200OK
application/json
Body
ActiveMinutes
integer <int32>
optional
AdTags
string 
optional
AdminBoost
integer <int32>
optional
AllCategoriesText
string 
optional
BookmarkImageURL
string 
optional
BookmarkSiteLogo
string 
optional
BookmarkURL
string 
optional
Category
string 
optional
Collection
string 
optional
CollectionID
integer <int32>
optional
CreationDate
string <date-time>
optional
Cuisine
string 
optional
Description
string 
optional
FavoriteCount
integer <int32>
optional
ImageSquares
array[integer <int32>]
optional
ImageURL
string 
optional
Ingredients
array[object (BigOven.Model.API.Ingredient) {14}] 
optional
DisplayIndex
integer <int32>
optional
DisplayQuantity
string 
optional
HTMLName
string 
optional
IngredientID
integer <int64>
optional
IngredientInfo
object (BigOven.Model.API.IngredientInfo) 
optional
IsHeading
boolean 
optional
IsLinked
boolean 
optional
MetricDisplayQuantity
string 
optional
MetricQuantity
number <double>
optional
MetricUnit
string 
optional
Name
string 
optional
PreparationNotes
string 
optional
Quantity
number <double>
optional
Unit
string 
optional
IngredientsTextBlock
string 
optional
Instructions
string 
optional
IsBookmark
boolean 
optional
IsPrivate
boolean 
optional
IsRecipeScan
boolean 
optional
IsSponsored
boolean 
optional
LastModified
string <date-time>
optional
MaxImageSquare
integer <int32>
optional
MedalCount
integer <int32>
optional
MenuCount
integer <int32>
optional
Microcategory
string 
optional
NotesCount
integer <int32>
optional
NutritionInfo
object (BigOven.Model.API.NutritionInfo) 
optional
CaloriesFromFat
number <double>
optional
Cholesterol
number <double>
optional
CholesterolPct
number <double>
optional
DietaryFiber
number <double>
optional
DietaryFiberPct
number <double>
optional
MonoFat
number <double>
optional
PolyFat
number <double>
optional
Potassium
number <double>
optional
PotassiumPct
number <double>
optional
Protein
number <double>
optional
ProteinPct
number <double>
optional
SatFat
number <double>
optional
SatFatPct
number <double>
optional
SingularYieldUnit
string 
optional
Sodium
number <double>
optional
SodiumPct
number <double>
optional
Sugar
number <double>
optional
TotalCalories
number <double>
optional
TotalCarbs
number <double>
optional
TotalCarbsPct
number <double>
optional
TotalFat
number <double>
optional
TotalFatPct
number <double>
optional
TransFat
number <double>
optional
PhotoUrl
string 
optional
Poster
object (BigOven.Model.API.UserInfo) 
optional
FirstName
string 
optional
ImageUrl48
string 
optional
IsKitchenHelper
boolean 
optional
IsPremium
boolean 
optional
IsUsingRecurly
boolean 
optional
LastName
string 
optional
MemberSince
string <date-time>
optional
PhotoUrl
string 
optional
PhotoUrl48
string 
read-onlyoptional
PremiumExpiryDate
string <date-time>
optional
UserID
integer <int32>
optional
UserName
string 
optional
WebUrl
string 
read-onlyoptional
PrimaryIngredient
string 
optional
RecipeID
integer <int32>
optional
ReviewCount
integer <int32>
optional
StarRating
number <double>
optional
Steps
array[object (BigOven.Model.InstructionStep) {3}] 
optional
EndGantt
integer <int32>
optional
StartGantt
integer <int32>
optional
Text
string 
optional
Subcategory
string 
optional
Title
string 
optional
TotalMinutes
integer <int32>
optional
VariantOfRecipeID
integer <int32>
optional
VerifiedByClass
string 
optional
VerifiedDateTime
string <date-time>
optional
WebURL
string 
optional
YieldNumber
number <double>
optional
YieldUnit
string 
optional
Modified at 2023-08-15 06:02:32
Previous
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
Next
Delete a Recipe (you must be authenticated as an owner of the recipe)
Built with