Obtain a Recipe Feed

The Recipe Feed is similar to a Recipe Search but is intended to be more discovery-oriented. While a search may target a specific type of recipe, the feed will return an infinite number of results and can be personalized according to specific user preferences

This section is incomplete and currently a work in progress.

Recipe Feed

GET https://api.whisk.com/feed/v2/get

Path Parameters

Name
Type
Description

Feed Request

object

{
  "feed_id": "string",
  "items": [
    {
      "key": {
        "id": "string"
      },
      "display": {
        "display_name": "string",
        "images": [
          {
            "responsive": {
              "url": "string",
              "width": 0,
              "height": 0
            },
            "url": "string"
          }
        ],
        "tag": {
          "name": "string",
          "display_name": "string",
          "image": {
            "url": "string",
            "width": 0,
            "height": 0
          }
        }
      },
      "content": {
        "recipe": {
          "id": "string",
          "name": "string",
          "description": "string",
          "images": [
            {
              "responsive": {
                "url": "string",
                "width": 0,
                "height": 0
              },
              "url": "string"
            }
          ],
          "videos": [
            {
              "content_url": "string",
              "embed_url": "string",
              "thumbnail": "string"
            }
          ],
          "source": {
            "name": "string",
            "display_name": "string",
            "source_recipe_url": "string",
            "image": {
              "responsive": {
                "url": "string",
                "width": 0,
                "height": 0
              },
              "url": "string"
            },
            "license": "LICENCE_INVALID"
          },
          "saved": {
            "value": true,
            "collection_ids": [
              "string"
            ],
            "owner": true,
            "recipe_type": "RECIPE_TYPE_INVALID"
          },
          "author": {
            "name": "string",
            "image": {
              "responsive": {
                "url": "string",
                "width": 0,
                "height": 0
              },
              "url": "string"
            }
          },
          "custom_labels": [
            {
              "name": "string",
              "labels": [
                {
                  "name": "string"
                }
              ]
            }
          ]
        }
      }
    }
  ],
  "cursor": {
    "cursors": {
      "after": "string",
      "before": "string"
    },
    "total": "string"
  }
}

This endpoint provides a Feed that contains recipes by default and other times of data based on the supplied parameters.

{
  "feed_id": "string",
  "country": "string",
  "language": "string",
  "with_saved_info": true,
  "cursor": {
    ...
  },
  "labels": [
    ...
  ],
  "exclude_ingredients": [
    ...
  ],
  "feed_tags": [
    ...
  ],
  "custom_labels": {
    ...
  }
}

Attribute

Type

Description

feed_id

string

country

string

language

string

with_saved_info

bool

cursor

object

labels

array

exclude_ingredients

array

feed_tags

array

custom_labels

object

Cursor

"cursor": {
  "limit": 0,
  "cursors": {
    "after": "string",
    "before": "string"
  }
},

Labels

"labels": [
  {
    "label": {
      "diet": "DIET_INVALID",
      "category": "CATEGORY_INVALID",
      "avoidance": "AVOIDANCE_INVALID",
      "cuisine": "CUISINE_INVALID",
      "meal_type": "MEAL_TYPE_INVALID",
      "nutrition": "NUTRITION_INVALID",
      "feature": "string",
      "holiday": "HOLIDAY_INVALID",
      "seasonality": "SEASONALITY_INVALID"
    },
    "boost": true
  }
],

Diet

Enum

DIET_INVALID

DIET_VEGETARIAN

DIET_VEGAN

DIET_OVO_VEGETARIAN

DIET_LACTO_VEGETARIAN

DIET_OVO_LACTO_VEGETARIAN

DIET_PESCATARIAN

DIET_KETOGENIC

DIET_DETOX

DIET_PALEO

DIET_DAIRY_FREE

Category

Enum

CATEGORY_INVALID

CATEGORY_QUICK_AND_EASY

CATEGORY_HEALTHY_RECIPES

CATEGORY_HOLIDAYS_AND_EVENTS

CATEGORY_BAKING

CATEGORY_BBQ_AND_GRILLING

CATEGORY_MAIN_DISHES

CATEGORY_SIDE_DISHES

CATEGORY_DESSERTS

CATEGORY_DRINKS

CATEGORY_APPETIZERS_AND_SNACKS

CATEGORY_LUNCH

CATEGORY_DINNER

CATEGORY_MEAT_AND_POULTRY

CATEGORY_PASTA

CATEGORY_SALAD

CATEGORY_SEAFOOD

CATEGORY_SOUPS_AND_STEWS

Avoidance

Enum

AVOIDANCE_INVALID

AVOIDANCE_ALCOHOL

AVOIDANCE_CAFFEINE

AVOIDANCE_CELERY

AVOIDANCE_CRUSTACEAN

AVOIDANCE_EGG

AVOIDANCE_FISH

AVOIDANCE_GLUTEN

AVOIDANCE_GROUNDNUT

AVOIDANCE_MILK

AVOIDANCE_MOLLUSC

AVOIDANCE_MUSTARD

AVOIDANCE_SESAME

AVOIDANCE_SOYBEAN

AVOIDANCE_SULPHITES

AVOIDANCE_TREE_NUT

AVOIDANCE_WHEAT

AVOIDANCE_YEAST

AVOIDANCE_LACTOSE

Cuisine

Enum

CUISINE_INVALID

CUISINE_AFRICAN

CUISINE_AMERICAN

CUISINE_ASIAN

CUISINE_AUSTRALIAN

CUISINE_BRITISH

CUISINE_CAJUN_AND_CREOLE

CUISINE_CANADIAN

CUISINE_CARIBBEAN

CUISINE_CHINESE

CUISINE_CUBAN

CUISINE_EASTERN_EUROPEAN

