Guides

Welcome
Authentication
OAuth 2.0
OAuth 1.0
3-Legged OAuth
Data Types
Storable Data
Error Codes
Localization*

API Reference (OAuth 2.0)

Overview
Foods
- Find id for barcode*
- Get by id v3
- Get by id v2 (deprecated)
- Get by id v1 (deprecated)
- Autocomplete search expression v2*
- Autocomplete search expression* (deprecated)
- Search v2*
- Search v1
Food Brands
- Get all v2*
- Get all* (deprecated)
Food Categories
- Get all v2*
- Get all* (deprecated)
Food Sub Categories
- Get all v2*
- Get all* (deprecated)
Recipes
- Get by id v2
- Get by id v1 (deprecated)
- Search v3
- Search v2 (deprecated)
- Search v1 (deprecated)
Recipe Types
- Get all v2
- Get all v1 (deprecated)

API Reference (OAuth 1.0)

Overview

Foods
- Find id for barcode*
- Get by id v3
- Get by id v2 (deprecated)
- Get by id v1 (deprecated)
- Autocomplete search expression v2*
- Autocomplete search expression* (deprecated)
- Search v2*
- Search v1
Food Brands
- Get all v2*
- Get all* (deprecated)
Food Categories
- Get all v2*
- Get all* (deprecated)
Food Sub Categories
- Get all v2*
- Get all* (deprecated)
Recipes
- Get by id v2
- Get by id v1 (deprecated)
- Search v3
- Search v2 (deprecated)
- Search v1 (deprecated)
Recipe Types
- Get all v2
- Get all v1 (deprecated)
Exercises
- Get all v2
- Get all (deprecated)
Profile - Foods
- Create v2*
- Create v1* (deprecated)
- Add favorite
- Delete favorite
- Get favorites v2
- Get favorites (deprecated)
- Get most eaten v2
- Get most eaten (deprecated)
- Get recently eaten v2
- Get recently eaten (deprecated)
Profile - Recipes
- Add favorite
- Delete favorite
- Get favorites v2
- Get favorites (deprecated)
Profile - Saved Meals
- Create meal
- Delete meal by id
- Edit meal by id
- Get all meals v2
- Get all meals (deprecated)
- Add food to meal
- Delete food from meal
- Edit food in meal
- Get all foods in meal v2
- Get all foods in meal (deprecated)
Profile - Authentication
- Create profile
- Get profile status
- Get profile auth
Profile - Food Diary
- Copy entries between dates
- Copy entries between meals
- Get all entries v2
- Get all entries (deprecated)
- Get all entries for month v2
- Get all entries for month (deprecated)
- Create entry by id
- Delete entry by id
- Edit entry by id
Profile - Exercise Diary
- Commit day
- Get all for date v2
- Get all for date (deprecated)
- Get calories expended for month v2
- Get calories expended for month (deprecated)
- Save template
- Edit entries for date
Profile - Weight Diary
- Update for date
- Get for month v2
- Get for month (deprecated)

* denotes methods only available at the PREMIER level

Developers

REST API

API Reference (OAuth 1): Foods: Autocomplete search expression v2*

Foods: Autocomplete search expression v2*

Description

Returns a list of suggestions for the expression specified.

Why are we introducing this version?

This version contains an update to the JSON output structure.

Localization (Premier Only):

Two additional optional parameters named region and language are available to premier clients. More information can be found in the Localization guide.

Note: foods.autocomplete.v2 only works for the default region / language combination.

Parameters

Required

Name	Type	Description
oauth_consumer_key	String	Your API key when you registered as a developer
oauth_signature_method	String	The method used to generate the signature (only HMAC-SHA1 is supported)
oauth_timestamp	Int	The date and time, expressed in the number of seconds since January 1, 1970 00:00:00 GMT. The timestamp value must be a positive integer and must be equal or greater than the timestamp used in previous requests
oauth_nonce	String	A randomly generated string for a request that can be combined with the timestamp to produce a unique value
oauth_version	String	MUST be "1.0"
oauth_signature	String	The signature, a consistent reproducible concatenation of the request elements into a single string. The string is used as an input in hashing or signing algorithms.
method	String	MUST be "foods.autocomplete.v2"
expression	String	Suggestions for the given expression is returned. E.G.: "chic" will return up to four of the best suggestions that contains "chic".

Optional

Name	Type	Description
format	String	The desired response format. Valid reponse formats are "xml" or "json" (default value is "xml").
max_results	Int	The maximum number of results to return (default value is 4). This number cannot be greater than 10.

Response

The result of the call is the best suggestions matching the expression specified, ordered by their relevency to the expression. Up to four suggestions are returned.

Example Return XML

<?xml version="1.0" encoding="utf-8" ?>

<suggestion>chicken</suggestion>

<suggestion>chicken breast</suggestion>

<suggestion>chicken salad</suggestion>

<suggestion>chiken wings</suggestion>

</suggestions>

Example Return JSON

{ "suggestions": { "suggestion": [ "chicken", "chicken breast", "chicken salad", "chiken wings" ] }}

Error Code

Code	Description
2	Missing required oauth parameter: "<detail>"
3	Unsupported oauth parameter: "<detail>"
4	Invalid signature method: "<detail>"
5	Invalid consumer key: "<detail>"
6	Invalid/expired timestamp: "<detail>"
7	Invalid/used nonce: "<detail>"
8	Invalid signature: "<detail>"
101	Missing required parameter: "<detail>"
107	Value out of range: "<detail>"