-
Notifications
You must be signed in to change notification settings - Fork 3
API Reference
Recipeify - Your intelligent and personalized recipe one-stop-shop, allowing you to find your next cooked meal quicker
Explore returns boxes with recipes ideas based on the time of day, time of year and more.
POST /
| Name | Type | Description |
|---|---|---|
| dateString | String |
value of Date().toString() |
| size | Int |
number of boxes. |
| amount | Int |
number of recipes in a box. |
Example usage:
https://recipeify.com/api/explore| Name | Type | Description |
|---|---|---|
| explore | Object[] |
List of recipes boxes. |
| mealByTime | Object[] |
Json of recipes for the next meal of the day. |
| personal | Object[] |
Json of recipes, recommended personally for the user. |
| popoular | Object[] |
Json of recipes, recommended by trending recipes. |
HTTP/1.1 200 OK
{explore: [{type: "seasonal ingredient", name: "mackerel",…}, {type: "try making", name: "pasta",…},…]
mealByTime: {name: "Good night! here are some night snack recipes",…}
personal: [{id: "tasty-5752", title: "3-Hour Pizza Recipe by Tasty",…},…]
popular: [{id: "tasty-5752", title: "3-Hour Pizza Recipe by Tasty",…},…]
}| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Request for personal recommendation page
Authentication needed
POST /personal
| Name | Type | Description |
|---|---|---|
| count | Int |
number of recipes. |
Example usage:
https://recipeify.com/api/recommend/personalHTTP/1.1 200 OK
{id: "tasty-5752", title: "3-Hour Pizza Recipe by Tasty",…}| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 403 forbidden |
Request for popular recommendation page - returns trending recipes.
POST /popular
| Name | Type | Description |
|---|---|---|
| count | Int |
number of recipes. |
Example usage:
https://recipeify.com/api/recommend/popularHTTP/1.1 200 OK
{id: "tasty-5752", title: "3-Hour Pizza Recipe by Tasty",…}Search for recipes.
POST /recipes
| Name | Type | Description |
|---|---|---|
| freeText | String |
Free text search. |
| includeTerms | Object[] |
Terms to include in the search. |
| excludeTerms | Object[] |
Terms to exclude in the search. |
| diet | Object[] |
Dietary preferences. |
| cuisine | Object[] |
Cuisine type search. |
| dishType | Object[] |
Dish type search. |
| fromCookTime | Int |
Minimal cooking time. |
| toCookTime | Int |
Maximal cooking time. |
| size | Int |
Number of recipes. |
Example usage:
https://recipeify.com/api/search/recipesHTTP/1.1 200 OK
{total: {value: 1398, relation: "eq"},
items: [{id: "bonappetit-57afb95df1c801a1038bd392", title: "Squashducken",…},…]
}| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Search for recipes by ids.
POST /ids
| Name | Type | Description |
|---|---|---|
| ids | Object[] |
List of ids to search. |
Example usage:
https://recipeify.com/api/search/idsHTTP/1.1 200 OK
{items: {...}}| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Request for users preferences.
Authentication needed
GET /preferences
Example usage:
https://recipeify.com/api/users/preferences| Name | Type | Description |
|---|---|---|
| excludeTerms | Object[] |
List of terms to exclude from recipes. |
| diet | Object[] |
List of dietary preferences. |
Edit the users preferences.
Authentication needed
POST /preferences
| Name | Type | Description |
|---|---|---|
| excludeTerms | Object[] |
List of terms to exclude from recipes. |
| diet | Object[] |
List of dietary preferences. |
Example usage:
https://recipeify.com/api/users/preferences| Name | Type | Description |
|---|---|---|
| excludeTerms | Object[] |
List of terms to exclude from recipes. |
| diet | Object[] |
List of dietary preferences. |
Success response example - Success-Response: Upon success, the previous information about the user is sent back:
HTTP/1.1 200 OK
{"excludeTerms":[],"diet":["healthy"],"recipes":[],"_id":"auth0|***************","__v":0}| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Get users saved recipes.
Authentication needed
GET /get_recipes
Example usage:
https://recipeify.com/api/users/get_recipes| Name | Type | Description |
|---|---|---|
| items | Object[] |
List of saved recipes. |
HTTP/1.1 200 OK
{items: [{id: "budgetbytes-13214", title: "Broccoli Fettuccine Alfredo",…}]}Get users saved recipes.
Authentication needed
GET /get_recipes_ids
Example usage:
https://recipeify.com/api/users/get_recipes_ids| Name | Type | Description |
|---|---|---|
| recipes | Object[] |
List of saved recipes. |
HTTP/1.1 200 OK
{"recipes":{"recipes":["budgetbytes-13214","epicurious-564e203865f5621c7a182195","epicurious-54a4233e6529d92b2c009929"],"_id":"auth0|**************"}}Add recipes to users saved recipes.
Authentication needed
POST /add_recipes
| Name | Type | Description |
|---|---|---|
| recipes | Object[] |
List of recipes to add. {recipes: ["bbcgoodfood-6571451"]} |
Example usage:
https://recipeify.com/api/users/add_recipesHTTP/1.1 200 OK| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Remove recipes from users saved recipes.
Authentication needed
POST /remove_recipes
| Name | Type | Description |
|---|---|---|
| recipes | Object[] |
List of recipes to remove. {recipes: ["bbcgoodfood-6571451"]} |
Example usage:
https://recipeify.com/api/users/remove_recipesHTTP/1.1 200 OK| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Add recipes to recently viewed list.
Authentication needed
POST /recipes_viewed
| Name | Type | Description |
|---|---|---|
| recipes | Object[] |
List of recipes to add. {recipes: ["bbcgoodfood-6571451"]} |
Example usage:
https://recipeify.com/api/users/recipes_viewedHTTP/1.1 200 OK| Name | Type | Description |
|---|---|---|
| HTTP/1.1 | 400 Bad Request |
Add recipes to recently viewed list.
Authentication needed
POST /recently_viewed
| Name | Type | Description |
|---|---|---|
| count | Int |
number of recipes. |
Example usage:
https://recipeify.com/api/users/recently_viewedHTTP/1.1 200 OK
{recipes: ["bbcgoodfood-6571451"]}