v2.0.0
Whisk HomeHelp CenterDeveloper Tools

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

{
  "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": {
    ...
  }
}

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

Category

Avoidance

Cuisine

Meal Type

Nutrition

Feature

This accepts a string value

Holiday

Seasonality

Exclude Ingredients

"exclude_ingredients": [
  "string"
],

Feed Tags

"feed_tags": [
  "FEED_TAG_INVALID"
],

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

PreviousFeedNextFood DB

Last updated