Conducts a search of the food database using the search expression specified. The results are paginated according to a
zero-based "page" offset. Successive pages of results may be retrieved by specifying a starting page offset value. For
instance, specifying a max_results
of 10 and page_number
of 4 will return results numbered 41-50.
Passing an oauth_token
(i.e.: a logged in user token) is optional. Where the oauth_token
is specified, search
results will be refined according to the user's prior saved food entries.
The only storable values
returned by this call are the food_id
unique food identifiers of each food matching the
Changing Search Result Description Formatting (Premier Only):
An additional optional parameter named generic_description
is available to
premier clients only. This parameter, of type String
, may have a value of either "weight" or "portion":
- weight (default) - the summary description for key nutritional values is displayed by weight (typically 100g); E.G.: "Per 100g"
- portion - the summary description for key nutritional values is displayed using the default portion size; E.G.: "Per 1 Cup"
Note that the summary nutrition description for "Brand" food items is always shown using a "portion" based description.
Localization (Premier Only):
Two additional optional parameters named region
are available to premier clients. More information can be found
in the Localization