API: Difference between revisions

Revision as of 16:44, 29 November 2016

Introduction

Current status of the API

Currently the API is used internally for the official Open Food Facts mobile applications (iOS, Android, Windows, and we need help !) and by dozens of reuses on various topics (Nutrition, sport…) and platforms (iOS, Android…), but does not yet follow good practices in API design.
It is also used by several applications and while not yet stable, doesn't change much.
You can have a look at the source code of the app
- https://github.com/openfoodfacts/cordova-app/blob/master/www/off.js
- https://github.com/openfoodfacts/cordova-app/blob/master/www/index.html
Anyone with Swagger (or equivalent knowledge) willing to help us document the API is most welcome :-)

Getting help with the API

You can ask for help on using the API in this API channel on Slack. Join us to discuss your use case and get help/code from other devs.

How to test the API

READ operations

Technical details

You can do READ operations using production
You should now use the SSL version of the API. The unsecure version WILL be deprecated :-)

https://ssl-api.openfoodfacts.org

Licence

Open Food Facts is under the OdBL licence (database) and CC-BY-SA (pictures). That has a couple of legal implications. Please join us on the Slack channel to discuss them.

WRITE operations

Use cases

You can add photos and informations to Open Food Facts using the API.
- Letting your users add new products by uploading photos is the most common use case.
- Several apps already enable more advanced editing. Gamification would be welcome.
The official mobile apps can use some help.

A few things

Do join the API channel if you intend on using WRITE
Do not send copyrighted photos or information using the API. Everything you send is OdBL for the data, and CC-BY-SA for the pictures. If those are not yours (eg from scraping), you bear all the legal consequences.
You can create a global account for your app if you don't want to implement Open Food Facts user creation in your app right now. Please report it in #api so that it can be monitored for errors.
You should do all your test edits on http://world.openfoodfacts.net (ask for the password on Slack)

Conventions for the API

fields that end with _t are dates in the UNIX timestamp format (number of seconds since Jan 1st 1970)
fields that end with _datetime are dates in the iso8601 format: yyyy-mm-ddThh:mn:ssZ
fields that end with _tags are comma separated list of tags (e.g. categories_tags is the set of normalized tags computer from the categories field)
fields that end with a language 2 letter code (e.g. fr for French) is the set of tags in that language
fields that end with _100g correspond to the amount of a nutriment (in g) for 100 g or 100 ml of product

Language Bindings

API/Android
API/C sharp
Go bindings - https://github.com/openfoodfacts/openfoodfacts-go
API/Java
API/Javascript
API/Javascript/NodeJS
API/Perl
PHP bindings - https://github.com/openfoodfacts/openfoodfacts-php
Python bindings - https://github.com/openfoodfacts/openfoodfacts-python (LIVE API) - https://github.com/openfoodfacts/OpenFoodFacts-APIRestPython (Local Dump)
API/R
Ruby bindings - https://github.com/openfoodfacts/openfoodfacts-ruby - gem install openfoodfacts - https://github.com/openfoodfacts/openbeautyfacts-ruby - gem install openbeautyfacts
API/Scala
API/Swift
Please help us bring Open Food Facts to your favorite language by contributing bindings

Roadmap

API/Roadmap

Bugs

Reporting bugs

Do not hesitate to file a bug if you find an issue in the API, or need an improvement.

Known bugs

General bugs: https://github.com/openfoodfacts/openfoodfacts-server/issues
API bugs: https://github.com/openfoodfacts/openfoodfacts-server/labels/api
API milestone: https://github.com/openfoodfacts/openfoodfacts-server/milestone/8

READ API Documentation

Downloading static data

It is recommended to use the live API to get fresh data about products, the minute they are uploaded to the database. However, in some cases, you may need a snapshot. They are available at:

http://world.openfoodfacts.org/data (all data)
http://fr.openfoodfacts.org/data (data for that country)

CSV API

The character that separates fields is <tab> (tabulation).

Encoding

The file encoding is Unicode UTF-8.

MongoDB dump

Field reference

The fields used in the api. http://world.openfoodfacts.org/data/data-fields.txt

JSON interface

Countries

You can either use the global (world) for locales (fr, en…)

A few things to note:

if you use a country subdomain instead of world, you get products for that countries only which might change the language but also the name of the fields, in that case you need to use the local language
- http://fr.openfoodfacts.org/categorie/pizzas.json
- an alternative is to specify the language in the subdomain: http://fr-en.openfoodfacts.org/category/pizzas.json

Reading a product

The requested subdomain will be the locale fetched. (fr.openfoodfacts will fetch FR, world.openfoodfacts EN, world-fr FR products from the whole world)

Structure of the call

The final number must be a valid barcode.

Status codes

If a product is not found

{  
   "status_verbose":"product not found",
   "code":"32421",
   "status":0
}

If the product is found properly

