foods.autocomplete

Description

Returns a list of suggestions for the expression specified.

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"
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" ?>
<suggestions xmlns="http://platform.fatsecret.com/api/1.0/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://platform.fatsecret.com/api/1.0/ http://platform.fatsecret.com/api/1.0/fatsecret.xsd">
    <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>"
FatSecret Sites
For Developers

For Professionals

For Everyone

FatSecret Platform API

Developers

Support
API

About FatSecret

© 2022 FatSecret. All rights reserved.