Search

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

Description

Swagger doc

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

NameOptionalTypeDescription

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

NameOptionalTypeDescription

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

Last updated