{  
   "status_verbose":"product found",
   "product":{  
      "categories_prev_hierarchy":[  
         "en:fresh-foods",
         "en:meals",
         "en:sandwiches",
         "en:fresh-meals",
         "fr:croque-monsieur"
      ],
      "entry_dates_tags":[  
         "2016-09-29",
         "2016-09",
         "2016"
      ],
      "serving_quantity":150,
      "_id":"3222475893421",
      "pnns_groups_2":"Sandwich",
      "pnns_groups_2_tags":[  
         "sandwich"
      ],
      "languages_tags":[  
         "en:french",
         "en:1"
      ],
      "brands_debug_tags":[  

      ],
      "image_front_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/front_fr.10.400.jpg",
      "stores":"Casino",
      "origins":"",
      "product_name_fr_debug_tags":[  

      ],
      "generic_name_fr":"Pain de mie garni de fromage fondu et de jambon cuit choix",
      "additives_old_n":11,
      "nutrition_data_per_debug_tags":[  

      ],
      "expiration_date_debug_tags":[  

      ],
      "codes_tags":[  
         "code-13",
         "3222475893421",
         "322247589342x",
         "32224758934xx",
         "3222475893xxx",
         "322247589xxxx",
         "32224758xxxxx",
         "3222475xxxxxx",
         "322247xxxxxxx",
         "32224xxxxxxxx",
         "3222xxxxxxxxx",
         "322xxxxxxxxxx",
         "32xxxxxxxxxxx",
         "3xxxxxxxxxxxx"
      ],
      "additives_debug_tags":[  
         "en-e316-fr-removed"
      ],
      "labels_hierarchy":[  
         "en:palm-oil-free",
         "fr:Experimentation Etiquetage Nutritionnel 2016",
         "fr:Experimentation NutriScore",
         "fr:Expérimentation NutriScore D"
      ],
      "cities_tags":[  

      ],
      "informers_tags":[  
         "tacinte",
         "tacite-mass-editor",
         "tacite"
      ],
      "image_ingredients_small_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/ingredients_fr.12.200.jpg",
      "_keywords":[  
         "plat",
         "etiquetage",
         "san",
         "cuit",
         "experimentation",
         "huile",
         "fondu",
         "et",
         "croque-monsieur",
         "casino",
         "croque",
         "choix",
         "maxi",
         "nutriscore",
         "de",
         "palme",
         "pain",
         "mie",
         "frai",
         "prepare",
         "sandwich",
         "garni",
         "jambon",
         "fromage",
         "2016",
         "monsieur",
         "nutritionnel"
      ],
      "pnns_groups_1_tags":[  
         "composite-foods"
      ],
      "nutrition_score_debug":" -- energy 3 + sat-fat 6 + fr-sat-fat-for-fats 6 + sugars 0 + sodium 6 - fruits 0% 0 - fiber 0 - proteins 5 -- fsa 15 -- fr 15",
      "images":{  
         "front_fr":{  
            "y2":"340.8125",
            "x1":"67.75",
            "angle":"0",
            "imgid":"5",
            "white_magic":"false",
            "x2":"245.75",
            "normalize":"true",
            "y1":"13.8125",
            "rev":"10",
            "geometry":"1851x3401-704-143",
            "sizes":{  
               "400":{  
                  "w":218,
                  "h":400
               },
               "full":{  
                  "h":3401,
                  "w":1851
               },
               "100":{  
                  "w":54,
                  "h":100
               },
               "200":{  
                  "h":200,
                  "w":109
               }
            }
         },
         "2":{  
            "sizes":{  
               "400":{  
                  "h":400,
                  "w":300
               },
               "full":{  
                  "h":4160,
                  "w":3120
               },
               "100":{  
                  "w":75,
                  "h":100
               }
            },
            "uploaded_t":"1474912149",
            "uploader":"tacinte"
         },
         "5":{  
            "uploaded_t":"1474912158",
            "uploader":"tacinte",
            "sizes":{  
               "100":{  
                  "h":100,
                  "w":75
               },
               "400":{  
                  "h":400,
                  "w":300
               },
               "full":{  
                  "w":3120,
                  "h":4160
               }
            }
         },
         "3":{  
            "uploaded_t":"1474912152",
            "uploader":"tacinte",
            "sizes":{  
               "full":{  
                  "w":3120,
                  "h":4160
               },
               "400":{  
                  "h":400,
                  "w":300
               },
               "100":{  
                  "h":100,
                  "w":75
               }
            }
         },
         "nutrition_fr":{  
            "y1":"151.8125",
            "normalize":"true",
            "x2":"169.75",
            "rev":"13",
            "geometry":"1238x1238-527-1578",
            "sizes":{  
               "full":{  
                  "w":1238,
                  "h":1238
               },
               "400":{  
                  "h":400,
                  "w":400
               },
               "100":{  
                  "w":100,
                  "h":100
               },
               "200":{  
                  "w":200,
                  "h":200
               }
            },
            "y2":"270.8125",
            "x1":"50.75",
            "angle":"0",
            "white_magic":"false",
            "imgid":"4"
         },
         "4":{  
            "sizes":{  
               "400":{  
                  "w":300,
                  "h":400
               },
               "full":{  
                  "h":4160,
                  "w":3120
               },
               "100":{  
                  "h":100,
                  "w":75
               }
            },
            "uploader":"tacinte",
            "uploaded_t":"1474912154"
         },
         "ingredients_fr":{  
            "y2":"248.8125",
            "x1":"82.75",
            "angle":"0",
            "white_magic":"false",
            "imgid":"3",
            "normalize":"true",
            "y1":"158.8125",
            "x2":"257.75",
            "rev":"12",
            "sizes":{  
               "full":{  
                  "w":1820,
                  "h":936
               },
               "400":{  
                  "h":206,
                  "w":400
               },
               "100":{  
                  "h":51,
                  "w":100
               },
               "200":{  
                  "h":103,
                  "w":200
               }
            },
            "geometry":"1820x936-860-1651"
         },
         "1":{  
            "sizes":{  
               "full":{  
                  "w":3120,
                  "h":4160
               },
               "400":{  
                  "h":400,
                  "w":300
               },
               "100":{  
                  "w":75,
                  "h":100
               }
            },
            "uploaded_t":"1474912148",
            "uploader":"tacinte"
         }
      },
      "ingredients_text_debug":"Pain de mie 49,3% (farine de _blé_ - eau - huile de colza - sel - dextrose - levure -  :  propionate de calcium -  :  mono- et diglycérides d'acides gras , lécithines - _gluten de blé_ -  :  gomme xanthane - agent  : de la farine : acide ascorbique) - _fromage_ fondu 28% [_fromages_ 14% (dont _emmental_ 4,2%) - _beurre_ - eau - protéines de lait - amidons transformés de maïs et/ou pomme de terre - _lactosérum_ - sels  :  citrates de sodium , polyphosphates -  :  carraghénanes] - jambon cuit choix sans polyphosphates 14,7% (jambon de porc - eau - sel - sirop de glucose - dextrose - arômes -  :  érythorbate de sodium , nitrite de sodium) - matière grasse végétale raffinée de colza - _beurre_ concentré -  :  caroténoïdes.",
      "last_editor":"tacite",
      "allergens_hierarchy":[  
         "en:gluten",
         "en:milk",
         "fr:lactosérum"
      ],
      "categories_debug_tags":[  

      ],
      "countries":"France",
      "image_front_small_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/front_fr.10.200.jpg",
      "stores_debug_tags":[  

      ],
      "nutriments":{  
         "sugars_serving":4.2,
         "carbohydrates":"42",
         "salt_100g":1.6,
         "fat_100g":15.3,
         "carbohydrates_100g":"28",
         "saturated-fat_value":"9.6",
         "proteins_unit":"g",
         "salt":2.4,
         "sugars_100g":2.8,
         "sugars":4.2,
         "energy_serving":"1854",
         "fat_unit":"g",
         "energy":"1854",
         "nutrition-score-fr":"15",
         "energy_100g":"1240",
         "nutrition-score-uk_100g":"15",
         "salt_serving":2.4,
         "saturated-fat_unit":"g",
         "fat_value":"23",
         "salt_unit":"g",
         "proteins":"17",
         "proteins_100g":11.3,
         "carbohydrates_serving":"42",
         "saturated-fat":9.6,
         "energy_unit":"kJ",
         "fat":"23",
         "fat_serving":"23",
         "proteins_serving":"17",
         "sodium_value":"0.9448818897637794",
         "salt_value":"2.4",
         "sugars_value":"4.2",
         "energy_value":"1854",
         "sodium_100g":0.63,
         "nutrition-score-uk":"15",
         "sodium":0.944881889763779,
         "saturated-fat_100g":6.4,
         "nutrition-score-fr_100g":"15",
         "carbohydrates_value":"42",
         "carbohydrates_unit":"g",
         "saturated-fat_serving":9.6,
         "sodium_serving":0.944881889763779,
         "proteins_value":"17",
         "sugars_unit":"g",
         "sodium_unit":"g"
      },
      "countries_hierarchy":[  
         "en:france"
      ],
      "lang":"fr",
      "languages_hierarchy":[  
         "en:french"
      ],
      "expiration_date":"",
      "last_modified_t":1475344323,
      "generic_name":"Pain de mie garni de fromage fondu et de jambon cuit choix",
      "nutrient_levels":{  
         "saturated-fat":"high",
         "salt":"high",
         "fat":"moderate",
         "sugars":"low"
      },
      "origins_tags":[  

      ],
      "no_nutrition_data":"",
      "ingredients_from_palm_oil_n":0,
      "created_t":1475161440,
      "labels_debug_tags":[  

      ],
      "last_image_dates_tags":[  
         "2016-09-29",
         "2016-09",
         "2016"
      ],
      "ingredients_n":"45",
      "sortkey":1475344323,
      "categories_tags":[  
         "en:fresh-foods",
         "en:meals",
         "en:sandwiches",
         "en:fresh-meals",
         "fr:croque-monsieur"
      ],
      "countries_debug_tags":[  

      ],
      "ingredients_text_with_allergens":"Pain de mie 49,3% (farine de <span class=\"allergen\">blé</span> - eau - huile de colza - sel - dextrose - levure - conservateur : propionate de calcium - émulsifiants : mono- et diglycérides d'acides gras , lécithines - <span class=\"allergen\">gluten de blé</span> - épaississant : gomme xanthane - agent de traitement de la farine : acide ascorbique) - <span class=\"allergen\">fromage</span> fondu 28% [<span class=\"allergen\">fromages</span> 14% (dont <span class=\"allergen\">emmental</span> 4,2%) - <span class=\"allergen\">beurre</span> - eau - protéines de lait - amidons transformés de maïs et/ou pomme de terre - <span class=\"allergen\">lactosérum</span> - sels de fonte : citrates de sodium , polyphosphates - gélifiant : carraghénanes] - jambon cuit choix sans polyphosphates 14,7% (jambon de porc - eau - sel - sirop de glucose - dextrose - arômes - conservateurs : érythorbate de sodium , nitrite de sodium) - matière grasse végétale raffinée de colza - <span class=\"allergen\">beurre</span> concentré - colorant : caroténoïdes.",
      "pnns_groups_1":"Composite foods",
      "quantity_debug_tags":[  

      ],
      "emb_codes":"",
      "packaging":"barquette,plastique",
      "emb_codes_orig":"",
      "image_nutrition_small_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/nutrition_fr.13.200.jpg",
      "correctors_tags":[  
         "tacinte",
         "tacite"
      ],
      "traces_hierarchy":[  
         "en:celery",
         "en:crustaceans",
         "en:eggs",
         "en:fish",
         "en:molluscs",
         "en:mustard",
         "en:nuts",
         "en:soybeans"
      ],
      "stores_tags":[  
         "casino"
      ],
      "last_edit_dates_tags":[  
         "2016-10-01",
         "2016-10",
         "2016"
      ],
      "labels_prev_tags":[  
         "en:palm-oil-free",
         "fr:experimentation-etiquetage-nutritionnel-2016",
         "fr:experimentation-nutriscore",
         "fr:experimentation-nutriscore-d"
      ],
      "states_tags":[  
         "en:to-be-checked",
         "en:complete",
         "en:nutrition-facts-completed",
         "en:ingredients-completed",
         "en:expiration-date-to-be-completed",
         "en:characteristics-completed",
         "en:categories-completed",
         "en:brands-completed",
         "en:packaging-completed",
         "en:quantity-completed",
         "en:product-name-completed",
         "en:photos-validated",
         "en:photos-uploaded"
      ],
      "image_small_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/front_fr.10.200.jpg",
      "quantity":"2 x 150 g (300 g)",
      "additives_old_tags":[  
         "en:e282",
         "en:e471",
         "en:e322",
         "en:e415",
         "en:e300",
         "en:e331",
         "en:e452",
         "en:e407",
         "en:e316",
         "en:e250",
         "en:e160"
      ],
      "image_ingredients_thumb_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/ingredients_fr.12.100.jpg",
      "ingredients_n_tags":[  
         "45",
         "41-50"
      ],
      "traces_debug_tags":[  

      ],
      "states_hierarchy":[  
         "en:to-be-checked",
         "en:complete",
         "en:nutrition-facts-completed",
         "en:ingredients-completed",
         "en:expiration-date-to-be-completed",
         "en:characteristics-completed",
         "en:categories-completed",
         "en:brands-completed",
         "en:packaging-completed",
         "en:quantity-completed",
         "en:product-name-completed",
         "en:photos-validated",
         "en:photos-uploaded"
      ],
      "labels_tags":[  
         "en:palm-oil-free",
         "fr:experimentation-etiquetage-nutritionnel-2016",
         "fr:experimentation-nutriscore",
         "fr:experimentation-nutriscore-d"
      ],
      "purchase_places_debug_tags":[  

      ],
      "states":"en:to-be-checked, en:complete, en:nutrition-facts-completed, en:ingredients-completed, en:expiration-date-to-be-completed, en:characteristics-completed, en:categories-completed, en:brands-completed, en:packaging-completed, en:quantity-completed, en:product-name-completed, en:photos-validated, en:photos-uploaded",
      "image_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/front_fr.10.400.jpg",
      "link":"",
      "allergens":"blé, gluten de blé, fromage, fromages, emmental, beurre, lactosérum, beurre",
      "labels_prev_hierarchy":[  
         "en:palm-oil-free",
         "fr:Experimentation Etiquetage Nutritionnel 2016",
         "fr:Experimentation NutriScore",
         "fr:Expérimentation NutriScore D"
      ],
      "serving_size":"150 g",
      "interface_version_created":"upload_photos.pl - version 2016/09/29",
      "allergens_tags":[  
         "en:gluten",
         "en:milk",
         "fr:lactoserum"
      ],
      "image_thumb_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/front_fr.10.100.jpg",
      "unknown_nutrients_tags":[  

      ],
      "ingredients_ids_debug":[  
         "pain-de-mie-49",
         "3",
         "farine-de-ble",
         "eau",
         "huile-de-colza",
         "sel",
         "dextrose",
         "levure",
         "propionate-de-calcium",
         "mono-et-diglycerides-d-acides-gras",
         "lecithines",
         "gluten-de-ble",
         "gomme-xanthane",
         "agent",
         "de-la-farine",
         "acide-ascorbique",
         "fromage-fondu-28",
         "fromages-14",
         "dont-emmental-4",
         "2",
         "beurre",
         "eau",
         "proteines-de-lait",
         "amidons-transformes-de-mais-et-ou-pomme-de-terre",
         "lactoserum",
         "sels",
         "citrates-de-sodium",
         "polyphosphates",
         "carraghenanes",
         "jambon-cuit-choix-sans-polyphosphates-14",
         "7",
         "jambon-de-porc",
         "eau",
         "sel",
         "sirop-de-glucose",
         "dextrose",
         "aromes",
         "erythorbate-de-sodium",
         "nitrite-de-sodium",
         "matiere-grasse-vegetale-raffinee-de-colza",
         "beurre-concentre",
         "carotenoides",
         "mono",
         "diglycerides-d-acides-gras"
      ],
      "last_modified_by":"tacite",
      "categories_hierarchy":[  
         "en:fresh-foods",
         "en:meals",
         "en:sandwiches",
         "en:fresh-meals",
         "fr:croque-monsieur"
      ],
      "fruits-vegetables-nuts_100g_estimate":0,
      "interface_version_modified":"20120622",
      "nutrition_grades":"d",
      "nutrition_grade_fr":"d",
      "purchase_places_tags":[  
         "paris",
         "maison-laffitte"
      ],
      "rev":16,
      "ingredients_that_may_be_from_palm_oil_tags":[  
         "e471-mono-et-diglycerides-d-acides-gras-alimentaires",
         "huile-vegetale"
      ],
      "brands":"Casino",
      "image_front_thumb_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/front_fr.10.100.jpg",
      "countries_tags":[  
         "en:france"
      ],
      "ingredients_text_fr":"Pain de mie 49,3% (farine de _blé_ - eau - huile de colza - sel - dextrose - levure - conservateur : propionate de calcium - émulsifiants : mono- et diglycérides d'acides gras , lécithines - _gluten de blé_ - épaississant : gomme xanthane - agent de traitement de la farine : acide ascorbique) - _fromage_ fondu 28% [_fromages_ 14% (dont _emmental_ 4,2%) - _beurre_ - eau - protéines de lait - amidons transformés de maïs et/ou pomme de terre - _lactosérum_ - sels de fonte : citrates de sodium , polyphosphates - gélifiant : carraghénanes] - jambon cuit choix sans polyphosphates 14,7% (jambon de porc - eau - sel - sirop de glucose - dextrose - arômes - conservateurs : érythorbate de sodium , nitrite de sodium) - matière grasse végétale raffinée de colza - _beurre_ concentré - colorant : caroténoïdes.",
      "code":"3222475893421",
      "debug_param_sorted_langs":[  
         "fr"
      ],
      "ingredients_text_with_allergens_fr":"Pain de mie 49,3% (farine de <span class=\"allergen\">blé</span> - eau - huile de colza - sel - dextrose - levure - conservateur : propionate de calcium - émulsifiants : mono- et diglycérides d'acides gras , lécithines - <span class=\"allergen\">gluten de blé</span> - épaississant : gomme xanthane - agent de traitement de la farine : acide ascorbique) - <span class=\"allergen\">fromage</span> fondu 28% [<span class=\"allergen\">fromages</span> 14% (dont <span class=\"allergen\">emmental</span> 4,2%) - <span class=\"allergen\">beurre</span> - eau - protéines de lait - amidons transformés de maïs et/ou pomme de terre - <span class=\"allergen\">lactosérum</span> - sels de fonte : citrates de sodium , polyphosphates - gélifiant : carraghénanes] - jambon cuit choix sans polyphosphates 14,7% (jambon de porc - eau - sel - sirop de glucose - dextrose - arômes - conservateurs : érythorbate de sodium , nitrite de sodium) - matière grasse végétale raffinée de colza - <span class=\"allergen\">beurre</span> concentré - colorant : caroténoïdes.",
      "ingredients_tags":[  
         "pain-de-mie-49",
         "fromage-fondu",
         "jambon-cuit-choix-sans-polyphosphates-14",
         "matiere-grasse-vegetale-raffinee-de-colza",
         "beurre-concentre",
         "colorant",
         "carotenoides",
         "farine-de-ble",
         "eau",
         "huile-de-colza",
         "sel",
         "dextrose",
         "levure",
         "conservateur",
         "propionate-de-calcium",
         "emulsifiants",
         "mono",
         "et-diglycerides-d-acides-gras",
         "lecithines",
         "gluten-de-ble",
         "epaississant",
         "gomme-xanthane",
         "agent-de-traitement-de-la-farine",
         "acide-ascorbique",
         "fromages",
         "dont-emmental-4",
         "beurre",
         "eau",
         "proteines-de-lait",
         "amidons-transformes-de-mais-et-ou-pomme-de-terre",
         "lactoserum",
         "sels-de-fonte",
         "citrates-de-sodium",
         "polyphosphates",
         "gelifiant",
         "carraghenanes",
         "jambon-de-porc",
         "eau",
         "sel",
         "sirop-de-glucose",
         "dextrose",
         "aromes",
         "conservateurs",
         "erythorbate-de-sodium",
         "nitrite-de-sodium"
      ],
      "brands_tags":[  
         "casino"
      ],
      "manufacturing_places":"",
      "lc":"fr",
      "manufacturing_places_tags":[  

      ],
      "image_ingredients_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/ingredients_fr.12.400.jpg",
      "product_name":"Croque Monsieur Maxi",
      "additives_prev":" [ pain-de-mie-49 -> fr:pain-de-mie-49  ]  [ pain-de-mie -> fr:pain-de-mie  ]  [ pain-de -> fr:pain-de  ]  [ pain -> fr:pain  ]  [ 3 -> fr:3  ]  [ farine-de-ble -> fr:farine-de-ble  ]  [ farine-de -> fr:farine-de  ]  [ farine -> fr:farine  ]  [ eau -> fr:eau  ]  [ huile-de-colza -> fr:huile-de-colza  ]  [ huile-de -> fr:huile-de  ]  [ huile -> fr:huile  ]  [ sel -> fr:sel  ]  [ dextrose -> fr:dextrose  ]  [ levure -> fr:levure  ]  [ propionate-de-calcium -> en:e282  -> exists  ]  [ mono-et-diglycerides-d-acides-gras -> en:e471  -> exists  ]  [ lecithines -> en:e322  -> exists  ]  [ gluten-de-ble -> fr:gluten-de-ble  ]  [ gluten-de -> fr:gluten-de  ]  [ gluten -> fr:gluten  ]  [ gomme-xanthane -> en:e415  -> exists  ]  [ agent -> fr:agent  ]  [ de-la-farine -> fr:de-la-farine  ]  [ de-la -> fr:de-la  ]  [ de -> fr:de  ]  [ acide-ascorbique -> en:e300  -> exists  ]  [ fromage-fondu-28 -> fr:fromage-fondu-28  ]  [ fromage-fondu -> fr:fromage-fondu  ]  [ fromage -> fr:fromage  ]  [ fromages-14 -> fr:fromages-14  ]  [ fromages -> fr:fromages  ]  [ dont-emmental-4 -> fr:dont-emmental-4  ]  [ dont-emmental -> fr:dont-emmental  ]  [ dont -> fr:dont  ]  [ 2 -> fr:2  ]  [ beurre -> fr:beurre  ]  [ eau -> fr:eau  ]  [ proteines-de-lait -> fr:proteines-de-lait  ]  [ proteines-de -> fr:proteines-de  ]  [ proteines -> fr:proteines  ]  [ amidons-transformes-de-mais-et-ou-pomme-de-terre -> fr:amidons-transformes-de-mais-et-ou-pomme-de-terre  ]  [ amidons-transformes-de-mais-et-ou-pomme-de -> fr:amidons-transformes-de-mais-et-ou-pomme-de  ]  [ amidons-transformes-de-mais-et-ou-pomme -> fr:amidons-transformes-de-mais-et-ou-pomme  ]  [ amidons-transformes-de-mais-et-ou -> fr:amidons-transformes-de-mais-et-ou  ]  [ amidons-transformes-de-mais-et -> fr:amidons-transformes-de-mais-et  ]  [ amidons-transformes-de-mais -> fr:amidons-transformes-de-mais  ]  [ amidons-transformes-de -> fr:amidons-transformes-de  ]  [ amidons-transformes -> fr:amidons-transformes  ]  [ amidons -> fr:amidons  ]  [ lactoserum -> fr:lactoserum  ]  [ sels -> fr:sels  ]  [ citrates-de-sodium -> en:e331  -> exists  ]  [ polyphosphates -> en:e452  -> exists  ]  [ carraghenanes -> en:e407  -> exists  ]  [ jambon-cuit-choix-sans-polyphosphates-14 -> fr:jambon-cuit-choix-sans-polyphosphates-14  ]  [ jambon-cuit-choix-sans-polyphosphates -> fr:jambon-cuit-choix-sans-polyphosphates  ]  [ jambon-cuit-choix-sans -> fr:jambon-cuit-choix-sans  ]  [ jambon-cuit-choix -> fr:jambon-cuit-choix  ]  [ jambon-cuit -> fr:jambon-cuit  ]  [ jambon -> fr:jambon  ]  [ 7 -> fr:7  ]  [ jambon-de-porc -> fr:jambon-de-porc  ]  [ jambon-de -> fr:jambon-de  ]  [ jambon -> fr:jambon  ]  [ eau -> fr:eau  ]  [ sel -> fr:sel  ]  [ sirop-de-glucose -> fr:sirop-de-glucose  ]  [ sirop-de -> fr:sirop-de  ]  [ sirop -> fr:sirop  ]  [ dextrose -> fr:dextrose  ]  [ aromes -> fr:aromes  ]  [ erythorbate-de-sodium -> fr:erythorbate-de-sodium  ]  [ erythorbate-de -> fr:erythorbate-de  ]  [ erythorbate -> fr:erythorbate  ]  [ nitrite-de-sodium -> en:e250  -> exists  ]  [ matiere-grasse-vegetale-raffinee-de-colza -> fr:matiere-grasse-vegetale-raffinee-de-colza  ]  [ matiere-grasse-vegetale-raffinee-de -> fr:matiere-grasse-vegetale-raffinee-de  ]  [ matiere-grasse-vegetale-raffinee -> fr:matiere-grasse-vegetale-raffinee  ]  [ matiere-grasse-vegetale -> fr:matiere-grasse-vegetale  ]  [ matiere-grasse -> fr:matiere-grasse  ]  [ matiere -> fr:matiere  ]  [ beurre-concentre -> fr:beurre-concentre  ]  [ beurre -> fr:beurre  ]  [ carotenoides -> en:e160  -> exists  ]  [ mono -> fr:mono  ]  [ diglycerides-d-acides-gras -> fr:diglycerides-d-acides-gras  ]  [ diglycerides-d-acides -> fr:diglycerides-d-acides  ]  [ diglycerides-d -> fr:diglycerides-d  ]  [ diglycerides -> fr:diglycerides  ] ",
      "ingredients":[  
         {  
            "percent":"3",
            "rank":1,
            "id":"pain-de-mie-49",
            "text":"Pain de mie 49‚"
         },
         {  
            "text":"_fromage_ fondu",
            "id":"fromage-fondu",
            "percent":"28",
            "rank":2
         },
         {  
            "percent":"7",
            "rank":3,
            "text":"jambon cuit choix sans polyphosphates 14‚",
            "id":"jambon-cuit-choix-sans-polyphosphates-14"
         },
         {  
            "rank":4,
            "text":"matière grasse végétale raffinée de colza",
            "id":"matiere-grasse-vegetale-raffinee-de-colza"
         },
         {  
            "text":"_beurre_ concentré",
            "id":"beurre-concentre",
            "rank":5
         },
         {  
            "rank":6,
            "id":"colorant",
            "text":"colorant"
         },
         {  
            "rank":7,
            "text":"caroténoïdes.",
            "id":"carotenoides"
         },
         {  
            "text":"farine de _blé_",
            "id":"farine-de-ble"
         },
         {  
            "text":"eau",
            "id":"eau"
         },
         {  
            "id":"huile-de-colza",
            "text":"huile de colza"
         },
         {  
            "id":"sel",
            "text":"sel"
         },
         {  
            "text":"dextrose",
            "id":"dextrose"
         },
         {  
            "id":"levure",
            "text":"levure"
         },
         {  
            "id":"conservateur",
            "text":"conservateur"
         },
         {  
            "id":"propionate-de-calcium",
            "text":"propionate de calcium"
         },
         {  
            "id":"emulsifiants",
            "text":"émulsifiants"
         },
         {  
            "id":"mono",
            "text":"mono"
         },
         {  
            "text":"et diglycérides d'acides gras",
            "id":"et-diglycerides-d-acides-gras"
         },
         {  
            "id":"lecithines",
            "text":"lécithines"
         },
         {  
            "text":"_gluten de blé_",
            "id":"gluten-de-ble"
         },
         {  
            "id":"epaississant",
            "text":"épaississant"
         },
         {  
            "text":"gomme xanthane",
            "id":"gomme-xanthane"
         },
         {  
            "id":"agent-de-traitement-de-la-farine",
            "text":"agent de traitement de la farine"
         },
         {  
            "text":"acide ascorbique",
            "id":"acide-ascorbique"
         },
         {  
            "percent":"14",
            "text":"_fromages_",
            "id":"fromages"
         },
         {  
            "percent":"2",
            "text":"dont _emmental_ 4‚",
            "id":"dont-emmental-4"
         },
         {  
            "id":"beurre",
            "text":"_beurre_"
         },
         {  
            "text":"eau",
            "id":"eau"
         },
         {  
            "id":"proteines-de-lait",
            "text":"protéines de lait"
         },
         {  
            "text":"amidons transformés de maïs et/ou pomme de terre",
            "id":"amidons-transformes-de-mais-et-ou-pomme-de-terre"
         },
         {  
            "text":"_lactosérum_",
            "id":"lactoserum"
         },
         {  
            "id":"sels-de-fonte",
            "text":"sels de fonte"
         },
         {  
            "text":"citrates de sodium",
            "id":"citrates-de-sodium"
         },
         {  
            "id":"polyphosphates",
            "text":"polyphosphates"
         },
         {  
            "id":"gelifiant",
            "text":"gélifiant"
         },
         {  
            "id":"carraghenanes",
            "text":"carraghénanes"
         },
         {  
            "id":"jambon-de-porc",
            "text":"jambon de porc"
         },
         {  
            "id":"eau",
            "text":"eau"
         },
         {  
            "text":"sel",
            "id":"sel"
         },
         {  
            "text":"sirop de glucose",
            "id":"sirop-de-glucose"
         },
         {  
            "text":"dextrose",
            "id":"dextrose"
         },
         {  
            "id":"aromes",
            "text":"arômes"
         },
         {  
            "id":"conservateurs",
            "text":"conservateurs"
         },
         {  
            "id":"erythorbate-de-sodium",
            "text":"érythorbate de sodium"
         },
         {  
            "id":"nitrite-de-sodium",
            "text":"nitrite de sodium"
         }
      ],
      "nutrient_levels_tags":[  
         "en:fat-in-moderate-quantity",
         "en:saturated-fat-in-high-quantity",
         "en:sugars-in-low-quantity",
         "en:salt-in-high-quantity"
      ],
      "additives_n":10,
      "emb_codes_tags":[  

      ],
      "packaging_tags":[  
         "barquette",
         "plastique"
      ],
      "traces_tags":[  
         "en:celery",
         "en:crustaceans",
         "en:eggs",
         "en:fish",
         "en:molluscs",
         "en:mustard",
         "en:nuts",
         "en:soybeans"
      ],
      "labels":"Experimentation Etiquetage Nutritionnel 2016,Experimentation NutriScore,Expérimentation NutriScore D,sans huile de palme",
      "editors_tags":[  
         "tacinte",
         "tacite-mass-editor",
         "tacite"
      ],
      "emb_codes_debug_tags":[  

      ],
      "product_name_fr":"Croque Monsieur Maxi",
      "categories":"Frais,Plats préparés,Sandwichs,Plats préparés frais,Croque-monsieur",
      "max_imgid":"5",
      "purchase_places":"Paris,Maison-Laffitte",
      "nutrition_data_per":"serving",
      "additives_prev_tags":[  
         "en:e282",
         "en:e471",
         "en:e322",
         "en:e415",
         "en:e300",
         "en:e331",
         "en:e452",
         "en:e407",
         "en:e250",
         "en:e160"
      ],
      "complete":1,
      "additives_prev_n":10,
      "manufacturing_places_debug_tags":[  

      ],
      "additives":" [ pain-de-mie-49 -> fr:pain-de-mie-49  ]  [ pain-de-mie -> fr:pain-de-mie  ]  [ pain-de -> fr:pain-de  ]  [ pain -> fr:pain  ]  [ 3 -> en:fd-c  ]  [ farine-de-ble -> fr:farine-de-ble  ]  [ farine-de -> fr:farine-de  ]  [ farine -> fr:farine  ]  [ eau -> fr:eau  ]  [ huile-de-colza -> fr:huile-de-colza  ]  [ huile-de -> fr:huile-de  ]  [ huile -> fr:huile  ]  [ sel -> fr:sel  ]  [ dextrose -> fr:dextrose  ]  [ levure -> fr:levure  ]  [ propionate-de-calcium -> en:e282  -> exists  ]  [ mono-et-diglycerides-d-acides-gras -> en:e471  -> exists  ]  [ lecithines -> en:e322  -> exists  ]  [ gluten-de-ble -> fr:gluten-de-ble  ]  [ gluten-de -> fr:gluten-de  ]  [ gluten -> fr:gluten  ]  [ gomme-xanthane -> en:e415  -> exists  ]  [ agent -> fr:agent  ]  [ de-la-farine -> fr:de-la-farine  ]  [ de-la -> fr:de-la  ]  [ de -> fr:de  ]  [ acide-ascorbique -> en:e300  -> exists  ]  [ fromage-fondu-28 -> fr:fromage-fondu-28  ]  [ fromage-fondu -> fr:fromage-fondu  ]  [ fromage -> fr:fromage  ]  [ fromages-14 -> fr:fromages-14  ]  [ fromages -> fr:fromages  ]  [ dont-emmental-4 -> fr:dont-emmental-4  ]  [ dont-emmental -> fr:dont-emmental  ]  [ dont -> fr:dont  ]  [ 2 -> en:fd-c  ]  [ beurre -> fr:beurre  ]  [ eau -> fr:eau  ]  [ proteines-de-lait -> fr:proteines-de-lait  ]  [ proteines-de -> fr:proteines-de  ]  [ proteines -> fr:proteines  ]  [ amidons-transformes-de-mais-et-ou-pomme-de-terre -> fr:amidons-transformes-de-mais-et-ou-pomme-de-terre  ]  [ amidons-transformes-de-mais-et-ou-pomme-de -> fr:amidons-transformes-de-mais-et-ou-pomme-de  ]  [ amidons-transformes-de-mais-et-ou-pomme -> fr:amidons-transformes-de-mais-et-ou-pomme  ]  [ amidons-transformes-de-mais-et-ou -> fr:amidons-transformes-de-mais-et-ou  ]  [ amidons-transformes-de-mais-et -> fr:amidons-transformes-de-mais-et  ]  [ amidons-transformes-de-mais -> fr:amidons-transformes-de-mais  ]  [ amidons-transformes-de -> fr:amidons-transformes-de  ]  [ amidons-transformes -> fr:amidons-transformes  ]  [ amidons -> fr:amidons  ]  [ lactoserum -> fr:lactoserum  ]  [ sels -> fr:sels  ]  [ citrates-de-sodium -> en:e331  -> exists  ]  [ polyphosphates -> en:e452  -> exists  ]  [ carraghenanes -> en:e407  -> exists  ]  [ jambon-cuit-choix-sans-polyphosphates-14 -> fr:jambon-cuit-choix-sans-polyphosphates-14  ]  [ jambon-cuit-choix-sans-polyphosphates -> fr:jambon-cuit-choix-sans-polyphosphates  ]  [ jambon-cuit-choix-sans -> fr:jambon-cuit-choix-sans  ]  [ jambon-cuit-choix -> fr:jambon-cuit-choix  ]  [ jambon-cuit -> fr:jambon-cuit  ]  [ jambon -> fr:jambon  ]  [ 7 -> en:fd-c  ]  [ jambon-de-porc -> fr:jambon-de-porc  ]  [ jambon-de -> fr:jambon-de  ]  [ jambon -> fr:jambon  ]  [ eau -> fr:eau  ]  [ sel -> fr:sel  ]  [ sirop-de-glucose -> fr:sirop-de-glucose  ]  [ sirop-de -> fr:sirop-de  ]  [ sirop -> fr:sirop  ]  [ dextrose -> fr:dextrose  ]  [ aromes -> fr:aromes  ]  [ erythorbate-de-sodium -> fr:erythorbate-de-sodium  ]  [ erythorbate-de -> fr:erythorbate-de  ]  [ erythorbate -> fr:erythorbate  ]  [ nitrite-de-sodium -> en:e250  -> exists  ]  [ matiere-grasse-vegetale-raffinee-de-colza -> fr:matiere-grasse-vegetale-raffinee-de-colza  ]  [ matiere-grasse-vegetale-raffinee-de -> fr:matiere-grasse-vegetale-raffinee-de  ]  [ matiere-grasse-vegetale-raffinee -> fr:matiere-grasse-vegetale-raffinee  ]  [ matiere-grasse-vegetale -> fr:matiere-grasse-vegetale  ]  [ matiere-grasse -> fr:matiere-grasse  ]  [ matiere -> fr:matiere  ]  [ beurre-concentre -> fr:beurre-concentre  ]  [ beurre -> fr:beurre  ]  [ carotenoides -> en:e160  -> exists  ]  [ mono -> fr:mono  ]  [ diglycerides-d-acides-gras -> fr:diglycerides-d-acides-gras  ]  [ diglycerides-d-acides -> fr:diglycerides-d-acides  ]  [ diglycerides-d -> fr:diglycerides-d  ]  [ diglycerides -> fr:diglycerides  ] ",
      "ingredients_text":"Pain de mie 49,3% (farine de _blé_ - eau - huile de colza - sel - dextrose - levure - conservateur : propionate de calcium - émulsifiants : mono- et diglycérides d'acides gras , lécithines - _gluten de blé_ - épaississant : gomme xanthane - agent de traitement de la farine : acide ascorbique) - _fromage_ fondu 28% [_fromages_ 14% (dont _emmental_ 4,2%) - _beurre_ - eau - protéines de lait - amidons transformés de maïs et/ou pomme de terre - _lactosérum_ - sels de fonte : citrates de sodium , polyphosphates - gélifiant : carraghénanes] - jambon cuit choix sans polyphosphates 14,7% (jambon de porc - eau - sel - sirop de glucose - dextrose - arômes - conservateurs : érythorbate de sodium , nitrite de sodium) - matière grasse végétale raffinée de colza - _beurre_ concentré - colorant : caroténoïdes.",
      "additives_tags":[  
         "en:e282",
         "en:e471",
         "en:e322",
         "en:e415",
         "en:e300",
         "en:e331",
         "en:e452",
         "en:e407",
         "en:e250",
         "en:e160"
      ],
      "nutrition_grades_tags":[  
         "d"
      ],
      "nutrition_score_warning_no_fiber":1,
      "checkers_tags":[  

      ],
      "labels_next_hierarchy":[  
         "en:palm-oil-free",
         "fr:Experimentation Etiquetage Nutritionnel 2016",
         "fr:Experimentation NutriScore",
         "fr:Expérimentation NutriScore D"
      ],
      "traces":"Céleri,Crustacés,Œufs,Poisson,Mollusques,Moutarde,Fruits à coque,Soja",
      "ingredients_debug":[  
         "Pain de mie 49",
         ",",
         null,
         "3% ",
         "(",
         null,
         "farine de _blé_",
         " - ",
         " - ",
         "eau",
         " - ",
         " - ",
         "huile de colza",
         " - ",
         " - ",
         "sel",
         " - ",
         " - ",
         "dextrose",
         " - ",
         " - ",
         "levure",
         " - ",
         " - ",
         " ",
         ":",
         null,
         "  propionate de calcium",
         " - ",
         " - ",
         " ",
         ":",
         null,
         "  mono- et diglycérides d'acides gras ",
         ",",
         null,
         " lécithines",
         " - ",
         " - ",
         "_gluten de blé_",
         " - ",
         " - ",
         " ",
         ":",
         null,
         "  gomme xanthane",
         " - ",
         " - ",
         "agent  ",
         ":",
         null,
         " de la farine ",
         ":",
         null,
         " acide ascorbique)",
         " - ",
         " - ",
         "_fromage_ fondu 28% ",
         "[",
         null,
         "_fromages_ 14% ",
         "(",
         null,
         "dont _emmental_ 4",
         ",",
         null,
         "2%)",
         " - ",
         " - ",
         "_beurre_",
         " - ",
         " - ",
         "eau",
         " - ",
         " - ",
         "protéines de lait",
         " - ",
         " - ",
         "amidons transformés de maïs et/ou pomme de terre",
         " - ",
         " - ",
         "_lactosérum_",
         " - ",
         " - ",
         "sels  ",
         ":",
         null,
         "  citrates de sodium ",
         ",",
         null,
         " polyphosphates",
         " - ",
         " - ",
         " ",
         ":",
         null,
         "  carraghénanes]",
         " - ",
         " - ",
         "jambon cuit choix sans polyphosphates 14",
         ",",
         null,
         "7% ",
         "(",
         null,
         "jambon de porc",
         " - ",
         " - ",
         "eau",
         " - ",
         " - ",
         "sel",
         " - ",
         " - ",
         "sirop de glucose",
         " - ",
         " - ",
         "dextrose",
         " - ",
         " - ",
         "arômes",
         " - ",
         " - ",
         " ",
         ":",
         null,
         "  érythorbate de sodium ",
         ",",
         null,
         " nitrite de sodium)",
         " - ",
         " - ",
         "matière grasse végétale raffinée de colza",
         " - ",
         " - ",
         "_beurre_ concentré",
         " - ",
         " - ",
         " ",
         ":",
         null,
         "  caroténoïdes.",
         "  mono-",
         "diglycérides d'acides gras "
      ],
      "completed_t":1475342970,
      "ingredients_text_fr_debug_tags":[  

      ],
      "ingredients_from_palm_oil_tags":[  

      ],
      "image_nutrition_thumb_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/nutrition_fr.13.100.jpg",
      "packaging_debug_tags":[  

      ],
      "serving_size_debug_tags":[  

      ],
      "categories_prev_tags":[  
         "en:fresh-foods",
         "en:meals",
         "en:sandwiches",
         "en:fresh-meals",
         "fr:croque-monsieur"
      ],
      "labels_next_tags":[  
         "en:palm-oil-free",
         "fr:experimentation-etiquetage-nutritionnel-2016",
         "fr:experimentation-nutriscore",
         "fr:experimentation-nutriscore-d"
      ],
      "creator":"tacinte",
      "lang_debug_tags":[  

      ],
      "languages":{  
         "en:french":6
      },
      "last_image_t":1475161455,
      "photographers_tags":[  
         "tacinte"
      ],
      "link_debug_tags":[  

      ],
      "generic_name_fr_debug_tags":[  

      ],
      "ingredients_from_or_that_may_be_from_palm_oil_n":2,
      "ingredients_that_may_be_from_palm_oil_n":2,
      "languages_codes":{  
         "fr":6
      },
      "origins_debug_tags":[  

      ],
      "image_nutrition_url":"http://static.openfoodfacts.org/images/products/322/247/589/3421/nutrition_fr.13.400.jpg",
      "id":"3222475893421"
   },
   "status":1,
   "code":"3222475893421"
}