CUISINE_EUROPEAN

CUISINE_FRENCH

CUISINE_GERMAN

CUISINE_GREEK

CUISINE_INDIAN

CUISINE_ISRAELI

CUISINE_ITALIAN

CUISINE_JAPANESE

CUISINE_KOREAN

CUISINE_LATIN_AMERICAN

CUISINE_MEDITERRANEAN

CUISINE_MEXICAN

CUISINE_MIDDLE_EASTERN

CUISINE_MOROCCAN

CUISINE_PORTUGUESE

CUISINE_SOUTHERN

CUISINE_SPANISH

CUISINE_TEX_MEX

CUISINE_THAI

CUISINE_VIETNAMESE

CUISINE_WORLD_CUISINE

Meal Type

Enum

MEAL_TYPE_INVALID

MEAL_TYPE_APERITIF

MEAL_TYPE_APPETIZERS

MEAL_TYPE_BEVERAGES

MEAL_TYPE_BREADS

MEAL_TYPE_BREAKFAST

MEAL_TYPE_BRUNCH

MEAL_TYPE_COCKTAILS

MEAL_TYPE_CONDIMENTS_AND_SAUCES

MEAL_TYPE_DESSERTS

MEAL_TYPE_DINNER

MEAL_TYPE_JUICES

MEAL_TYPE_LUNCH

MEAL_TYPE_MAIN_COURSE

MEAL_TYPE_SALADS

MEAL_TYPE_SIDE_DISHES

MEAL_TYPE_SMOOTHIES

MEAL_TYPE_SNACKS

MEAL_TYPE_SOUPS_AND_STEWS

Nutrition

Enum

NUTRITION_INVALID

NUTRITION_CHOLESTEROL_FREE

NUTRITION_DIABETES_FRIENDLY

NUTRITION_FAT_FREE

NUTRITION_HEALTHY

NUTRITION_HIGH_FIBER

NUTRITION_HIGH_MONOUNSATURATED_FAT

NUTRITION_HIGH_POLYUNSATURATED_FAT

NUTRITION_HIGH_PROTEIN

NUTRITION_HIGH_UNSATURATED_FAT

NUTRITION_LOW_CARB

NUTRITION_LOW_CHOLESTEROL

NUTRITION_LOW_ENERGY

NUTRITION_LOW_FAT

NUTRITION_LOW_SALT

NUTRITION_LOW_SATURATED_FAT

NUTRITION_LOW_SODIUM

NUTRITION_LOW_SUGARS

NUTRITION_SALT_FREE

NUTRITION_SATURATED_FAT_FREE

NUTRITION_SODIUM_FREE

NUTRITION_SOURCE_OF_FIBER

NUTRITION_SOURCE_OF_PROTEIN

NUTRITION_SUGARS_FREE

NUTRITION_VERY_LOW_SALT

NUTRITION_VERY_LOW_SODIUM

Feature

This accepts a string value

Holiday

Enum

HOLIDAY_INVALID

HOLIDAY_BURNS_NIGHT

HOLIDAY_VALENTINES_DAY

HOLIDAY_PANCAKE_DAY

HOLIDAY_SAINT_DAVIS_DAY

HOLIDAY_SAINT_PATRICKS_DAY

HOLIDAY_EASTER_DAY

HOLIDAY_CINCO_DE_MAYA

HOLIDAY_MEMORIAL_DAY

HOLIDAY_INDEPENDENCE_DAY

HOLIDAY_LABOR_DAY

HOLIDAY_DIWALI

HOLIDAY_HALLOWEEN

HOLIDAY_THANKSGIVING_DAY

HOLIDAY_CHRISTMAS

HOLIDAY_BOXING_DAY

HOLIDAY_NEW_YEAR

HOLIDAY_MOTHERS_DAY

HOLIDAY_PASSOVER

HOLIDAY_FATHERS_DAY

HOLIDAY_ROSH_HASHANAH

HOLIDAY_YOM_KIPPUR

HOLIDAY_HANNUKAH

Seasonality

Enum

SEASONALITY_INVALID

SEASONALITY_WINTER

SEASONALITY_SPRING

SEASONALITY_SUMMER

SEASONALITY_FALL

Exclude Ingredients

"exclude_ingredients": [
  "string"
],

Feed Tags

"feed_tags": [
  "FEED_TAG_INVALID"
],

Enum

FEED_TAG_INVALID

FEED_TAG_EASY_DINNERS

FEED_TAG_DINNERS

FEED_TAG_TRENDING

FEED_TAG_RECOMMENDED

FEED_TAG_HEALTHY

FEED_TAG_HOLIDAYS

FEED_TAG_SEASONAL

Custom Labels

"custom_labels": {
  "everywhere": {
    "in": [
      {
        "group": "string",
        "label": "string"
      }
    ],
    "boost_in": [
      {
        "group": "string",
        "label": "string"
      }
    ]
  },
  "in_recipe": {
    "in": [
      {
        "group": "string",
        "label": "string"
      }
    ],
    "boost_in": [
      {
        "group": "string",
        "label": "string"
      }
    ]
  },
  "in_ingredients": {
    "in": [
      {
        "group": "string",
        "label": "string"
      }
    ],
    "boost_in": [
      {
        "group": "string",
        "label": "string"
      }
    ]
  },
  "in_instruction_steps": {
    "in": [
      {
        "group": "string",
        "label": "string"
      }
    ],
    "boost_in": [
      {
        "group": "string",
        "label": "string"
      }
    ]
  }
}

Sample Request

curl "https://api.whisk.com/v2/feed?limit=5&allowedContent=link,group,recipe" \
    -H "Accept: application/json" \
    -H "Authorization: Token <Access-Token>"

Last updated