# openfoodfacts.product

**stable** **Standard**

Open Food Facts: product by barcode.

`GET /v1/openfoodfacts/product`

## What you get

One Openfoodfacts record in Onekey's unified shape, in `data`. If the record does not exist you get a `404 not_found` and are not charged.

## What it costs

- **Standard · 1 credit** 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 |
| --- | --- | --- | --- | --- | --- |
| `code` | string | yes | (required) | Barcode (EAN/UPC), digits only | max 14 chars; must match `[0-9]{8,14}`; trimmed |

## Request

```bash
curl "https://api.onekey.dev/v1/openfoodfacts/product?code=737628064502" \
  -H "x-api-key: YOUR_API_KEY"
```

```python
import requests

res = requests.get(
    "https://api.onekey.dev/v1/openfoodfacts/product",
    params={"code": "737628064502"},
    headers={"x-api-key": "YOUR_API_KEY"},
)
body = res.json()

if body["success"]:
    print(body["data"])
else:
    print(body["error"]["code"], body["error"]["message"])
```

```javascript
const params = new URLSearchParams({ code: "737628064502" });
const res = await fetch(`https://api.onekey.dev/v1/openfoodfacts/product?${params}`, {
  headers: { "x-api-key": "YOUR_API_KEY" },
});
const body = await res.json();

if (body.success) console.log(body.data);
else console.error(body.error.code, body.error.message);
```

## 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": "0737628064502",
      "name": "Thai peanut noodle kit includes stir-fry rice noodles & thai peanut seasoning",
      "category": "Cereals and their products, Noodles, Rice Noodles"
    },
    "listing": {
      "brand": "Simply Asia, Thai Kitchen"
    },
    "ext": {
      "quantity": "155 g",
      "ingredients": "Rice Noodles (rice, water), seasoning packet (peanut, sugar, salt, corn starch, spices [chili, cinnamon, pepper, cumin, clove], hydrolyzed soy protein, green onions, citric acid, peanut oil, sesame oil, natural flavor).",
      "countries": "France, United States",
      "nutriscore": "d",
      "nova": 4,
      "ecoscore": "unknown",
      "allergens": "peanuts, sesame seeds, soybeans",
      "kcalPer100g": 385,
      "fatPer100g": 7.69,
      "sugarsPer100g": 13.46,
      "proteinPer100g": 9.62,
      "saltPer100g": 0.72
    },
    "media": {
      "thumbnailUrl": "https://images.openfoodfacts.org/images/products/073/762/806/4502/front_en.6.400.jpg"
    }
  },
  "metadata": {
    "platform": "openfoodfacts",
    "endpoint": "product",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}
```

## Field mapping

How this endpoint's source fields become Onekey's [unified schema](https://onekey.dev/docs/schema.md). 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 1 hour. Repeat calls in that window are served from cache and are free.
- Between 1 hour and 1 day 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 day more (marked stale).
- A "not found" is remembered for 5 minutes 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](https://onekey.dev/pricing); your balance must cover the price. |
| 404 | `not_found` | That record does not exist. Free; do not retry. |
| 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](https://onekey.dev/docs/errors.md) for the full list and retry guidance.

Status: stable (verified against the live source).