Fields within a product

Name

product_name : name of the product : Coca Cola
generic_name : name that shouldn't contain brands : Cola soda
generic_name_LANG_CODE : name that shouldn't contain brands:
- generic_name_fr:soda au cola
- generic_name_en:cola soda

Barcodes

code : barcode of the product (can be EAN-13 or internal codes for some food stores), for products without a barcode, Open Food Facts assigns a number starting with the 200 reserved prefix

List of List of barcodes beginning with a given number

List of barcodes beginning with 3596710

Quantity and unit

quantity : quantity and unit

URL of the product page

url : url of the product page on Open Food Facts

Brands

brands
brands_tags

List of Brands

Individual Brand

Product images

Images ensure the reliability of Open Food Facts data. It provides a primary source and proof of all the structured data. You may therefore want to display it along the structured information.
We encourage you to let your users upload images for products that don't exist yet, and for existing products as well (packaging and information changes over time).
We have different scales of images. Use them wisely to save bandwidth, both for your users and Open Food Facts.

Raw images

image_small_url
image_thumb_url
image_url

Front image

"image_front_url"
"image_front_small_url"
"image_front_thumb_url"

Ingredients image

"image_ingredients_url"
"image_ingredients_small_url"
"image_ingredients_thumb_url"

Nutrition image

