Whisk Docs
Whisk HomeHelp CenterDeveloper Tools
v2.0.0
v2.0.0
  • The Whisk Platform
  • Whisk API Overview
    • Introduction
    • Integration
    • Authentication
      • Server Token
      • User Access Token
        • Auth Flow Example
      • Client Token
      • Anonymous Access from Client Apps
    • Whisk Sandbox
    • Getting Started
  • Whisk API Reference 2.0
    • Provisioning
      • Get provisioning
    • Autocomplete
    • Community
      • Get your Communities
      • Get Communities from a Topic
      • Discover Recommended Communities
      • Search Communities
      • Get a Community
      • Get Recipes from a Community
      • Add Recipes to a Community
      • Remove a Recipe from a Community
      • Join a Community
      • Leave a Community
    • Posts and Reviews
      • Get reviews for a recipe
      • Create or edit review
      • Create a Post
      • Get Post by id
      • Delete a Post
      • Edit a Post
      • Report a Post
      • Create a Post Reply
      • Get Post Replies
      • Delete a Post reply
      • Report a Post reply
      • Like a Post or Reply
      • Users who liked a Post or Reply
    • Public profiles
      • Hide recipe in Public profile
      • Get Recipes for Public Profile
      • Get User's public profile by user_id
      • Get User's public profile by username
    • Custom Label
    • Feed
      • Obtain a Recipe Feed
    • Food DB
      • Autocomplete
      • Search
      • Get Food
    • Food List
    • Food Log
    • Foodpairing
    • Healthy meal recommendations
      • Healthy recipe only recommendations for DA
      • Recipe recommendations for SH
      • Tailored Plan API request for Samsung TV
    • Meal Plan
      • Generate a Meal Plan
      • Meal Object
        • Get Meals
        • Delete Meal
        • Add a Meal
      • Meal Plan Settings Object
        • Get Meal Plan Settings
        • Update Meal Plan Settings
      • Meal Plan Batch
    • Recipe
      • Get a Recipe
      • Search a Recipe
      • User Recipes & Collections
        • Add User Recipe
        • Create A Recipe
        • Update External Recipe
        • Get All User Recipes
        • Update User Recipe
        • Remove Recipe from Favorites
        • Create Collection
        • Get All User Collections
        • Get Collection
        • Get Recipes from a Collection
        • Remove Collection
        • Get Smart Collection
        • Get Recipes from a Smart Collection
    • Shopping List
      • Get your Shopping Lists
      • Get a Shopping List
      • Create a Shopping List
      • Delete a Shopping List
      • Update basic details of a Shopping List
      • Move Items between Shopping Lists
      • Add Items to a Shopping List
      • Delete an Item from a Shopping List
      • Update an Item in a Shopping List
      • Clear Items from a Shopping List
    • Media
    • Store Item
    • Unit Conversion
    • Users
      • Get a User
      • Update User Settings using Patch
      • Update User Settings using Post
    • Try it out!
  • Shopping List SDK
    • Overview
    • Examples
      • Shoppable Recipes
      • Shoppable Products
      • Shoppable Media
    • Basic Setup
      • Basic Setup
      • Methods
      • Event Listeners
      • Widget
      • Subscriptions
      • Global Configuration
      • UTM Parameters
      • Using With SPA
  • Shopping List Mobile API
    • Overview
    • Examples
    • Reference
  • API Resources
    • Authentication Scopes
    • Errors and Troubleshooting
    • Cursor Pagination
    • Limits
    • Nutrients
    • Recipe Labels
    • Filtering Recipes using Custom Labels
    • Health Score, Glycemic Index, Glycemic Load
    • Whisk User Data
    • Integrated Retailers
    • Optimizing Image Load
    • Meal Plan
Powered by GitBook
On this page
  • Description
  • Parameters
  • Response

Was this helpful?

  1. Whisk API Reference 2.0
  2. Food DB

Search

POST https://api.whisk.com/food/v2/search

PreviousAutocompleteNextGet Food

Last updated 1 year ago

Was this helpful?

Description

Search API allows to look for a product and fetch the options along with the nutrition and other useful information. Search API works with the complete user input, often with the autocomplete results i.e. apple instead of appl.

