Search Foods
chevron down
back search icon cancel search
 
 

Search Foods

Retrieves a list of public foods from the Fitbit foods database and private foods the user created in the format requested.

Scope: nutrition

Request

GET /1/foods/search.json

Query Parameters
query required The URL-encoded search query string

Request Headers
authorization required Specify the token type and Fitbit user’s access token.
Token type: Bearer
accept optional The media type of the response content the client is expecting.
Supported: application/json
accept-language optional The measurement unit system to use for response values. See Localization.
accept-locale optional The locale to use for response values. See Localization.

Examples
GET https://api.fitbit.com/1/foods/search.json?query=blueberries
curl -X GET "https://api.fitbit.com/1/foods/search.json?query=blueberries" \
-H "accept: application/json" \
-H "authorization: Bearer <access_token>"

Response

Element Name Description
foods : accessLevel
foods : brand
foods : calories
foods : defaultServingSize
foods : defaultUnit : id
foods : defaultUnit : name
foods : defaultUnit : plural
foods : foodId
foods : isGeneric
foods : locale
foods : name
foods : units 
{
  "foods": [
    {
      "accessLevel": "PUBLIC",
      "brand": "",
      "calories": 82,
      "defaultServingSize": 1,
      "defaultUnit": {
        "id": 91,
        "name": "cup",
        "plural": "cups"
      },
      "foodId": 82547,
      "isGeneric": true,
      "locale": "en_US",
      "name": "Blueberries",
      "units": [
        91,
        226,
        304,
        20,
        256,
        147
      ]
    },
    {
      "accessLevel": "PUBLIC",
      "brand": "FreshBerry",
      "calories": 15,
      "defaultServingSize": 1,
      "defaultUnit": {
        "id": 226,
        "name": "oz",
        "plural": "oz"
      },
      "foodId": 14046577,
      "isGeneric": false,
      "locale": "en_US",
      "name": "Blueberries",
      "units": [
        226
      ]
    },
.
.
.

Response Headers
content-type The media type of the response content being sent to the client.
Supported: application/json
fitbit-rate-limit-limit The quota number of calls.
fitbit-rate-limit-remaining The number of calls remaining before hitting the rate limit.
fitbit-rate-limit-reset The number of seconds until the rate limit resets.

Note: The rate limit headers are approximate and asynchronously updated. This means that there may be a minor delay in the decrementing of remaining requests. This could result in your application receiving an unexpected 429 response if you don't track the total number of requests you make yourself.

Response Type

HTTP Status Code HTTP response code. List of codes are found in the Troubleshooting Guide.
Status Message Description of the status code.
Response Body Contains the JSON response to the API call. When errors are returned by the API call, the errorType, fieldName and message text will provide more information to the cause of the failure.

Response Codes
200 A successful request.
400 The request had bad syntax or was inherently impossible to be satisfied.
401 The request requires user authentication.

Note: For a complete list of response codes, please refer to the Troubleshooting Guide.

Additional Information

Considerations

  1. The units field contains references to respective Food Units.
  2. The accessLevel field can be PUBLIC or PRIVATE. Sharing custom foods is not supported.
previous
Get Water Log
Update Food Log
next