"image_nutrition_url"
"image_nutrition_small_url"
"image_nutrition_thumb_url"

Languages

Languages on the packaging of the product.

List of languages present on packaging

List of products with given language on packaging

List of products in Italian and Chinese

http://world.openfoodfacts.org/language/italian/language/chinese.json

List of multilingual products

List of products by language count

Getting suggestions for languages

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=languages&string=a

Labels

labels
labels_tags
labels_fr

For a list of all taxonomized values in all supported languages, please refer to the Global labels taxonomy

List of labels

Individual label

Getting suggestions for labels

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=labels&string=a

Location of a product (from country to store)

Origins of ingredients

origins : origins of ingredients
origins_tags

Manufacturing Places

manufacturing_places : places where manufactured or transformed
manufacturing_places_tags

Cities

cities
cities_tags

Country of products

countries : list of countries where the product is sold
countries_tags
countries_fr

List of Countries

Individual Country

Getting suggestions for Countries

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=countries&string=f

Purchase place of products

purchase_places

List of purchase places

Individual purchase place

Store of products

stores

List of Stores

Individual Store

Composition of a product : ingredients, detected ingredients, traces, allergens

Ingredients

Do not make the assumption that the ingredient is or is not present based on this. Parsing errors happen.

List of ingredients on a specific product

