{ "openapi": "3.0.1", "info": { "title": "Rappi Scraper - Restaurants, Menus & Stores", "description": "Collect Rappi restaurants, menus, store products and brand locations across nine Latin American markets. Pay per delivered row plus a start fee; export JSON, CSV or Excel.", "version": "0.2", "x-build-id": "1gJHuca9qdMJsu2Uj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~rappi-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-rappi-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/lentic_clockss~rappi-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-rappi-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/lentic_clockss~rappi-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-rappi-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": { "mode": { "title": "Mode", "enum": [ "auto", "restaurants", "nearMe", "category", "restaurant", "stores", "search", "home", "brand", "discoverCountries", "discoverCities", "discoverCategories", "discoverVerticals", "startUrls" ], "type": "string", "description": "Leave on Auto to select a mode from the target you fill. Select nearby restaurants, the home feed, stores or a discovery mode explicitly when you have no target.", "default": "auto" }, "startUrls": { "title": "Start URLs", "type": "array", "description": "Paste Rappi restaurant, category, search, brand or store-list URLs. Each URL is an input with its own maxResults allowance.", "items": { "type": "string" } }, "storeUrl": { "title": "Store URL", "pattern": "^$|^(https?://)?([A-Za-z0-9-]+\\.)*rappi\\.[A-Za-z.]+([/?#].*)?$", "type": "string", "description": "Paste the full Rappi restaurant page URL to collect that restaurant. Enable includeMenuItems if you also need menu rows." }, "storeId": { "title": "Store ID", "type": "string", "description": "Enter the numeric restaurant ID from its Rappi URL, such as 1923804381. You can use storeUrl instead." }, "query": { "title": "Search query", "type": "string", "description": "Enter one search phrase, such as pizza or sushi. Filling this field selects search mode when no higher-priority target is supplied." }, "citySlug": { "title": "City slug", "type": "string", "description": "Enter a supported city slug, such as guadalajara, medellin or sao-paulo. Use discoverCities to see the supported values; unknown cities can fall back to the market default." }, "categorySlug": { "title": "Category slug", "type": "string", "description": "Enter a cuisine or category slug, such as pizza or sushi. Use discoverCategories to find available categories." }, "brandUrl": { "title": "Brand URL", "pattern": "^$|^(https?://)?([A-Za-z0-9-]+\\.)*rappi\\.[A-Za-z.]+([/?#].*)?$", "type": "string", "description": "Paste a Rappi brand delivery URL to list chain locations. For an individual restaurant menu, use storeUrl instead." }, "brandId": { "title": "Brand ID", "type": "string", "description": "Enter the numeric chain ID from its Rappi brand delivery URL. This selects brand locations, not one restaurant menu." }, "brandSlug": { "title": "Brand slug", "type": "string", "description": "Optional brand-name part of the Rappi URL. Leave empty if you only know brandId." }, "storeSlug": { "title": "Store slug", "type": "string", "description": "Optional restaurant-name part of the Rappi URL. Leave empty if you only know storeId." }, "country": { "title": "Country", "enum": [ "mx", "co", "ar", "br", "cl", "pe", "ec", "uy", "cr" ], "type": "string", "description": "Choose Mexico, Colombia, Argentina, Brazil, Chile, Peru, Ecuador, Uruguay or Costa Rica. Availability varies by market and delivery location.", "default": "mx" }, "maxResults": { "title": "Max results per input", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum rows per input: default 70, with larger requests collected in parts of 70; all row types count together. The run stops at your maximum total charge, and Free-plan users are limited to 200 rows per run and 10 total runs.", "default": 70 }, "includeMenuItems": { "title": "Include menu items", "type": "boolean", "description": "Add menu items as separate menuItem rows for a restaurant input. They share maxResults with the restaurant row, with at most 25 child rows per store.", "default": false }, "includeToppings": { "title": "Include toppings", "type": "boolean", "description": "Add topping options as separate topping rows in restaurant mode; requires includeMenuItems. Toppings share the row limit and the 25-child-row cap with menu items.", "default": false }, "includeProducts": { "title": "Include tiendas products", "type": "boolean", "description": "Add separate product rows for up to three stores, subject to maxEnrich and the remaining row allowance. Each product row is billed like a store row.", "default": false }, "enrichDetails": { "title": "Enrich restaurant details", "type": "boolean", "description": "Look up available merchant address, coordinates and organization details for retained restaurant listings. This can take longer and does not guarantee contact fields.", "default": true }, "enrichMenus": { "title": "Enrich menus on list", "type": "boolean", "description": "Add menu rows to restaurant listings, including search and home results, for up to maxEnrich stores. These rows share maxResults and are billed at the same rate.", "default": false }, "maxEnrich": { "title": "Maximum stores to enrich", "minimum": 0, "maximum": 50, "type": "integer", "description": "Limit how many stores receive detail or menu enrichment across continued collection. Product collection uses at most three stores.", "default": 5 }, "cleanMenu": { "title": "Remove promotional menu entries", "type": "boolean", "description": "Remove promotional and fee-only entries from menus and product lists.", "default": true }, "freeDelivery": { "title": "Free delivery filter", "type": "boolean", "description": "Keep listings with evidence of free delivery when this filter is supported. Missing free-delivery information does not count as free delivery." }, "minRating": { "title": "Minimum rating", "type": "number", "description": "Exclude known ratings below this value. Restaurants without a rating can remain in the results." }, "openNow": { "title": "Open now", "type": "boolean", "description": "Exclude restaurants marked closed when an opening status is available. Listings with no status can remain." }, "turbo": { "title": "Fast-delivery preference", "type": "boolean", "description": "Accepted for compatibility, but it does not enforce fast-delivery filtering. Leave unset unless reusing an existing input." }, "filters": { "title": "Filter keys", "type": "array", "description": "Optional listing filter keys, such as free_delivery, discounts or new. Not every filter is supported on every page.", "items": { "type": "string" } }, "vertical": { "title": "Store type", "type": "string", "description": "Choose a store-type slug, such as market, farmatodo or express. Use discoverVerticals for reference values.", "default": "market" }, "lat": { "title": "Latitude", "type": "number", "description": "Latitude of the delivery location. When omitted, the Actor uses the selected market location; Brazil defaults to Sao Paulo, not Brasilia." }, "lng": { "title": "Longitude", "type": "number", "description": "Longitude of the delivery location. Provide it together with lat to use your own coordinates." }, "maxPages": { "title": "Page limit", "minimum": 1, "maximum": 50, "type": "integer", "description": "Legacy page-count setting, from 1 to 50. Current row-based collection follows maxResults and can continue beyond this value.", "default": 1 }, "cursor": { "title": "Continuation cursor", "type": "object", "description": "Optional nextCursor object from an earlier collection. Normally the Actor continues automatically, so leave this empty." }, "proxyCountry": { "title": "Advanced location override", "type": "string", "description": "Optional two-letter country override for advanced use. Leave empty for normal runs; Brazil always uses its own country setting." }, "workerBaseUrl": { "title": "Developer test endpoint", "type": "string", "description": "Leave empty. Used only by the developer for testing." } } }, "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 } } } } } } } } } }