{ "openapi": "3.0.1", "info": { "title": "Open Beauty Facts Scraper", "description": "Scrape Open Beauty Facts - the world's largest open database of cosmetics and beauty products. Search by name or brand, browse by category (shampoos, moisturisers, lip balms, etc.), or look up products by barcode. Returns ingredients, brands, categories, images, and countries.", "version": "1.0", "x-build-id": "p6uC3HAwdRiON91Ww" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~open-beauty-facts-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-open-beauty-facts-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/crawlerbros~open-beauty-facts-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-open-beauty-facts-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/crawlerbros~open-beauty-facts-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-open-beauty-facts-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byCategory", "byBarcode" ], "type": "string", "description": "What to fetch from Open Beauty Facts.", "default": "search" }, "searchQuery": { "title": "Search query", "type": "string", "description": "Product name or brand to search for (mode=search). Example: 'shampoo', 'face cream', 'L Oreal'.", "default": "shampoo" }, "category": { "title": "Category", "enum": [ "lipsticks", "foundations", "mascaras", "shampoos", "conditioners", "moisturizers", "sunscreens", "perfumes", "nail-polishes", "eye-shadows", "blushes", "concealers", "serums", "toners", "cleansers", "body-lotions", "deodorants", "hair-dyes", "face-masks", "bb-creams" ], "type": "string", "description": "Open Beauty Facts category slug (mode=byCategory). Common categories available in the dropdown.", "default": "lipsticks" }, "barcodes": { "title": "Barcodes (mode=byBarcode)", "type": "array", "description": "EAN/UPC barcode numbers to look up. E.g. `3600524187644`.", "default": [], "items": { "type": "string" } }, "brand": { "title": "Filter by brand", "type": "string", "description": "Filter results to a specific brand name (case-insensitive substring match). E.g. `loreal`, `maybelline`." }, "country": { "title": "Filter by country", "type": "string", "description": "Filter products available in a specific country. E.g. `United States`, `France`, `United Kingdom`." }, "language": { "title": "Product language", "enum": [ "", "en", "fr", "de", "es", "it", "nl", "pt", "ar", "zh", "ja", "ko", "ru", "pl", "tr" ], "type": "string", "description": "Filter products with labels in a specific language (ISO 639-1 code, e.g. `en`, `fr`, `de`).", "default": "" }, "hasIngredients": { "title": "Has ingredients listed", "type": "boolean", "description": "Only include products that have an ingredients list.", "default": false }, "hasImage": { "title": "Has product image", "type": "boolean", "description": "Only include products that have a product image.", "default": false }, "dietaryPreference": { "title": "Dietary preference", "enum": [ "any", "vegan", "vegetarian", "palmOilFree" ], "type": "string", "description": "Only include products confirmed (not just 'maybe' or 'unknown') to match this dietary preference, based on Open Beauty Facts' own ingredient analysis.", "default": "any" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of product records to return.", "default": 20 } } }, "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 } } } } } } } } } }