{ "openapi": "3.0.1", "info": { "title": "Multi-Site Recipe & Nutrition Data Extractor", "description": "Get ingredients, step-by-step instructions, nutrition, ratings, prep/cook time, yield, and images from recipe pages on Epicurious, BBC Good Food, Tasty, NYT Cooking, Serious Eats, Food Network, and thousands of food blogs.", "version": "2.0", "x-build-id": "EVA9PME5KWbFjUYD4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/vexaloom-labs~multi-site-recipe-and-nutrition-data-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-vexaloom-labs-multi-site-recipe-and-nutrition-data-extractor", "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/vexaloom-labs~multi-site-recipe-and-nutrition-data-extractor/runs": { "post": { "operationId": "runs-sync-vexaloom-labs-multi-site-recipe-and-nutrition-data-extractor", "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/vexaloom-labs~multi-site-recipe-and-nutrition-data-extractor/run-sync": { "post": { "operationId": "run-sync-vexaloom-labs-multi-site-recipe-and-nutrition-data-extractor", "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", "byUrls", "byListing", "byTag", "bySitemap" ], "type": "string", "description": "How to find recipes. Search by keyword is the simplest; URL and sitemap modes are best when you already know the pages.", "default": "search" }, "searchQuery": { "title": "Search query (mode=search)", "type": "string", "description": "What to search for, e.g. `banana bread`, `vegan dinner`, or `chicken curry`.", "default": "banana bread" }, "site": { "title": "Site to search (mode=search)", "enum": [ "all", "bbcgoodfood", "epicurious", "tasty", "foodnetwork", "nytcooking", "bonappetit", "delish", "budgetbytes", "pinchofyum", "minimalistbaker", "smittenkitchen", "loveandlemons", "skinnytaste" ], "type": "string", "description": "Pick one site, or `all` to search every supported site. Search coverage varies by site; unsupported sites still work in byUrls/bySitemap modes.", "default": "all" }, "recipeUrls": { "title": "Recipe URLs (mode=byUrls)", "type": "array", "description": "Direct recipe-page URLs from any supported site or food blog. AllRecipes URLs are rejected as unsupported.", "default": [ "https://www.epicurious.com/recipes/food/views/banana-bread" ], "items": { "type": "string" } }, "listingUrls": { "title": "Listing page URLs (mode=byListing)", "type": "array", "description": "Category, tag, or search-result pages. The actor extracts recipe links and follows page 2, 3, … where the site exposes a page parameter.", "default": [], "items": { "type": "string" } }, "sitemapUrls": { "title": "Sitemap URLs (mode=bySitemap)", "type": "array", "description": "Sitemap.xml URLs. The actor walks sitemap indexes and keeps recipe-looking URLs.", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max recipes", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted recipe records.", "default": 50 }, "maxPages": { "title": "Max pages per site/listing", "minimum": 1, "maximum": 10, "type": "integer", "description": "For search and listing modes, how many result pages to read per site or listing URL.", "default": 2 }, "minRating": { "title": "Minimum rating (optional)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Drop recipes with a rating below this value on a 0–500 scale (400 = 4.0/5)." }, "minRatingCount": { "title": "Minimum rating count (optional)", "minimum": 0, "maximum": 10000000, "type": "integer", "description": "Drop recipes with fewer ratings than this." }, "maxTotalTimeMinutes": { "title": "Maximum total time in minutes (optional)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Drop recipes whose prep + cook time exceeds this many minutes." }, "keywordIncludes": { "title": "Must contain keyword (optional)", "type": "string", "description": "Drop recipes whose name and description do not contain this keyword." }, "proxy": { "title": "Apify Proxy (optional)", "type": "object", "description": "No proxy is needed for the supported sites. Enable Apify Proxy only if you want to route requests through your own Apify proxy groups.", "default": { "useApifyProxy": false } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }