{ "openapi": "3.0.1", "info": { "title": "Open Food Facts Scraper", "description": "[💰 $7 / 1K] Extract food product data from Open Food Facts — nutrition, ingredients, allergens, Nutri-Score, Eco-Score, and images. Search by keyword, filter by category, brand, country, label, or grade, or look up products by barcode.", "version": "1.0", "x-build-id": "79W1g7cSRpOGUfYLB" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/solidcode~openfoodfacts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-solidcode-openfoodfacts-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/solidcode~openfoodfacts-scraper/runs": { "post": { "operationId": "runs-sync-solidcode-openfoodfacts-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/solidcode~openfoodfacts-scraper/run-sync": { "post": { "operationId": "run-sync-solidcode-openfoodfacts-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "searchQuery": { "title": "Search Term", "type": "string", "description": "Word or phrase to search for across product names and brands (e.g. 'chocolate', 'greek yogurt', 'oat milk'). Leave blank to browse by the filters below instead." }, "productUrls": { "title": "Product URLs or Barcodes", "type": "array", "description": "Paste Open Food Facts product page URLs (e.g. https://world.openfoodfacts.org/product/3017620422003) or bare barcodes (e.g. 3017620422003). When set, these products are fetched directly and the search term and filters are ignored.", "items": { "type": "string" } }, "category": { "title": "Category", "type": "string", "description": "Only include products in this category (e.g. 'Breakfast cereals', 'Sodas', 'Snacks'). Leave blank for any category." }, "brand": { "title": "Brand", "type": "string", "description": "Only include products from this brand (e.g. 'Nestlé', 'Coca-Cola', 'Alpro'). Leave blank for any brand." }, "country": { "title": "Country", "type": "string", "description": "Only include products sold in this country (e.g. 'France', 'United States', 'Germany'). Leave blank for any country." }, "label": { "title": "Label", "enum": [ "organic", "vegan", "vegetarian", "gluten-free", "fair-trade", "no-palm-oil", "kosher", "halal" ], "type": "string", "description": "Only include products carrying this label or certification. Leave blank for any." }, "nutritionGrade": { "title": "Nutri-Score Grade", "enum": [ "a", "b", "c", "d", "e" ], "type": "string", "description": "Only include products with this Nutri-Score grade (A is healthiest, E is least healthy). Leave blank for any grade." }, "sortBy": { "title": "Sort Results By", "enum": [ "popularity", "product_name", "newest", "recently_edited", "best_nutriscore", "best_ecoscore" ], "type": "string", "description": "Choose the order in which products are collected.", "default": "popularity" }, "maxResults": { "title": "Maximum Results", "minimum": 0, "type": "integer", "description": "Hard cap on the total number of products to collect. Default 100 — increase for bigger runs, or set to 0 for no cap (an internal upper bound of 100,000 still applies to prevent runaway pagination). The actor requests exactly the number of products needed to reach this cap, so you get precisely this many results (not more) when enough matches exist. Ignored when specific product URLs or barcodes are provided.", "default": 100 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }