openfoodfacts.search

stable Advanced

Open Food Facts: full-text product search.

GET /v1/openfoodfacts/search

What you get#

A list of Openfoodfacts results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`q`	string	yes	(required)	Search query	max 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/openfoodfacts/search?q=nutella" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Openfoodfacts response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "id": "3017620422003",
        "name": "Nutella",
        "category": "Confectionary based spreads, Petit-déjeuners, Produits à tartiner, Produits à tartiner sucrés, Pâtes à tartiner, fr:Nutella, fr:Nuttela"
      },
      "listing": {
        "brand": "Nutella, Ferrero"
      },
      "ext": {
        "quantity": "400 g e",
        "ingredients": "Sucre, huile de palme, NOISETTES 13%, cacao maigre 7,4%, LAIT écrémé en poudre 6,6%, LACTOSERUM en poudre, émulsifiants: lécithines [SOJA), vanilline. Sans gluten.",
        "countries": "France",
        "nutriscore": "e",
        "nova": 4,
        "ecoscore": "unknown",
        "allergens": "milk, nuts, soybeans",
        "kcalPer100g": 539,
        "fatPer100g": 30.9,
        "sugarsPer100g": 56.3,
        "proteinPer100g": 6.3,
        "saltPer100g": 0.107
      },
      "media": {
        "thumbnailUrl": "https://images.openfoodfacts.org/images/products/301/762/042/2003/front_en.879.400.jpg"
      }
    },
    {
      "entity": {
        "id": "3017620425035",
        "name": "Nutella",
        "category": "Cocoa and hazelnuts spreads, Confectionary based spreads, pates-a-tartiner-au-chocolat, pates-a-tartiner-aux-noisettes, pates-a-tartiner-aux-noisettes-et-au-cacao, petit-dejeuners, produits-a-tartiner, produits-a-tartiner-sucres"
      },
      "listing": {
        "brand": "Nutella, FERRERO FRANCE COMMERCIALE"
      },
      "ext": {
        "quantity": "1 kg",
        "ingredients": "Sucre, huile de palme, NOISETTES 13%, LAIT écrémé en poudre 8,7%, cacao maigre 7,4%, émulsifiants: lécithines [SOJA]; vanilline. Sans gluten",
        "countries": "Algeria, Belgium, Bulgaria, France, Germany, Guadeloupe, India, Italy, Luxembourg, Martinique, Morocco, Réunion, Spain, Switzerland, Tunisia, United Kingdom, United States",
        "nutriscore": "e",
        "nova": 4,
        "ecoscore": "e",
        "allergens": "milk, nuts, soybeans",
        "kcalPer100g": 539,
        "fatPer100g": 30.9,
        "sugarsPer100g": 56.3,
        "proteinPer100g": 6.3,
        "saltPer100g": 0.107
      },
      "media": {
        "thumbnailUrl": "https://images.openfoodfacts.org/images/products/301/762/042/5035/front_en.583.400.jpg"
      }
    }
  ],
  "metadata": {
    "platform": "openfoodfacts",
    "endpoint": "search",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`code`	`entity.id`	-
`product_name`	`entity.name`	-
`brands`	`listing.brand`	-
`quantity`	`ext.quantity`	-
`categories`	`entity.category`	-
`ingredients_text`	`ext.ingredients`	-
`countries`	`ext.countries`	-
`image_front_url`	`media.thumbnailUrl`	`safeUrl`
`nutriscore_grade`	`ext.nutriscore`	-
`nova_group`	`ext.nova`	`toNumber`
`ecoscore_grade`	`ext.ecoscore`	-
`allergens`	`ext.allergens`	-
`nutriments.energy-kcal_100g`	`ext.kcalPer100g`	`toNumber`
`nutriments.fat_100g`	`ext.fatPer100g`	`toNumber`
`nutriments.sugars_100g`	`ext.sugarsPer100g`	`toNumber`
`nutriments.proteins_100g`	`ext.proteinPer100g`	`toNumber`
`nutriments.salt_100g`	`ext.saltPer100g`	`toNumber`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).