On a product ingredients_text contains the text of the ingredients.
- ingredients_text_fr, ingredients_text_nl… (the package of a product may be multilingual)
- ingredients_text_with_allergens_fr (same with HTML markup around allergens)
This list is parsed and we construct an ingredients and ingredients_tags list, but those will contain synonyms etc. We do not have a full taxonomy for ingredients yet. It's a work in progress.
- ingredients
  - percent: possible detected percentage (still unreliable)
  - rank: the order of the ingredient in the ingredient list
  - id: a slug version of the detected ingredient
  - text: the raw text of the detected ingredient
- ingredients_tags
The ingredients are not yet taxonomized on Open Food Facts. They are taxonomized on Open Beauty Facts
The taxonomies of ingredients need expansion: Global ingredients taxonomy (OFF), Global ingredients taxonomy Open Beauty Facts

List of detected ingredients

List of products where a specific ingredient has been detected

Getting suggestions for ingredients (ONLY FOR OBF at the moment)

http://world.openbeautyfacts.org/cgi/suggest.pl?lc=fr&tagtype=ingredients&string=f

Palm Oil Detection

ingredients_from_palm_oil_n
ingredients_from_palm_oil
ingredients_from_palm_oil_tags
ingredients_that_may_be_from_palm_oil_n
ingredients_that_may_be_from_palm_oil
ingredients_that_may_be_from_palm_oil_tags

Ingredients from palm oil

= List of ingredients from palm oil =

= List of products where a specific ingredient from palm oil has been detected =

Ingredients that may be from palm oil

= List of ingredients that may be from palm oil =

= List of products where a specific ingredient that may be from palm oil has been detected =

Trace of products

traces
traces_tags

List of Traces

Individual Trace

Getting suggestions for traces

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=traces&string=m

Food (or cosmetic) additives

additives_n : number of food additives
additives
additives_tags

For a list of all taxonomized values in all supported languages, please refer to the Global additives taxonomy

List of Additives

Individual Additive

Getting suggestions for additives

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=additives&string=e

Allergens of products

List of allergens

Individual allergen

Getting suggestions for allergens

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=allergens&string=a

Nutrition values

Nutrition data

General structure

The nutrition facts are presented by multiple fields per nutrition fact. Each nutrition fact is presented by a key, i.e. "salt", "fat", etc. The fields can also be found in the taxonomy translation file.

The fields can have the following structure:

key (string) - the value for the nutrition fact key (eg in json: "fiber":"0.5");
key_serving (string) - the value of a serving for type key (eg: in json "carbohydrates_serving":"5.82"). The size of the servig is found in the serving field;
key_value (string) - the standardized value of a serving of 100g (100ml) for type key (eg in json: "salt_100g":"0.19");
key_100g (string) - the standardized value of a serving of 100g (100ml) for type key (eg in json: "salt_100g":"0.19");
key_unit (string) - the units used in the other fields (eg in json: "carbohydrates_unit":"g"). Possible values are "kg", "g", "mg, "µg", "l", "ml", "%" or "";
key_label (string) - a more user friendly text explaining the

Only the nutrition facts that are actually found on the packaging are present in the interface.

List of nutrition keys

The following nutrition keys are supported:

energy
proteins
casein
serum-proteins
nucleotides
carbohydrates
sugars
sucrose
glucose
fructose
lactose
maltose
maltodextrins
starch
polyols
fat
saturated-fat
butyric-acid
caproic-acid
caprylic-acid
capric-acid
lauric-acid
myristic-acid
palmitic-acid
stearic-acid
arachidic-acid
behenic-acid
lignoceric-acid
cerotic-acid
montanic-acid
melissic-acid
monounsaturated-fat
polyunsaturated-fat
omega-3-fat
alpha-linolenic-acid
eicosapentaenoic-acid
docosahexaenoic-acid
omega-6-fat
linoleic-acid
arachidonic-acid
gamma-linolenic-acid
dihomo-gamma-linolenic-acid
omega-9-fat
oleic-acid
elaidic-acid
gondoic-acid
mead-acid
erucic-acid
nervonic-acid
trans-fat
cholesterol
fiber
sodium
alcohol: % vol of alcohol
vitamin-a
vitamin-d
vitamin-e
vitamin-k
vitamin-c
vitamin-b1
vitamin-b2
vitamin-pp
vitamin-b6
vitamin-b9
vitamin-b12
biotin
pantothenic-acid
silica
bicarbonate
potassium
chloride
calcium
phosphorus
iron
magnesium
zinc
copper
manganese
fluoride
selenium
chromium
molybdenum
iodine
caffeine
taurine

