{ "openapi": "3.0.1", "info": { "title": "Clover Menu Scraper: Restaurant Menus, Prices & Store Leads", "description": "Scrape restaurant menus and store details from Clover online ordering: exact prices, modifiers, photos, availability, hours, delivery fees. Find Clover restaurants by city, state, ZIP or name across 14,000+ US and Canadian stores. No login.", "version": "0.1", "x-build-id": "i0VrSFqTezRMeQGFF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~clover-menu-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-clover-menu-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/yugenox~clover-menu-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-clover-menu-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/yugenox~clover-menu-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-clover-menu-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": { "startUrls": { "title": "๐Ÿ”— Clover store URLs", "type": "array", "description": "Clover online-ordering links: https://www.clover.com/online-ordering/, https://.cloveronline.com, a bare store slug (bnk-bao-toronto) or a 13-character Clover merchant ID. Leave empty to search by location below.", "items": { "type": "string" } }, "cities": { "title": "๐Ÿ™๏ธ Cities", "type": "array", "description": "Find Clover stores in these cities, e.g. \"Toronto\", \"Houston, TX\", \"London, ON\". Add the state/province after a comma to avoid same-name cities.", "items": { "type": "string" } }, "states": { "title": "๐Ÿ—บ๏ธ States / provinces", "type": "array", "description": "Two-letter codes or full names: TX, Ontario, BC, New Yorkโ€ฆ", "items": { "type": "string" } }, "postalCodes": { "title": "๐Ÿ“ฎ ZIP / postal code prefixes", "type": "array", "description": "Match the start of the store's ZIP or postal code: \"770\" (Houston area), \"M5\" (downtown Toronto), \"10001\".", "items": { "type": "string" } }, "country": { "title": "๐ŸŒŽ Country", "enum": [ "any", "US", "CA", "AU" ], "type": "string", "description": "Limit the location search to one country.", "default": "any" }, "searchTerms": { "title": "๐Ÿ” Store name contains", "type": "array", "description": "Keep stores whose name contains any of these words, e.g. pizza, sushi, bakery, taqueria. Works alone (nationwide) or with the location filters.", "items": { "type": "string" } }, "skipMerchants": { "title": "โญ๏ธ Skip the first N matches", "minimum": 0, "type": "integer", "description": "Page through a large location: when a run ends with \"set skipMerchants to N to continue\", run again with that N.", "default": 0 }, "maxMerchants": { "title": "๐Ÿ”ข Max stores", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of stores to save in this run. Stores that are closed or not found don't count.", "default": 50 }, "outputMode": { "title": "๐Ÿ“ฆ Output format", "enum": [ "merchants", "items", "leads" ], "type": "string", "description": "Stores with menus: one row per store, full menu nested inside. Menu items: one flat row per item (with store columns), ideal for spreadsheets and price comparison. Store leads: store details only (address, phone, hours, ordering status, website), no menu, fastest and cheapest.", "default": "merchants" }, "includeModifiers": { "title": "๐Ÿงฉ Include modifiers / options", "type": "boolean", "description": "Add each item's option groups (sizes, toppings, sides) with min/max selections and add-on prices.", "default": true }, "includeImages": { "title": "๐Ÿ–ผ๏ธ Include item photos", "type": "boolean", "description": "Add photo URLs (square 576px and large 1500px) for items that have them.", "default": true }, "includeExtraDetails": { "title": "๐Ÿ•’ Include store hours, website and verified country", "type": "boolean", "description": "One extra lookup per store: opening hours (when published), the store's Clover website, and the official country and currency.", "default": true }, "onlyOrderingEnabled": { "title": "โœ… Only stores taking online orders", "type": "boolean", "description": "Skip stores that have switched online ordering off (their menus may be out of date).", "default": false }, "onlyAvailableItems": { "title": "๐ŸŸข Only items in stock", "type": "boolean", "description": "Leave out items the store marked unavailable.", "default": false }, "maxConcurrency": { "title": "โšก Parallel stores", "minimum": 1, "maximum": 30, "type": "integer", "description": "How many stores to fetch at once.", "default": 10 }, "proxyConfiguration": { "title": "๐Ÿ›ก๏ธ Proxy configuration", "type": "object", "description": "Apify Proxy is required. Datacenter proxies work and are the cheapest; the run switches to residential automatically if needed.", "default": { "useApifyProxy": true } }, "mode": { "title": "Mode", "type": "string", "description": "Internal maintenance mode." }, "refreshConcurrency": { "title": "Refresh concurrency", "type": "integer", "description": "Internal." }, "refreshMaxRefs": { "title": "Refresh cap", "type": "integer", "description": "Internal." }, "publish": { "title": "Publish directory", "type": "boolean", "description": "Internal." } } }, "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 } } } } } } } } } }