643 matches
59 actions
1,000,000+ Recipe and Grocery List API (v2)
59 actions
- /grocerylist/item/{guid} DELETE will delete this item assuming you own it.DELETEv1.0.0
- Add a new recipePOSTv1.0.0
- Add a new review. Only one review can be provided per {userId, recipeId} pair. Otherwise your review will be updated.POSTv1.0.0
- 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 "pending" (unconfirmed by user) state.POSTv1.0.0
- Add a single line item to the grocery listPOSTv1.0.0
- Add a single line item to the grocery listPOSTv1.0.0
- Automatics the complete all recipes.GETv1.0.0
- Automatics the complete my recipes.GETv1.0.0
- Clears the checked lines.POSTv1.0.0
- Delete a Recipe (you must be authenticated as an owner of the recipe)DELETEv1.0.0
- DELETE a reply to a given review. Authenticated user must be the one who originally posted the reply.DELETEv1.0.0
- Delete a review do a DELETE Http request of /note/{ID}DELETEv1.0.0
- Delete all the items on a grocery list; faster operation than a sync with deleted items.DELETEv1.0.0
- Departmentalize a list of strings -- used for ad-hoc grocery list item additionPOSTv1.0.0
- Feedback on a Recipe -- for internal BigOven editorsPOSTv1.0.0
- Get *my* review for the recipe {recipeId}, where "me" is determined by standard authentication headersGETv1.0.0
- Get a given note. Make sure you're passing authentication information in the header for the user who owns the note.GETv1.0.0
- 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 recent one for that rating.GETv1.0.0
- Get a list of recipe categories (the ID field can be used for include_cat in search parameters)GETv1.0.0
- Get a list of recipes that the authenticated user has most recently viewedGETv1.0.0
- Get a paged list of replies for a given review.GETv1.0.0
- Get a random, home-page-quality Recipe.GETv1.0.0
- Get all the photos for a recipeGETv1.0.0
- Get paged list of reviews for a recipe. Each review will have at most one FeaturedReply, as well as a ReplyCount.GETv1.0.0
- Get recipes related to the given recipeIdGETv1.0.0
- Get the list of current, seasonal recipe collections. From here, you can use the /collection/{id} endpoint to retrieve the recipes in those collections.GETv1.0.0
- Get the recipe/comment tuples for those recipes with 4 or 5 star ratingsGETv1.0.0
- Get the user's grocery list. User is determined by Basic Authentication.GETv1.0.0
- Gets a list of RecipeScan images for the recipe. There will be at most 3 per recipe.GETv1.0.0
- Gets a recipe collection metadata. A recipe collection is a curated set of recipes.GETv1.0.0
- Gets a recipe collection. A recipe collection is a curated set of recipes.GETv1.0.0
- Gets recipe single step as textPOSTv1.0.0
- Gets the options.GETv1.0.0
- Gets the pending by user.GETv1.0.0
- Given a query, return recipe titles starting with query. Query must be at least 3 chars in length.GETv1.0.0
- HTTP POST a new note into the system.POSTv1.0.0
- Indexes this instance.GETv1.0.0
- 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.POSTv1.0.0
- 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 thumbnailPOSTv1.0.0
- Puts me personal.PUTv1.0.0
- Puts me preferences.PUTv1.0.0
- Puts me.PUTv1.0.0
- Puts me.PUTv1.0.0
- recipe/100/notesGETv1.0.0
- Return full Recipe detail with steps. Returns 403 if the recipe is owned by someone else.GETv1.0.0
- Return full Recipe detail. Returns 403 if the recipe is owned by someone else.GETv1.0.0
- Returns last active recipe for the userGETv1.0.0
- Returns stored step number and number of steps in recipePOSTv1.0.0
- Same as GET recipe but also includes the recipe videos (if any)GETv1.0.0
- 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 CollectionGETv1.0.0
- 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 CollectionGETv1.0.0
- Skinnies this instance.GETv1.0.0
- Stores recipe step number and returns saved step dataPOSTv1.0.0
- Synchronize the grocery list. Call this with a POST to /grocerylist/syncPOSTv1.0.0
- Update (PUT) a reply to a given review. Authenticated user must be the original one that posted the reply.PUTv1.0.0
- Update a given top-level review.PUTv1.0.0
- Update a grocery item by GUIDPUTv1.0.0
- Update a recipePUTv1.0.0
- Zaps the recipe.GETv1.0.0
Other/1,000,000+ Recipe and Grocery List API (v2)
Same as GET recipe but also includes the recipe videos (if any)
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32"
},
"prefetch": {
"type": "boolean"
}
},
"required": [
"id"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
- 233
- 234
- 235
- 236
- 237
- 238
- 239
- 240
- 241
- 242
- 243
- 244
- 245
- 246
- 247
- 248
- 249
- 250
- 251
- 252
- 253
- 254
- 255
- 256
- 257
- 258
- 259
- 260
- 261
- 262
- 263
- 264
- 265
- 266
- 267
- 268
- 269
- 270
- 271
- 272
- 273
- 274
- 275
- 276
- 277
- 278
- 279
- 280
- 281
- 282
- 283
- 284
- 285
- 286
- 287
- 288
- 289
- 290
- 291
- 292
- 293
- 294
- 295
- 296
- 297
- 298
- 299
- 300
- 301
- 302
- 303
- 304
- 305
- 306
- 307
- 308
- 309
- 310
- 311
- 312
- 313
- 314
- 315
- 316
- 317
- 318
- 319
- 320
- 321
- 322
- 323
- 324
- 325
- 326
- 327
- 328
- 329
- 330
- 331
- 332
- 333
- 334
- 335
- 336
- 337
- 338
- 339
- 340
- 341
- 342
- 343
- 344
- 345
- 346
- 347
- 348
- 349
- 350
- 351
- 352
- 353
- 354
- 355
- 356
- 357
- 358
- 359
- 360
- 361
- 362
- 363
- 364
- 365
- 366
- 367
- 368
- 369
- 370
- 371
- 372
- 373
- 374
- 375
- 376
- 377
- 378
- 379
- 380
- 381
- 382
- 383
- 384
- 385
- 386
- 387
- 388
- 389
- 390
- 391
- 392
- 393
- 394
- 395
- 396
- 397
- 398
- 399
- 400
- 401
- 402
- 403
- 404
- 405
- 406
- 407
- 408
- 409
- 410
- 411
- 412
{
"type": "object",
"description": "DTO used to return a recipe with videos",
"properties": {
"ActiveMinutes": {
"type": "integer",
"format": "int32"
},
"AdTags": {
"type": "string"
},
"AdminBoost": {
"type": "integer",
"format": "int32"
},
"AllCategoriesText": {
"type": "string"
},
"BookmarkImageURL": {
"type": "string"
},
"BookmarkSiteLogo": {
"type": "string"
},
"BookmarkURL": {
"type": "string"
},
"Category": {
"type": "string"
},
"Collection": {
"type": "string"
},
"CollectionID": {
"type": "integer",
"format": "int32"
},
"CreationDate": {
"type": "string",
"format": "date-time"
},
"Cuisine": {
"type": "string"
},
"Description": {
"type": "string"
},
"FavoriteCount": {
"type": "integer",
"format": "int32"
},
"ImageSquares": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"ImageURL": {
"type": "string"
},
"Ingredients": {
"type": "array",
"items": {
"type": "object",
"properties": {
"DisplayIndex": {
"type": "integer",
"format": "int32"
},
"DisplayQuantity": {
"type": "string"
},
"HTMLName": {
"type": "string"
},
"IngredientID": {
"type": "integer",
"format": "int64"
},
"IngredientInfo": {
"type": "object",
"properties": {
"Department": {
"type": "string"
},
"MasterIngredientID": {
"type": "integer",
"format": "int32"
},
"Name": {
"type": "string"
},
"UsuallyOnHand": {
"type": "boolean"
}
}
},
"IsHeading": {
"type": "boolean"
},
"IsLinked": {
"type": "boolean"
},
"MetricDisplayQuantity": {
"type": "string"
},
"MetricQuantity": {
"type": "number",
"format": "double"
},
"MetricUnit": {
"type": "string"
},
"Name": {
"type": "string"
},
"PreparationNotes": {
"type": "string"
},
"Quantity": {
"type": "number",
"format": "double"
},
"Unit": {
"type": "string"
}
}
}
},
"IngredientsTextBlock": {
"type": "string"
},
"Instructions": {
"type": "string"
},
"IsBookmark": {
"type": "boolean"
},
"IsPrivate": {
"type": "boolean"
},
"IsRecipeScan": {
"type": "boolean"
},
"IsSponsored": {
"type": "boolean"
},
"LastModified": {
"type": "string",
"format": "date-time"
},
"MaxImageSquare": {
"type": "integer",
"format": "int32"
},
"MedalCount": {
"type": "integer",
"format": "int32"
},
"MenuCount": {
"type": "integer",
"format": "int32"
},
"Microcategory": {
"type": "string"
},
"NotesCount": {
"type": "integer",
"format": "int32"
},
"NutritionInfo": {
"type": "object",
"properties": {
"CaloriesFromFat": {
"type": "number",
"format": "double"
},
"Cholesterol": {
"type": "number",
"format": "double"
},
"CholesterolPct": {
"type": "number",
"format": "double"
},
"DietaryFiber": {
"type": "number",
"format": "double"
},
"DietaryFiberPct": {
"type": "number",
"format": "double"
},
"MonoFat": {
"type": "number",
"format": "double"
},
"PolyFat": {
"type": "number",
"format": "double"
},
"Potassium": {
"type": "number",
"format": "double"
},
"PotassiumPct": {
"type": "number",
"format": "double"
},
"Protein": {
"type": "number",
"format": "double"
},
"ProteinPct": {
"type": "number",
"format": "double"
},
"SatFat": {
"type": "number",
"format": "double"
},
"SatFatPct": {
"type": "number",
"format": "double"
},
"SingularYieldUnit": {
"type": "string"
},
"Sodium": {
"type": "number",
"format": "double"
},
"SodiumPct": {
"type": "number",
"format": "double"
},
"Sugar": {
"type": "number",
"format": "double"
},
"TotalCalories": {
"type": "number",
"format": "double"
},
"TotalCarbs": {
"type": "number",
"format": "double"
},
"TotalCarbsPct": {
"type": "number",
"format": "double"
},
"TotalFat": {
"type": "number",
"format": "double"
},
"TotalFatPct": {
"type": "number",
"format": "double"
},
"TransFat": {
"type": "number",
"format": "double"
}
}
},
"PhotoUrl": {
"type": "string"
},
"Poster": {
"type": "object",
"properties": {
"FirstName": {
"type": "string"
},
"ImageUrl48": {
"type": "string"
},
"IsKitchenHelper": {
"type": "boolean"
},
"IsPremium": {
"type": "boolean"
},
"IsUsingRecurly": {
"type": "boolean"
},
"LastName": {
"type": "string"
},
"MemberSince": {
"type": "string",
"format": "date-time"
},
"PhotoUrl": {
"type": "string"
},
"PhotoUrl48": {
"type": "string"
},
"PremiumExpiryDate": {
"type": "string",
"format": "date-time"
},
"UserID": {
"type": "integer",
"format": "int32"
},
"UserName": {
"type": "string"
},
"WebUrl": {
"type": "string"
}
}
},
"PrimaryIngredient": {
"type": "string"
},
"RecipeID": {
"type": "integer",
"format": "int32"
},
"ReviewCount": {
"type": "integer",
"format": "int32"
},
"StarRating": {
"type": "number",
"format": "double"
},
"Steps": {
"type": "array",
"items": {
"type": "object",
"properties": {
"EndGantt": {
"type": "integer",
"format": "int32"
},
"StartGantt": {
"type": "integer",
"format": "int32"
},
"Text": {
"type": "string"
}
}
}
},
"Subcategory": {
"type": "string"
},
"Title": {
"type": "string"
},
"TotalMinutes": {
"type": "integer",
"format": "int32"
},
"VariantOfRecipeID": {
"type": "integer",
"format": "int32"
},
"VerifiedByClass": {
"type": "string"
},
"VerifiedDateTime": {
"type": "string",
"format": "date-time"
},
"Videos": {
"type": "array",
"description": "Gets or sets the recipe videos, i.e. a list of type {API2.Models.Recipes.RecipeVideoResponse}",
"items": {
"type": "object",
"description": "DTO used to return the details of a recipe video",
"properties": {
"InsertedOn": {
"type": "string",
"format": "date-time",
"description": "Gets or sets the date the video was added."
},
"IsPrimaryVideo": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the video is the primary video of the recipe."
},
"MediaId": {
"type": "string",
"description": "Gets or sets the JWPlayer media id."
},
"VidId": {
"type": "integer",
"format": "int32",
"description": "Gets or sets the video id."
}
}
}
},
"WebURL": {
"type": "string"
},
"YieldNumber": {
"type": "number",
"format": "double"
},
"YieldUnit": {
"type": "string"
}
}
}