Specific nutrition keys

carbon-footprint_100g : carbon footprint (indicated on some products)
ph_100g : pH (no unit)
cocoa - minimal cacao content of the product in %. Note the TYPO.
fruits-vegetables-nuts_100g : % of fruits, vegetables and nuts (excluding potatoes, yams, manioc)

nutrition-score-fr_100g : experimental nutrition score derived from the UK FSA score and adapted for the French market (formula defined by the team of Professor Hercberg)
nutrition-score-uk_100g : nutrition score defined by the UK Food Standards Administration (FSA)

Nutrition grades

For more details, see the page explaining the grade computation
nutrition_score_debug: lets you see the calculations made

"nutrition_score_debug":" -- energy 3 + sat-fat 6 + fr-sat-fat-for-fats 6 + sugars 0 + sodium 6 - fruits 0% 0 - fiber 0 - proteins 5 -- fsa 15 -- fr 15"

List of all nutrition grades

List of products with a given nutrition grade (from A to E, including unknown)

Nutrients levels

List of all nutrition levels

List of products with fat in low quantity

Unknown Nutrients

They might be unknown for a good reason…

List of Unknown Nutrients

Individual Unknown Nutrients

Packaging

packaging : shape, material
packaging_tags
Packaging are not taxonomized yet.

List of Packagings

Individual Packaging

Packager codes

emb_codes
emb_codes_tags
first_packaging_code_geo : coordinates corresponding to the first packaging code indicated

List of Packager codes

List of products with given Packager code

=EMB (France specific)=

=EU Codes (Europe-wide) =

= Note =

Other codes might be present, but we don't have specific support yet

List of Packaging cities

List of products with given Packaging city

Contributors

Photographers

Informers

Product status & modification history

creator : contributor who first added the product
created_t : date that the product was added (UNIX timestamp format)
created_datetime : date that the product was added (iso8601 format: yyyy-mm-ddThh:mn:ssZ)
last_modified_t : date that the product page was last modified
last_modified_datetime

Status of products

For all possible values, please refer to the Global states taxonomy

List of States

Individual Status

Getting suggestions for states

http://world.openfoodfacts.org/cgi/suggest.pl?lc=fr&tagtype=states&string=a

Last Edit Dates

List of Last Edit Dates

List of products with a given last edit date

Entry dates

List of entry dates

List of products with a given entry date

Searching for products

Generic Search

Core principle: Combine tags to get custom results

Combining tags is really powerful, letting you create thousands of custom APIs for your use case.

http://world.openfoodfacts.org/packager-code/emb-35069c/brand/sojasun.json

Advanced Search

Query examples

http://world.openfoodfacts.org/cgi/search.pl?search_terms=coke&search_simple=1&jqm=1

http://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&json=1

http://world.openfoodfacts.org/cgi/search.pl?search_terms=banania&search_simple=1&action=process&xml=1

Parameters

You can basically use all the parameters you'd use in a graphical advanced search on the site

search_url = "http://world.openfoodfacts.org/cgi/search.pl"
search_terms2 # search terms

# FIRST CRITERIA (TAG0)

tagtype_0
search_tag # choose a criterion...

# CRITERION
brands # brands
categories # categories
packaging # packaging
labels # labels
origins # origins of ingredients
manufacturing_places # manufacturing or processing places
emb_codes # packager codes
purchase_places # purchase places
stores # stores
countries # countries
additives # additives
allergens # allergens
traces # traces
nutrition_grades # Nutrition grades
states # states
	
# Contains or Not
tag_contains_0
contains
does_not_contain

# Value of Tag (free text)
tag_0

#additives 
additives 
without # without_additives
with # with_additives
indifferent # indifferent_additives

# Ingredients from palm oil
ingredients_from_palm_oil 
without
with
indifferent	

# Ingredients that may be from palm oil
ingredients_that_may_be_from_palm_oil
without
with
indifferent

#ingredients_from_or_that_may_be_from_palm_oi
ingredients_from_or_that_may_be_from_palm_oil
without
with
indifferent


# Nutrients

nutriment_0

search_nutriment # choose a nutriment...

energy # Energy
energy-from-fat # Energy from fat
fat # Fat
saturated-fat # Saturated fat
butyric-acid # Butyric acid (4:0)
caproic-acid # Caproic acid (6:0)
caprylic-acid # Caprylic acid (8:0)
capric-acid # Capric acid (10:0)
lauric-acid # Lauric acid (12:0)
myristic-acid # Myristic acid (14:0)
palmitic-acid # Palmitic acid (16:0)
stearic-acid # Stearic acid (18:0)
arachidic-acid # Arachidic acid (20:0)
behenic-acid # Behenic acid (22:0)
lignoceric-acid # Lignoceric acid (24:0)
cerotic-acid # Cerotic acid (26:0)
montanic-acid # Montanic acid (28:0)
melissic-acid # Melissic acid (30:0)
monounsaturated-fat # Monounsaturated fat
polyunsaturated-fat # Polyunsaturated fat
omega-3-fat # Omega 3 fatty acids
alpha-linolenic-acid # Alpha-linolenic acid / ALA (18:3 n-3)
eicosapentaenoic-acid # Eicosapentaenoic acid / EPA (20:5 n-3)
docosahexaenoic-acid # Docosahexaenoic acid / DHA (22:6 n-3)
omega-6-fat # Omega 6 fatty acids
linoleic-acid # Linoleic acid / LA (18:2 n-6)
arachidonic-acid # Arachidonic acid / AA / ARA (20:4 n-6)
gamma-linolenic-acid # Gamma-linolenic acid / GLA (18:3 n-6)
dihomo-gamma-linolenic-acid # Dihomo-gamma-linolenic acid / DGLA (20:3 n-6)
omega-9-fat # Omega 9 fatty acids
oleic-acid # Oleic acid (18:1 n-9)
elaidic-acid # Elaidic acid (18:1 n-9)
gondoic-acid # Gondoic acid (20:1 n-9)
mead-acid # Mead acid (20:3 n-9)
erucic-acid # Erucic acid (22:1 n-9)
nervonic-acid # Nervonic acid (24:1 n-9)
trans-fat # Trans fat
cholesterol # Cholesterol
carbohydrates # Carbohydrate
sugars # Sugars
sucrose # Sucrose
glucose # Glucose
fructose # Fructose
lactose # Lactose
maltose # Maltose
maltodextrins # Maltodextrins
starch # Starch
polyols # Sugar alcohols (Polyols)
fiber # Dietary fiber
proteins # Proteins
casein # casein
serum-proteins # Serum proteins
nucleotides # Nucleotides
salt # Salt
sodium # Sodium
alcohol # Alcohol
vitamin-a # Vitamin A
beta-carotene # Beta carotene
vitamin-d # Vitamin D
vitamin-e # Vitamin E
vitamin-k # Vitamin K
vitamin-c # Vitamin C (ascorbic acid)
vitamin-b1 # Vitamin B1 (Thiamin)
vitamin-b2 # Vitamin B2 (Riboflavin)
vitamin-pp # Vitamin B3 / Vitamin PP (Niacin)
vitamin-b6 # Vitamin B6 (Pyridoxin)
vitamin-b9 # Vitamin B9 (Folic acid / Folates)
vitamin-b12 # Vitamin B12 (cobalamin)
biotin # Biotin
pantothenic-acid # Pantothenic acid / Pantothenate (Vitamin B5)
silica # Silica
bicarbonate # Bicarbonate
potassium # Potassium
chloride # Chloride
calcium # Calcium
phosphorus # Phosphorus
iron # Iron
magnesium # Magnesium
zinc # Zinc
copper # Copper
manganese # Manganese
fluoride # Fluoride
selenium # Selenium
chromium # Chromium
molybdenum # Molybdenum
iodine # Iodine
caffeine # Caffeine
taurine # Taurine
ph # pH
fruits-vegetables-nuts # Fruits, vegetables and nuts (minimum)
collagen-meat-protein-ratio # Collagen/Meat protein ratio (maximum)
cocoa # Cocoa (minimum)
chlorophyl # Chlorophyl
carbon-footprint # Carbon footprint / CO2 emissions
nutrition-score-fr # Experimental nutrition score
nutrition-score-uk # Nutrition score - UK

# Comparison of nutrients
# Nutriment to compare
nutriment_compare_0

# Operator
lt # less than
lte # less than or equal
gt # greater than
gte # greater than or equal
eq # equal to
		
# Value to compare the nutrients to
nutriment_value_0

# Output
sort_by # sort_by
unique_scans_n # Popularity
product_name # Product name
created_t # Add date
last_modified_t # Edit date


# Results per page	
page_size # page_size
20 # 20
50 # 50
100 # 100
250 # 250
500 # 500
1000 # 1000

#Pagination
page=1

#Format
json=1
xml=1
#to search results pages on the web site to get results in a jQuery Mobile format.
jqm=1

WRITE API Documentation

Status Codes

If the edit was successful

{"status_verbose":"fields saved","status":1}

If there was an issue

Wrong password

HTML 200 code + an html page with a link to login

Example: http://world.openfoodfacts.org/cgi/product_jqm2.pl?code=0048151623426&user_id=usernameexample&password=*****&product_name=KIRI%2

Authentification

user_id
password

WARNING: If the password is not correct, the API will currently "silently" fail, both for image addition and product data addition (will return HTML 200 code + an html page with a link to login - example )

Anonymous contribution

It is possible for new products (no anonymous modification is possible though, for obvious reasons)
It is possible for adding images (as many as you like)
If you detect an error 200 (wrong password), please retry the query without user_id and password. That way the contribution will be accepted. Otherwise, the photo will get lost :(

Global account

If you want to avoid coding the detection of password errors, login stuff… you can create a global account for all your users.

You can create a global account to let the users of your app contribute. please name it YourApp_app or something like that, so that we can spot them easily. Better yet, introduce yourself on Slack :-)

Manipulating photos for a product

Understanding products and photos

