Difference between revisions of "API/Read"

From Open Food Facts wiki
Jump to navigation Jump to search
m (Vaiton moved page API/Read to Read API)
 
(14 intermediate revisions by 7 users not shown)
Line 1: Line 1:
[[Category:Developer]] [[Category:API]]
+
[[Category:Developer]]
<< Back to [[API]] (required read)
+
[[Category:API]]
  
'''Please send a UserAgent HTTP Header with the name of the app/service querying, the version, system and an url if you have one''', so that you are not blocked by mistake*
+
[[API|← Back to API]] (required read)
* e.g. UserAgent: CoolFoodApp - Android - Version 1.0 - https://coolfoodapp.com
+
 
 +
== Use the API ==
 +
To use the read API, please check out the [https://openfoodfacts.github.io/openfoodfacts-server/api/ API documentation] and [https://openfoodfacts.github.io/openfoodfacts-server/api/ref-v2/#get-/api/v2/product/-barcode- how to read product data]
 +
 
 +
== Downloading static data ==
  
== 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:
 
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:
 +
 
* https://world.openfoodfacts.org/data (all data)
 
* https://world.openfoodfacts.org/data (all data)
 
* https://fr.openfoodfacts.org/data (data for that country)
 
* https://fr.openfoodfacts.org/data (data for that country)
  
==== CSV API ====
+
=== CSV API ===
The character that separates fields is <tab> (tabulation).
 
===== Encoding =====
 
The file encoding is Unicode UTF-8.
 
==== MongoDB dump ====
 
  
=== Field reference ===
+
The character that separates fields is  (tabulation).
The [[fields used]] in the api.
+
 
 +
For an example on how to import it in postgres, see https://iderr.github.io/p/week-1-new-project-on-openfoodfacts/
 +
 
 +
==== Encoding ====
 +
 
 +
The file encoding is Unicode UTF-8.
 +
 
 +
=== MongoDB dump ===
 +
 
 +
== Field reference ==
 +
 
 +
The [[fields used]] in the api are:
 
https://world.openfoodfacts.org/data/data-fields.txt
 
https://world.openfoodfacts.org/data/data-fields.txt
  
=== JSON interface ===
+
== JSON interface ==
 +
 
 
=== Pagination of results ===
 
=== Pagination of results ===
 +
 
If you're looking for all products within a facet (eg: https://fr-en.openfoodfacts.org/category/pizzas.json), you'll only have the 1st page.
 
If you're looking for all products within a facet (eg: https://fr-en.openfoodfacts.org/category/pizzas.json), you'll only have the 1st page.
 
To move from page to page:
 
To move from page to page:
Line 29: Line 41:
 
https://fr-en.openfoodfacts.org/category/pizzas/2.json
 
https://fr-en.openfoodfacts.org/category/pizzas/2.json
 
</pre>
 
</pre>
 +
 
=== Countries and Language of the Response ===
 
=== Countries and Language of the Response ===
You can either use the global (https://world.openfoodfacts.org, https://ssl-api.openfoodfacts.org) or local (https://fr.openfoodfacts.org,https://en.openfoodfacts.org…) domains for your API queries
 
  
====A few things to note====
+
You can either use the global (https://world.openfoodfacts.org, https://ssl-api.openfoodfacts.org) or local (https://fr.openfoodfacts.org, https://en.openfoodfacts.org, …) domains for your API queries.
* if you use a country subdomain instead of world, you get products for that country only, which might change the language but also the name of the fields. In that case you need to use the local language.
+
 
** https://fr.openfoodfacts.org/categorie/pizzas.json
+
=== A few things to note ===
* an alternative to avoid dealing with local languages is to specify the language in the subdomain: https://fr-en.openfoodfacts.org/category/pizzas.json
+
 
 +
* If you use a country subdomain instead of ''world'', you get products for that country only, which might change the language but also the name of the fields. In that case you need to use the local language.
 +
 
 +
(e.g. https://fr.openfoodfacts.org/categorie/pizzas.json).
 +
 
 +
* An alternative to avoid dealing with local languages is to specify the language in the subdomain: https://fr-en.openfoodfacts.org/category/pizzas.json
 +
 
 +
=== Country code (cc) and Language of the interface (lc) ===
  
==== Country code (cc) and Language of the interface (lc) ====
 
 
By default, the country code (cc) and language of the interface (lc) are set through the subdomain.
 
By default, the country code (cc) and language of the interface (lc) are set through the subdomain.
===== Examples =====
+
 
 +
In general they follow the scheme:
 +
<pre>https://<cc>-<lc>.openfoodfacts.org</pre>
 +
 
 +
==== Examples ====
 +
 
 
# https://world.openfoodfacts.org --> cc = world, lc = en (default language for the "country")
 
# https://world.openfoodfacts.org --> cc = world, lc = en (default language for the "country")
 
# https://fr.openfoodfacts.org --> cc = fr (France), lc = fr (French)
 
# https://fr.openfoodfacts.org --> cc = fr (France), lc = fr (French)
Line 45: Line 68:
 
# https://ch.openfoodfacts.org --> cc = ch (Switzerland), lc = de (German, set as main language for Switzerland)
 
# https://ch.openfoodfacts.org --> cc = ch (Switzerland), lc = de (German, set as main language for Switzerland)
 
# https://ch-fr.openfoodfacts.org --> cc = ch, lc = fr (French)
 
# https://ch-fr.openfoodfacts.org --> cc = ch, lc = fr (French)
==== Over-riding Country code (cc) and Language of the interface (lc) using cc and lc parameters ====
+
 
If you pass ?cc=us and/or &lc=it, it will set the country to US and the language to Italian
+
=== Overriding Country code (cc) and Language of the interface (lc) using cc and lc parameters ===
-> if you just pass cc, the lc will be the one set in the subdomain.
+
You can pass the field cc (e.g. <code>?cc=us</code>) and/or the field lc (e.g. <code>?lc=it</code>) to customize the results.
e.g. world.openfoodfacts.org + cc = fr --> cc = fr, lc = en (default language of world)
+
 
 +
For example, if you pass <code>?cc=us</code> and <code>&lc=it</code>, it will set the country to US and the language to Italian;
 +
if you just pass cc, the lc will be the one set in the subdomain.
 +
 
 +
e.g. <code>world.openfoodfacts.org?cc=frc</code> -> cc = fr, lc = en (default language of world)
 +
 
  
 
The cc affects which results are returned. cc = fr -> you get only products with France listed in the countries where sold field.
 
The cc affects which results are returned. cc = fr -> you get only products with France listed in the countries where sold field.
Line 56: Line 84:
 
If the results include links to products, those links will use a new subdomain that corresponds to the overrides.
 
If the results include links to products, those links will use a new subdomain that corresponds to the overrides.
  
 +
== Viewing a product ==
  
=== Viewing a product ===
+
Have a look at: [[API/Read/Product]]
 
 
[[API/Read/Product]]
 
  
=== Searching for products ===
+
== Searching for products ==
  
[[API/Read/Search]]
+
Have a look at: [[API/Read/Search]]

Latest revision as of 09:10, 15 August 2024


← Back to API (required read)

Use the API

To use the read API, please check out the API documentation and how to read product data

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:

CSV API

The character that separates fields is (tabulation).

For an example on how to import it in postgres, see https://iderr.github.io/p/week-1-new-project-on-openfoodfacts/

Encoding

The file encoding is Unicode UTF-8.

MongoDB dump

Field reference

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

JSON interface

Pagination of results

If you're looking for all products within a facet (eg: https://fr-en.openfoodfacts.org/category/pizzas.json), you'll only have the 1st page. To move from page to page:

https://fr-en.openfoodfacts.org/category/pizzas/1.json
https://fr-en.openfoodfacts.org/category/pizzas/2.json

Countries and Language of the Response

You can either use the global (https://world.openfoodfacts.org, https://ssl-api.openfoodfacts.org) or local (https://fr.openfoodfacts.org, https://en.openfoodfacts.org, …) domains for your API queries.

A few things to note

  • If you use a country subdomain instead of world, you get products for that country only, which might change the language but also the name of the fields. In that case you need to use the local language.

(e.g. https://fr.openfoodfacts.org/categorie/pizzas.json).

Country code (cc) and Language of the interface (lc)

By default, the country code (cc) and language of the interface (lc) are set through the subdomain.

In general they follow the scheme:

https://<cc>-<lc>.openfoodfacts.org

Examples

  1. https://world.openfoodfacts.org --> cc = world, lc = en (default language for the "country")
  2. https://fr.openfoodfacts.org --> cc = fr (France), lc = fr (French)
  3. https://jp.openfoodfacts.org --> cc = jp (Japan), lc = ja (Japanese)
  4. https://ch.openfoodfacts.org --> cc = ch (Switzerland), lc = de (German, set as main language for Switzerland)
  5. https://ch-fr.openfoodfacts.org --> cc = ch, lc = fr (French)

Overriding Country code (cc) and Language of the interface (lc) using cc and lc parameters

You can pass the field cc (e.g. ?cc=us) and/or the field lc (e.g. ?lc=it) to customize the results.

For example, if you pass ?cc=us and &lc=it, it will set the country to US and the language to Italian; if you just pass cc, the lc will be the one set in the subdomain.

e.g. world.openfoodfacts.org?cc=frc -> cc = fr, lc = en (default language of world)


The cc affects which results are returned. cc = fr -> you get only products with France listed in the countries where sold field.

The lc affects the language in which results will come back.

If the results include links to products, those links will use a new subdomain that corresponds to the overrides.

Viewing a product

Have a look at: API/Read/Product

Searching for products

Have a look at: API/Read/Search