Dane
Warunki ponownego wykorzystania
The Open Pet Food Facts database is available under the Open Database License.
The individual contents of the database are available under the Database Contents License.
Products images are available under the Creative Commons Attribution ShareAlike licence.
They may contain graphical elements subject to copyright or other rights, that may in some cases be reproduced (quotation rights or fair use).
Please read Terms and conditions of use and re-use before re-using the data.
Simplified ODbL summary
This is a human-readable summary of the ODbL 1.0 license (see also the Open Data Commons summary):
You are free:
- To share: To copy, distribute and use the database.
- To create: To produce works (such as applications, websites, services, or analytical studies) from the database.
- To adapt: To modify, transform and build upon the database.
As long as you:
- Attribute: You must attribute any public use of the database, or works produced from the database, in the manner specified in the ODbL (e.g. "Contains data from Open Pet Food Facts, available under the Open Database License"). For any redistribution of the database, or works produced from it, you must make clear to others the license of the database and keep intact any notices on the original database.
- Share-Alike: If you publicly use any adapted version of this database, or works produced from an adapted database, you must also offer that adapted database under the ODbL and share your modifications back.
- Keep open: If you redistribute the database, or an adapted version of it, you may use technological measures that restrict the work (such as DRM) only as long as you also redistribute a version without such measures.
Be on the legal side: The technical route to compliance
We want everyone to succeed with their projects while keeping data open for everyone! To ensure your application or reuse complies with the license and our infrastructure policies, please follow this technical checklist (see also our license compliance tutorial):
- If you want to use the API conforms strictly to the instructions given in the API documentation
- Use bulk exports for offline, analytical, or caching needs: If you need access to all products or want to run complex queries, please download the nightly MongoDB dumps, CSV, or Parquet exports (described below) or build a local cache.
- Contribute back (Share-Alike in practice): In the spirit of the ODbL Share-Alike obligation, if your app allows users to add new products, update nutrition/ingredients, or submit photos, please send those contributions back to Open Pet Food Facts via our API or SDKs. This ensures everyone benefits from continuous data improvements.
- Prominent UI attribution: Clearly attribute Open Pet Food Facts in your app or website UI (for example, on product pages, search screens, and in the "About" or "Settings" sections) with clickable links back to Open Pet Food Facts and the ODbL license.
Compliance resources:
- Simple summary of the ODbL and our license on the wiki
- Attribution guidelines (how to attribute on mobile, web, and print)
- ODbL non-compliance registry: Check that your project is fully compliant. If your app is listed or you have questions, please reach out to us at reuse@openfoodfacts.org or in the #api channel on Slack so we can help you achieve compliance!
- API FAQ & legal questions
Powiedz nam o swoim projekcie
We are very interested in learning what the Open Pet Food Facts data is used for. It is not mandatory, but we would very much appreciate it if you tell us about your re-uses so that we can share them with the Open Pet Food Facts community. Możesz także wypełnić ten formularz, aby mieć szansę na wyróżnienie swojej aplikacji.
Open Pet Food Facts data exports
Zrzuty i eksporty baz danych są generowane co noc. The database is very big, so you can find different ways to use the data, depending on the export flavor.
Information on the different fields for the MongoDB dump and CSV exports is available at https://world.openpetfoodfacts.org/data/data-fields.txt
MongoDB dump
Dane dla wszystkich produktów są dostępne w zrzucie bazy danych MongoDB.
- Link
- https://static.openpetfoodfacts.org/data/openpetfoodfacts-mongodbdump.gz
- sha256sum
- https://static.openpetfoodfacts.org/data/gz-sha256sum
- md5sum
- https://static.openpetfoodfacts.org/data/gz-md5sum
Delta Export
Daily delta exports are provided for the previous 14 days. The list of currently available delta files can be found at https://static.openpetfoodfacts.org/data/delta/index.txt.
Each line represents a file that is available at https://static.openpetfoodfacts.org/data/delta/{filename}.
The filename contains UNIX timestamp of the first and the last change contained in the JSON file, so that the delta files can be imported (after extraction) with mongoimport in alphabetical order.
Please note that due to the nature of mongoexport, the delta files cannot tell you about deleted products. To remove deleted products from your database, you will need to import the full MongoDB dump.
Eksport danych JSONL
Cała baza danych jest również dostępna w formacie JSONL (nazywanym także LDJSON lub NDJSON), gdzie każda linia jest obiektem JSON. Reprezentuje te same dane, co eksport MongoDB. Plik jest skompresowany programem gzip.
Parquet Data Export on Hugging Face
The dataset is available on Hugging Face, a collaborative Machine Learning ecosystem where developers and researchers can share models and datasets.
A simplified version of the JSONL dump is also available in the Parquet format. During the conversion, we filtered columns that contains duplicated information, are used for internal debugging, or are simply irrelevant for users.
The Parquet format has proved to be handy:
- Data is organized by column, rather than by row, which saves storage space and speeds up analytics queries, i.e. you can select just the columns you care about, optimizing query performances, even on entry-level computers.
- Highly efficient data compression and decompression, making it good for storing and sharing big datasets of any kind,
- Supports complex data types and advanced nested data structures.
Find more information in the Wiki, including guidelines for data reuse and example queries to get started.
A suitable way to exploit the database is to use DuckDB, an in-process analytical tool designed to process large amount of data in a fraction of seconds. You can read our blog post where we walk you through exploring and processing the Open Pet Food Facts database with DuckDB
Eksport danych CSV
Data for all products, or some of the products, can be downloaded in CSV format (readable with OpenOffice, Excel and many other software) through the advanced search form.
- Linki
- https://static.openpetfoodfacts.org/data/en.openpetfoodfacts.org.products.csv.gz (compressed CSV in GZIP format: ~ 0.9 Gb, uncompressed: ~ 9 Gb)
Kodowanie pliku to Unicode UTF-8. Znakiem rozdzielającym pola jest <tab> (tabulacja).
RDF Data Export
The database is also available in the RDF format. Możesz przeczytać ogłoszenie po francusku.
Eksport danych obrazu
Wszystkie obrazy i wyniki OCR mogą być pobrane z naszego serwera lub z AWS (przez AWS Open Data Program). Sprawdź naszą dokumentację, aby dowiedzieć się więcej o tym, jak pobierać obrazy.
OpenAPI Documentation for the JSON API
API JSON jest też dostępne, aby odczytać dane produktu. This API is in particular used in the Open Pet Food Facts mobile app for iPhone and Android.
We improve the API over-time but we are careful to keep backwards compatibility. Please get in touch if you use it, so that we can tell you about potential changes.
URL to read data for a product: https://world.openpetfoodfacts.org/api/v3/product/[barcode].json
Example: https://world.openpetfoodfacts.org/api/v0/product/3600550578041.json
Note that if the output is too overwhelming, you can filter it - as described in the API documentation.
Benefiting from our API? Support the infrastructure that powers your project
Open Food Facts is an independent, non-profit digital commons built for public benefit. We provide our database and API 100% free of charge and open to all, without commercial paywalls or advertising.
Serving millions of real-time queries daily incurs real costs in servers, database clusters, bandwidth, and maintenance. If your application, startup, research project, or company saves time and builds value with our API, please consider supporting Open Food Facts financially. Your contribution keeps our open infrastructure fast, resilient, and freely accessible to everyone worldwide.
OpenAPI help wanted
We're eager to finish the documentation of the API, add use-cases, and automate SDK generation. If you are an OpenAPI connoisseur, you are very welcome to help.You are very welcome to use the API for production cases, as long as 1 API call = 1 real scan by a user. Any attempt to scrape the database using the API will very likely be blocked, as full daily exports are available on this very page.
Also, sending an HTTP header with your API call is a good way we can get in touch, should any issue arise.
If you are unsure about anything, or have any question (there is no silly question), feel free to ask it on the #api channel on Slack :-)
Experimental XML API
You can also get the result in XML by using .xml
API V2 - Comprehensive but not OpenAPI compliant - It contains uses cases for displaying a product, and letting your users add the data required to get the Nutri-Score, the NOVA classification, additives, and the Eco-Score.
This API is not actively maintained, and not officially documented.Wrappers and SDKs
We probably have a wrapper for your favorite programming language. Jeśli mamy, możesz je wykorzystać i udoskonalić. Jeśli nie, możesz pomóc nam go stworzyć.
They will let you consume data, as well as let your users contribute new data
General principles to make your users happy
- You can search for information about products, including many useful computed values.
- If you can't get the information on a specific product, you can get your user to send photos and data, that will then be processed by Open Pet Food Facts AI and contributors to get the computed result you want to show them.
- You can also implement the complete flow so that they get immediately the result with some effort on their side.
If your users do not expect a result immediately (e.g. Inventory apps)
- Submit photos (front/nutrition/ingredients): most painless thing for your users
- The Open Pet Food Facts AI - Robotoff - will generate some derived data from the photos
- Over time, other apps, and the Open Pet Food Facts community will fill the data gaps
If your users expect a result immediately (e.g. Nutrition or Allergy apps)
- Submit ingredients + category > get Ingredient analysis, additives, allergens, normalized ingredients, vegan, vegetarian…
- Submit labels for added value
- Submit nutrition
Android and iPhone mobile app
The code for the current universal app called Open Food Facts is available on GitHub (Flutter). It can scan and add pet food. The legacy Open Pet Food Facts mobile app, still available for Android is built on Kotlin. The plan is to update it to a Open Pet Food Facts branded flavor of the Flutter app.
We look to turn the deprecated Kotlin and Swift codebases into Kotlin and Swift SDKs, help welcome :-)
Aplikacja umożliwia użytkownikom skanowanie kodu kreskowego produktów, aby wyświetlić informacje o produkcie, oraz robić i przesyłać zdjęcia i dane dotyczące brakujących produktów.
Możesz wykorzystać nasz kod (licencja Open source), pomóż nam go ulepszyć, dla wszystkich, na każdej planecie.
SDK
| Icon | Language / Framework | Zasoby | Discussion |
|---|---|---|---|
| Cordova (Old App) | GitHub | Nie dotyczy | |
| DART | GitHub pub.dev | Nie dotyczy | |
| Elixir | GitHub | Slack Channel | |
| Go | GitHub | Slack Channel | |
| Jawa | GitHub | Slack Channel | |
| Spring Boot | GitHub | Slack Channel | |
| Kotlin | GitHub | Slack Channel | |
| JavaScript | GitHub | Slack Channel | |
| PHP | GitHub | Slack Channel | |
| PHP (Laravel) | GitHub | Slack Channel | |
| Python | GitHub | Slack Channel | |
| React Native | GitHub | Slack Channel | |
| Ruby | GitHub | Slack Channel | |
| Rdza | GitHub | Slack Channel | |
| R | GitHub | Slack Channel | |
| Swift | GitHub | Slack Channel | |
| .NET/C# | GitHub | Slack Channel |
Discussing data, API and exports
You can look at common FAQ questions about the API and Data Exports and common Open Food Facts questions
You can join the Open Pet Food Facts Slack chatroom which is the preferred way to ask questions and discuss the API. Please ask your questions in the #api channel
You can open a thread on our API documentation repository
For any question regarding the data, you can contact us at reuse@openfoodfacts.org