Photos are the primary source of Open Food Facts.
We need good photos or the product, of its ingredients and nutrition table. (and for each language present on the packaging)
Please encourage your users to add as many photos as possible, even if the product is already complete (in that case, don't set them as default photos for front, ingredients, and nutrition)

Understanding photos for multilingual products

Multilingual products have several photos based on languages present on the packaging. Just suffix the lang code to our examples to get or add the relevant language(s).

Adding photos for a product

Use the POST method on:

Test server: http://world.openfoodfacts.net/cgi/product_image_upload.pl

Live server: http://world.openfoodfacts.org/cgi/product_image_upload.pl

^{(remember to do tests on world.openfoodfacts.net - login and password: off )}

Parameters

code: the barcode
imagefield: (front | ingredients | nutrition)
imgupload_front : your image file if imagefield:front
imgupload_ingredients: your image file if imagefield:ingredients
imgupload_nutrition: your image file if imagefield:nutrition

Important

There must be a HTTP header "Content-Type: multipart/form-data" in the HTTP POST request.
The imageupload_(front|ingredients|nutrition) name, size and data needs to be encoded in the multipart/form-data format, usually your HTTP request library will do that for you.
All parameters need to be passed as POST parameters, do not put some in the URL.
0048151623426 is a random barcode used only for demonstration purposes.

Getting a list of all available photos

You get a list of all available photos in the product JSON (both selected photos for all languages, and Raw photos (source images for the selected images and images that are not used)

Properties of a photo

id = 5
uploaded_t = 1474912158 (UNIX timestamp format)
uploader = tacinte (contributor slug)
sizes

100 "h":100, "w":75

400

"h":400, "w":300

full

"w":3120, "h":4160

Properties of a selected photo

nutrition_fr
y1 = 151.8125
normalize":"true",
x2":"169.75",
rev":"13",
geometry":"1238x1238-527-1578"
sizes
100

"h":100, "w":75

200
400

"h":400, "w":300

full

"w":3120, "h":4160

y2 = 270.8125
x1 = 50.75
angle = 0
white_magic = false
imgid = 4

      "images":{  
         "front_fr":{  
            "y2":"340.8125",
            "x1":"67.75",
            "angle":"0",
            "imgid":"5",
            "white_magic":"false",
            "x2":"245.75",
            "normalize":"true",
            "y1":"13.8125",
            "rev":"10",
            "geometry":"1851x3401-704-143",
            "sizes":{  
               "400":{  
                  "w":218,
                  "h":400
               },
               "full":{  
                  "h":3401,
                  "w":1851
               },
               "100":{  
                  "w":54,
                  "h":100
               },
               "200":{  
                  "h":200,
                  "w":109
               }
            }
         },
         "2":{  
            "sizes":{  
               "400":{  
                  "h":400,
                  "w":300
               },
               "full":{  
                  "h":4160,
                  "w":3120
               },
               "100":{  
                  "w":75,
                  "h":100
               }
            },
            "uploaded_t":"1474912149",
            "uploader":"tacinte"
         },
         "5":{  
            "uploaded_t":"1474912158",
            "uploader":"tacinte",
            "sizes":{  
               "100":{  
                  "h":100,
                  "w":75
               },
               "400":{  
                  "h":400,
                  "w":300
               },
               "full":{  
                  "w":3120,
                  "h":4160
               }
            }
         },
         "3":{  
            "uploaded_t":"1474912152",
            "uploader":"tacinte",
            "sizes":{  
               "full":{  
                  "w":3120,
                  "h":4160
               },
               "400":{  
                  "h":400,
                  "w":300
               },
               "100":{  
                  "h":100,
                  "w":75
               }
            }
         },
         "nutrition_fr":{  
            "y1":"151.8125",
            "normalize":"true",
            "x2":"169.75",
            "rev":"13",
            "geometry":"1238x1238-527-1578",
            "sizes":{  
               "full":{  
                  "w":1238,
                  "h":1238
               },
               "400":{  
                  "h":400,
                  "w":400
               },
               "100":{  
                  "w":100,
                  "h":100
               },
               "200":{  
                  "w":200,
                  "h":200
               }
            },
            "y2":"270.8125",
            "x1":"50.75",
            "angle":"0",
            "white_magic":"false",
            "imgid":"4"
         },
         "4":{  
            "sizes":{  
               "400":{  
                  "w":300,
                  "h":400
               },
               "full":{  
                  "h":4160,
                  "w":3120
               },
               "100":{  
                  "h":100,
                  "w":75
               }
            },
            "uploader":"tacinte",
            "uploaded_t":"1474912154"
         },
         "ingredients_fr":{  
            "y2":"248.8125",
            "x1":"82.75",
            "angle":"0",
            "white_magic":"false",
            "imgid":"3",
            "normalize":"true",
            "y1":"158.8125",
            "x2":"257.75",
            "rev":"12",
            "sizes":{  
               "full":{  
                  "w":1820,
                  "h":936
               },
               "400":{  
                  "h":206,
                  "w":400
               },
               "100":{  
                  "h":51,
                  "w":100
               },
               "200":{  
                  "h":103,
                  "w":200
               }
            },
            "geometry":"1820x936-860-1651"
         },
         "1":{  
            "sizes":{  
               "full":{  
                  "w":3120,
                  "h":4160
               },
               "400":{  
                  "h":400,
                  "w":300
               },
               "100":{  
                  "w":75,
                  "h":100
               }
            },
            "uploaded_t":"1474912148",
            "uploader":"tacinte"
         }
      },

Adding a photo to the list of all available photos

Getting the current global photo

Setting a new current global photo

Getting the current ingredients photo

Setting a new current ingredients photo

Getting the current nutrition photo

Setting a new current nutrition photo

Choosing the product by barcode

code=

Values:

Selecting a photo

imgid=

Values:

Rotating a photo

Test server: http://world.openfoodfacts.net/cgi/product_image_rotate.pl

Live server: http://world.openfoodfacts.org/cgi/product_image_rotate.pl

Values and output

Parameters:

imgid =
code = BARCODE
angle = Angle of the rotation - 90° increments
normalize = whether the source image should be normalized
white_magic = whether the source image should be "white magic"'d ( background removal)

function update_image(imagefield) {

	$('#crop_' + imagefield).attr("src","/cgi/product_image_rotate.pl?code=" + code + "&imgid=" + imagefield_imgid[imagefield]
		+ "&angle=" + angles[imagefield] + "&normalize=" + $("#normalize_" + imagefield).prop('checked')
		+ "&white_magic=" + $("#white_magic_" + imagefield).prop('checked')		);
	$('div[id="cropbuttonmsg_' + imagefield +'"]').hide();
}

Removing background on a photo ("White magic")

This will work best on photos with a white background. Best use case is to let user try it and give up if the result is not satisfying.

white_magic=

Values:

Color correction on a photo ("Normalize")

normalize=

Values:

Cropping a photo

This implies applying operations to a source image (not only cropping, but all the others if applicable). We start from a source image (defined by a barcode and incremental id), apply cropping parameters (x1, y1, x2, y2), additional operations (white_magic, normalize)

Test server: http://world.openfoodfacts.net/cgi/product_image_crop.pl

Live server: http://world.openfoodfacts.org/cgi/product_image_crop.pl

Values

code=BARCODE
id=
angle= Angle of the rotation
normalize = whether the source image should be normalized
white_magic = whether the source image should be white magiced ( background removal)
type = add
action = display
imgid =
x1= the X origin of the crop
y1=the Y origin of the crop
x2=the X end of the crop
y2=the Y end of the crop

Ignore me

$.post('/cgi/product_image_crop.pl',
						{code: code, id: imagefield , imgid: imgid,
						x1:selection.x, y1:selection.y, x2:selection.x + selection.width, y2:selection.y + selection.height,
						angle:angles[imagefield], normalize:$("#normalize_" + imagefield).prop('checked'), 
						white_magic:$("#white_magic_" + imagefield).prop('checked') }, function(data) {
						
					imagefield_url[imagefield] = data.image.display_url;
					update_display(imagefield, false);
					$('div[id="cropbutton_' + imagefield +'"]').show();
					$('div[id="cropbuttonmsg_' + imagefield +'"]').html(Lang.image_saved);
					$(document).foundation('equalizer', 'reflow');
				}, 'json');
			});

Performing OCR on a photo

We start from a source image (defined by barcode and id) as selected for ingredients. We ask Product Opener to process it (process_image=1). Product Opener returns a JSON. Processing is done using Tesseract (3 on preprod). The result is often cripped with errors. Take steps to avoid direct copy pasting into the ingredients field by your users.

Test server: http://world.openfoodfacts.net/cgi/ingredients.pl

Live server: http://world.openfoodfacts.net/cgi/ingredients.pl

Values and output

code=code
id=imagefield
process_image=1

This will return JSON

Ignore me

		$.post('/cgi/ingredients.pl',
				{ }, function(data) {
				
			if (data.status == 0) {
				$('div[id="ocrbuttondiv_' + imagefield +'"]').html(Lang.extracted_ingredients_ok);
				var ingredients_text_id = imagefield.replace("ingredients","ingredients_text");
				$("#" + ingredients_text_id).val(data.ingredients_text_from_image);
			}
			else {
				$('div[id="ocrbuttondiv_' + imagefield +'"]').html(Lang.extracted_ingredients_nok);
			}
			$(document).foundation('equalizer', 'reflow');
		}, 'json');

Posting a new product

URL:
```
http://world.openfoodfacts.org/cgi/product_jqm2.pl
```
(Product post)^{(remember to do tests on world.openfoodfacts.net - login and password: off )}

URL for your tests :

http://world.openfoodfacts.net/cgi/product_jqm2.pl

Quick overview

