# Obtain a Recipe Feed

{% hint style="info" %}
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.
{% endhint %}

## Recipe Feed

<mark style="color:blue;">`GET`</mark> `https://api.whisk.com/feed/v2/get`

#### Path Parameters

| Name         | Type   | Description |
| ------------ | ------ | ----------- |
| Feed Request | object |             |

{% tabs %}
{% tab title="200 " %}

```javascript
{
  "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"
  }
}
```

{% endtab %}
{% endtabs %}

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

```bash
{
  "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

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

### Labels

```bash
"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

```bash
"exclude_ingredients": [
  "string"
],
```

### Feed Tags

```bash
"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

```bash
"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

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