README
API Documentation
GET /search
Search for recipes that match provided criterions.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| name | query | string | false | Search terms to be appeared in the recipe name. |
| tags | query | string | false | Semicolon separated tags, e.g., vegetarian, keto, peanut-free, etc. |
| includeIngredients | query | string | false | Semicolon separated terms to be included in ingredients. |
| excludeIngredients | query | string | false | Semicolon separated terms to be excluded in ingredients. |
| maxPrepareTime | query | integer | false | Maximum preparation time in minutes. |
| maxCookTime | query | integer | false | Maximum cook time in minutes. |
| maxCalories | query | integer | false | Maximum calories of 1 serving in KCal. |
| maxNetCarbs | query | integer | false | Maximum net carbs (total carbs subtract fiber and sugar alcohols) of 1 serving in grams. |
| maxSugar | query | integer | false | Maximum sugar of 1 serving in grams. |
| maxAddedSugar | query | integer | false | Maximum added sugar of 1 serving in grams. |
| limit | query | integer | false | Maximum number of results. |
Example responses
[
{
"id": "2807982c-986a-4def-9e3a-153a3066af7a",
"name": "Ultimate Keto Blueberry Sponge Cake In A Mug",
"tags": [
"15-minute-meals",
"beef-free",
"breakfast",
"chicken-free",
"dairy-free",
...
],
"description": "Instead of making pancakes or waffles, make this easy Keto breakfast recipe that takes way less time to make. This blueberry sponge cake in a mug is soft and fluffy like a pancake but sweet like a cake...",
"prepareTime": 3,
"cookTime": 2,
"ingredients": [
{
"name": "Butter",
"servingSize": {
"units": "tablespoon",
"desc": "1 tablespoon",
"qty": 1,
"grams": 14,
"scale": 1
}
},
...
],
"steps": [
"Combine the butter and cream cheese together in a heat-safe container. Microwave the ingredients on high heat for 20 seconds until they’re melted. Stir the butter and cream cheese together into one mixture.",
...
],
"servings": 2,
"servingSizes": [
{
"scale": 1,
"qty": 1,
"grams": 100,
"units": "servings",
"originalWeight": 100,
"originalWeightUnits": "g"
}
],
"nutrients": {
"caloriesKCal": 185.437,
"caloriesKJ": 763.317,
"totalCarbs": 12.83,
...
},
"image": "https://tinyurl.com/2p82zzca/2807982c-986a-4def-9e3a-153a3066af7a.png"
}
]
GET /recipes/{recipeId}
Get details of the specified recipe.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| recipeId | path | string | true | Recipe ID. |
Example responses
{
"id": "2807982c-986a-4def-9e3a-153a3066af7a",
"name": "Ultimate Keto Blueberry Sponge Cake In A Mug",
"tags": [
"15-minute-meals",
"beef-free",
"breakfast",
"chicken-free",
"dairy-free",
...
],
"description": "Instead of making pancakes or waffles, make this easy Keto breakfast recipe that takes way less time to make. This blueberry sponge cake in a mug is soft and fluffy like a pancake but sweet like a cake...",
"prepareTime": 3,
"cookTime": 2,
"ingredients": [
{
"name": "Butter",
"servingSize": {
"units": "tablespoon",
"desc": "1 tablespoon",
"qty": 1,
"grams": 14,
"scale": 1
}
},
...
],
"steps": [
"Combine the butter and cream cheese together in a heat-safe container. Microwave the ingredients on high heat for 20 seconds until they’re melted. Stir the butter and cream cheese together into one mixture.",
...
],
"servings": 2,
"servingSizes": [
{
"scale": 1,
"qty": 1,
"grams": 100,
"units": "servings",
"originalWeight": 100,
"originalWeightUnits": "g"
}
],
"nutrients": {
"caloriesKCal": 185.437,
"caloriesKJ": 763.317,
"totalCarbs": 12.83,
...
},
"image": "https://tinyurl.com/2p82zzca/2807982c-986a-4def-9e3a-153a3066af7a.png"
}
GET /random
Get a random recipe.
Parameters
None.
Example responses
{
"id": "2807982c-986a-4def-9e3a-153a3066af7a",
"name": "Ultimate Keto Blueberry Sponge Cake In A Mug",
"tags": [
"15-minute-meals",
"beef-free",
"breakfast",
"chicken-free",
"dairy-free",
...
],
"description": "Instead of making pancakes or waffles, make this easy Keto breakfast recipe that takes way less time to make. This blueberry sponge cake in a mug is soft and fluffy like a pancake but sweet like a cake...",
"prepareTime": 3,
"cookTime": 2,
"ingredients": [
{
"name": "Butter",
"servingSize": {
"units": "tablespoon",
"desc": "1 tablespoon",
"qty": 1,
"grams": 14,
"scale": 1
}
},
...
],
"steps": [
"Combine the butter and cream cheese together in a heat-safe container. Microwave the ingredients on high heat for 20 seconds until they’re melted. Stir the butter and cream cheese together into one mixture.",
...
],
"servings": 2,
"servingSizes": [
{
"scale": 1,
"qty": 1,
"grams": 100,
"units": "servings",
"originalWeight": 100,
"originalWeightUnits": "g"
}
],
"nutrients": {
"caloriesKCal": 185.437,
"caloriesKJ": 763.317,
"totalCarbs": 12.83,
...
},
"image": "https://tinyurl.com/2p82zzca/2807982c-986a-4def-9e3a-153a3066af7a.png"
}