var foodfact = { barcode : '0048151623426', name : 'Product name', energy: 500, energy_unit: "kJ", weight: 282 };
var postData = {
code : foodfact.barcode,
user_id : "mesinfosnutritionelles",
password : "****",
product_name : foodfact.name?foodfact.name:foodfact.shop_label,
quantity : foodfact.weight?""+foodfact.weight+" g":undefined,
stores : "Walmart",
nutriment_energy :foodfact.energy,
nutriment_energy_unit :foodfact.energy_unit,
nutrition_data_per :"serving"

Status after save

{"status_verbose":"fields saved","status":1}

Example

^{(remember to do tests on world.openfoodfacts.net - login and password: off)}

Query 1 : Unauthentified query

http://world.openfoodfacts.net/cgi/product_jqm2.pl?code=0048151623426&product_name=Maryland%20Choc%20Chip&quantity=230g&brand=Golden%20Cookies&nutriment_energy=450&nutriment_energy_unit=kJ&nutrition_data_per=serving&ingredients_text=Fortified%20wheat%20flour%2C%20Chocolate%20chips%20%2825%25%29%2C%20Sugar%2C%20Palm%20oil%2C%20Golden%20syrup%2C%20Whey%20and%20whey%20derivatives%20%28Milk%29%2C%20Raising%20agents%2C%20Salt%2C%20Flavouring&traces=Milk%2C+Soya%2C+Nuts%2C+Wheat

Result 2

http://uk.openfoodfacts.net/product/0072417136160/maryland-choc-chip

Query 2 : Authentified query

http://world.openfoodfacts.org/cgi/product_jqm2.pl?code=0048151623426&user_id=usernameexample&password=*****&product_name=KIRI%20GOUTER%20280G%208%20PORTIONS&quantity=282%20g&stores=Intermarch%C3%A9&nutriment_energy=500&nutriment_energy_unit=kJ&nutrition_data_per=serving

Result 2

If credentials are correct

Standard success status, see above

If credentials are not correct

Will give you a responsive HTML login page.

See editing a product for details on fields

Posting several values for a field

When adding values, send to the field labels as comma separated values that are canonicalised and added to the _tags array

labels = "labelA, labelB"

Reading back, use labels_tags to get an array of labels

Editing an existing product

Posting additional photos

Photos post on /cgi/product_image_upload.pl
- code: the barcode
- imagefield: (front | ingredients | nutrition)

Select the Front picture

imgupload_front : your image file if imagefield:front

Select the Ingredients picture

imgupload_ingredients: your image file if imagefield:ingredients

Select the Nutrition Facts picture

imgupload_nutrition: your image file if imagefield:nutrition

Editing the product

Give the barcode

code=072417136160

Add the brand

brand=Heinz

Add the name

product_name=Maryland%20Choc%20Chip

Add the quantity

quantity=230g

Add the packager code

emb_codes=EMB%2013330

Add the packaging type

packaging=Cardboard

Add the labels

labels=Vegan%2C%20Fat%20free

Add the Stores where bought

stores=Intermarch%C3%A9

Add the category

categories=Cookies

Add the best before date

expiration_date=

Add the link to the official webpage of the product

link=

Add the ingredients

ingredients_text=Fortified%20wheat%20flour%2C%20Chocolate%20chips%20%2825%25%29%2C%20Sugar%2C%20Palm%20oil%2C%20Golden%20syrup%2C%20Whey%20and%20whey%20derivatives%20%28Milk%29%2C%20Raising%20agents%2C%20Salt%2C%20Flavouring

Add ingredient traces

traces=Milk%2C+Soya%2C+Nuts%2C+Wheat

Add the main language

You can set the main language of the product.

lang=fr

(NOT LIVE YET) In the case of a multilingual product, you can specify the main language of the product, and you can then specify values and images for different languages by suffixing the language code to the other fields.

Add the nutrition facts

Indicate the absence of nutrition facts

no_nutriments : indicates if the nutrition facts are indicated on the food label

Add nutrition facts values, units and base

Define the basis for the values

nutrition_data_per=100g

OR

nutrition_data_per=serving

serving_size=38g

Input values and units

nutriment_energy=450

nutriment_energy_unit=kJ

Values

nutriment_energy
nutriment_proteins
nutriment_casein
nutriment_serum-proteins
nutriment_nucleotides
nutriment_carbohydrates
nutriment_sugars
nutriment_sucrose
nutriment_glucose
nutriment_fructose
nutriment_lactose
nutriment_maltose
nutriment_maltodextrins
nutriment_starch
nutriment_polyols
nutriment_fat
nutriment_saturated-fat
nutriment_butyric-acid
nutriment_caproic-acid
nutriment_caprylic-acid
nutriment_capric-acid
nutriment_lauric-acid
nutriment_myristic-acid
nutriment_palmitic-acid
nutriment_stearic-acid
nutriment_arachidic-acid
nutriment_behenic-acid
nutriment_lignoceric-acid
nutriment_cerotic-acid
nutriment_montanic-acid
nutriment_melissic-acid
nutriment_monounsaturated-fat
nutriment_polyunsaturated-fat
nutriment_omega-3-fat
nutriment_alpha-linolenic-acid
nutriment_eicosapentaenoic-acid
nutriment_docosahexaenoic-acid
nutriment_omega-6-fat
nutriment_linoleic-acid
nutriment_arachidonic-acid
nutriment_gamma-linolenic-acid
nutriment_dihomo-gamma-linolenic-acid
nutriment_omega-9-fat
nutriment_oleic-acid
nutriment_elaidic-acid
nutriment_gondoic-acid
nutriment_mead-acid
nutriment_erucic-acid
nutriment_nervonic-acid
nutriment_trans-fat
nutriment_cholesterol
nutriment_fiber
nutriment_sodium
nutriment_alcohol : % vol of alcohol
nutriment_vitamin-a
nutriment_vitamin-d
nutriment_vitamin-e
nutriment_vitamin-k
nutriment_vitamin-c
nutriment_vitamin-b1
nutriment_vitamin-b2
nutriment_vitamin-pp
nutriment_vitamin-b6
nutriment_vitamin-b9
nutriment_vitamin-b12
nutriment_biotin
nutriment_pantothenic-acid
nutriment_silica
nutriment_bicarbonate
nutriment_potassium
nutriment_chloride
nutriment_calcium
nutriment_phosphorus
nutriment_iron
nutriment_magnesium
nutriment_zinc
nutriment_copper
nutriment_manganese
nutriment_fluoride
nutriment_selenium
nutriment_chromium
nutriment_molybdenum
nutriment_iodine
nutriment_caffeine
nutriment_taurine
nutriment_ph : pH (no unit)

Units

nutriment_energy_unit
nutriment_proteins_unit
nutriment_casein_unit
nutriment_serum-proteins_unit
nutriment_nucleotides_unit
nutriment_carbohydrates_unit
nutriment_sugars_unit
nutriment_sucrose_unit
nutriment_glucose_unit
nutriment_fructose_unit
nutriment_lactose_unit
nutriment_maltose_unit
nutriment_maltodextrins_unit
nutriment_starch_unit
nutriment_polyols_unit
nutriment_fat_unit
nutriment_saturated-fat_unit
nutriment_butyric-acid_unit
nutriment_caproic-acid_unit
nutriment_caprylic-acid_unit
nutriment_capric-acid_unit
nutriment_lauric-acid_unit
nutriment_myristic-acid_unit
nutriment_palmitic-acid_unit
nutriment_stearic-acid_unit
nutriment_arachidic-acid_unit
nutriment_behenic-acid_unit
nutriment_lignoceric-acid_unit
nutriment_cerotic-acid_unit
nutriment_montanic-acid_unit
nutriment_melissic-acid_unit
nutriment_monounsaturated-fat_unit
nutriment_polyunsaturated-fat_unit
nutriment_omega-3-fat_unit
nutriment_alpha-linolenic-acid_unit
nutriment_eicosapentaenoic-acid_unit
nutriment_docosahexaenoic-acid_unit
nutriment_omega-6-fat_unit
nutriment_linoleic-acid_unit
nutriment_arachidonic-acid_unit
nutriment_gamma-linolenic-acid_unit
nutriment_dihomo-gamma-linolenic-acid_unit
nutriment_omega-9-fat_unit
nutriment_oleic-acid_unit
nutriment_elaidic-acid_unit
nutriment_gondoic-acid_unit
nutriment_mead-acid_unit
nutriment_erucic-acid_unit
nutriment_nervonic-acid_unit
nutriment_trans-fat_unit
nutriment_cholesterol_unit
nutriment_fiber_unit
nutriment_sodium_unit
nutriment_alcohol_unit : % vol of alcohol
nutriment_vitamin-a_unit
nutriment_vitamin-d_unit
nutriment_vitamin-e_unit
nutriment_vitamin-k_unit
nutriment_vitamin-c_unit
nutriment_vitamin-b1_unit
nutriment_vitamin-b2_unit
nutriment_vitamin-pp_unit
nutriment_vitamin-b6_unit
nutriment_vitamin-b9_unit
nutriment_vitamin-b12_unit
nutriment_biotin_unit
nutriment_pantothenic-acid_unit
nutriment_silica_unit
nutriment_bicarbonate_unit
nutriment_potassium_unit
nutriment_chloride_unit
nutriment_calcium_unit
nutriment_phosphorus_unit
nutriment_iron_unit
nutriment_magnesium_unit
nutriment_zinc_unit
nutriment_copper_unit
nutriment_manganese_unit
nutriment_fluoride_unit
nutriment_selenium_unit
nutriment_chromium_unit
nutriment_molybdenum_unit
nutriment_iodine_unit
nutriment_caffeine_unit
nutriment_taurine_unit
nutriment_ph_unit : pH (no unit)

Adding the alcohol % of wine

12% wine

nutriment_unit=%25%20vol&nutriment_alcohol=12

Adding the carbon footprint

nutriment_carbon-footprint

nutriment_carbon-footprint_unit

Adding a comment to your edit

comment=Automated%20Edit

Open Beauty Facts experimental and specific APIs

Ingredients

Very experimental. Do not rely on this for allergen or ingredient parsing yet.

List of ingredients detected by the current experimental parser

Products where the current experimental parser could not detect aluminium salts

Products where the current experimental parser could detect aluminium salts

Periods after Opening

Periods after opening taxonomy

List of periods after opening

List of products with a given period after opening

@@ Line 1,968: / Line 1,968: @@
 WARNING: If the password is not correct, the API will currently "silently" fail, both for image addition and product data addition (will return HTML 200 code + an html page with a link to login - [http://world.openfoodfacts.org/cgi/product_jqm2.pl?code=0048151623426&user_id=usernameexample&password=*****&product_name=KIRI%2 example] )
+==== Anonymous contribution ====
+* It is possible for new products (no anonymous modification is possible though, for obvious reasons)
+* It is possible for adding images (as many as you like)
+* If you detect an error 200 (wrong password), please retry the query without user_id and password. That way the contribution will be accepted. Otherwise, the photo will get lost :(
 ==== Global account ====
+If you want to avoid coding the detection of password errors, login stuff… you can create a global account for all your users.
 You can create a global account to let the users of your app contribute. please name it YourApp_app or something like that, so that we can spot them easily. Better yet, introduce yourself on Slack :-)

Revision as of 16:44, 29 November 2016

Introduction

Current status of the API

Getting help with the API

How to test the API

READ operations

Technical details

Licence

WRITE operations

Use cases

A few things

Conventions for the API

Language Bindings

Roadmap

Bugs

Reporting bugs

Known bugs

READ API Documentation

Downloading static data

CSV API

Encoding

MongoDB dump

Field reference

JSON interface

Countries

Reading a product

Structure of the call

Status codes

If a product is not found

If the product is found properly

Fields within a product

Name

Barcodes

List of List of barcodes beginning with a given number

List of barcodes beginning with 3596710

Quantity and unit

URL of the product page

Brands

List of Brands

Individual Brand

Product images

Raw images

Front image

Ingredients image

Nutrition image

Languages

List of languages present on packaging

List of products with given language on packaging

List of products in Italian and Chinese

List of multilingual products

List of products by language count

Getting suggestions for languages

Labels

List of labels

Individual label

Getting suggestions for labels

Categories

Hierarchy

List of categories

Individual category

Getting suggestions for categories

Location of a product (from country to store)

Origins of ingredients

Manufacturing Places

Cities

Country of products

List of Countries

Individual Country

Getting suggestions for Countries

Purchase place of products

List of purchase places

Individual purchase place

Store of products

List of Stores

Individual Store

Composition of a product : ingredients, detected ingredients, traces, allergens

Ingredients

List of ingredients on a specific product

List of detected ingredients

List of products where a specific ingredient has been detected