Parameters

Name
Optional
Type
Description

query

no

string

Max length is 255 chars

language

no

string

ISO 639-1 two letter language code

country

yes

string

ISO 3166-1 two letter country code

cursor.limit

yes

int

Number of results

cursor.cursors.after

yes

string

Next page after the value. Can not be used together with cursor.cursors.before

cursor.cursors.before

yes

string

Page previous to the value. Cannon be used together with cursor.cursors.after

Request example

curl -X POST "https://api.whisk.com/food/v2/search" -H  "accept: application/json" -H  "Authorization: Bearer %WHISK_TOKEN%" -H  "Content-Type: application/json" -d '
{  "query": "apple",  "language": "en",  "country": "gb",  "cursor": {    "limit": 20  }}'

Response

Data returned in JSON. Empty strings, zero values, empty arrays and null values are not returned.

JSON response example

{
  "food": [
    {
      "food_hit": "CiMyMDI2OTdjYjQ5MGU5YmM0MTMzYTg5OWYzOWJhZTI3NmEyZQ==",
      "title": "apple"
    } 
...
  ],
  "paging": {
    "cursors": {
      "after": "d5:after1284:eyJpZCI6IiIsImluZGV4IjoxOSwidGltZXN0YW1wIjoxNjczOTcyNTA0LCJwaXRJZCI6Ino5X3FBd1liY0d4aGRHWnZjbTFmY0hKdlpIVmpkQzB5TURJeUxURXlMVEl3RmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0ZGa0o1VkVwSWFVWlFWSEZoWjFNNE9VRlVXbTFUTjBFQUFBQUFBQVF2SVNzV1RGbHdRMjVoYjNaVVRVTTNWMHhNVVd4VFlYTjRRUUFiY0d4aGRHWnZjbTFmY0hKdlpIVmpkQzB5TURJeUxURXlMVEl3RmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0FGamxxU0daT1RscHVVbFJsU2xSS09FaFJVME5NUTJjQUFBQUFBQVpYWVJvV1JVdHVTVm95ZGtKUlZFTm5WMFZTTTFGdlVFMXRVUUFiY0d4aGRHWnZjbTFmY0hKdlpIVmpkQzB5TURJeUxURXlMVEl3RmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0NGbWhMUzBkVE1tcElVM0Z0U0VvdFEzUkJla05tTm5jQUFBQUFBQVdIdWs4V09GRjFhVjg1VVc5U00wY3dkVXRZUmxkS1EwdDBad0FiY0d4aGRHWnZjbTFmY0hKdlpIVmpkQzB5TURJeUxURXlMVEl3RmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0JGblZMV0hCeU9FbGtVVUZEUjNJMlJWRjFjM1prUVZFQUFBQUFBQVplMmJzV1ZGWmpia1oyYjAxVVdHbGlUbmczYkUxRlpXeEpad0FiY0d4aGRHWnZjbTFmY0hKdlpIVmpkQzB5TURJeUxURXlMVEl3RmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0VGa2t0YkVWaWIzTjJVMnhMVGkwMmRuaFdOVkZvTkdjQUFBQUFBQVExY1VVV05WbFdhMTh4UVdWU05FTXhRbWxHU0d3MFdtVjRad0FiY0d4aGRHWnZjbTFmY0hKdlpIVmpkQzB5TURJeUxURXlMVEl3RmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0RGa05DUlVWWlUwUXpVVEpMYjNCNVdFaEVkbFJ4WkhjQUFBQUFBQVl3TDhzV2VYbE1VMlZ0YUZsVVZXbHhkbUZTTTFCUkxWUk9kd0FCRmpOTFdVSk9kMDV6VVcxcFkwMHRUV016TWtFMmJHY0FBQT09In0=e"
    },
    "total": "1106"
  }
}

Core attributes

Name
Optional
Type
Description

food_hit

no

string

Food identifier to be used with Get Food method

title

no

string

Localized food name

paging.total

yes

int

The total number of available results

paging.cursors.after

yes

string

Reference to the next page

paging.cursors.before

yes

string

References to the previous page

Swagger doc