{ "openapi": "3.0.1", "info": { "title": "Resy Scraper - Restaurants, Ratings, Contacts & Reservations", "description": "Scrape Resy restaurants by city, cuisine or URL: name, full address, phone, website, cuisine, price band, ratings, neighborhood, geo, restaurant group and live reservation availability. Turn dining venues into B2B leads. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "z8PP56wIVGTg0KgUM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapesage~resy-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapesage-resy-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/scrapesage~resy-scraper/runs": { "post": { "operationId": "runs-sync-scrapesage-resy-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/scrapesage~resy-scraper/run-sync": { "post": { "operationId": "run-sync-scrapesage-resy-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": { "cities": { "title": "Cities", "type": "array", "description": "Cities to scrape every Resy restaurant in, e.g. \"New York, NY\", \"Los Angeles, CA\", \"Austin, TX\", \"Chicago, IL\", \"Miami, FL\". Major Resy markets are resolved to a precise map search for full coverage; any other city falls back to a name search. One per row.", "items": { "type": "string" } }, "searchTerms": { "title": "Search terms (optional)", "type": "array", "description": "Free-text Resy searches — a cuisine (\"sushi\", \"steakhouse\"), a neighborhood, or a specific restaurant name (\"Le Bernardin\"). Each term is searched separately. Combine with Cities for cuisine-by-city coverage. One per row.", "items": { "type": "string" } }, "venueUrls": { "title": "Resy venue URLs (optional)", "type": "array", "description": "Direct Resy restaurant URLs to scrape, e.g. https://resy.com/cities/new-york-ny/venues/le-bernardin . One per row.", "items": { "type": "string" } }, "maxResults": { "title": "Max results (restaurants)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap on restaurant records across the whole run.", "default": 100 }, "enrichVenueDetails": { "title": "Enrich with full venue details (address, website, menu, group)", "type": "boolean", "description": "Open each restaurant's Resy profile for the complete record: full street address, website, menu link, editorial description, restaurant group, timezone and cross-platform IDs (Google / Foursquare). One extra fast API call per restaurant. Off = the fast, cheap search-feed record (name, phone, cuisine, price, rating, neighborhood, geo, images).", "default": true }, "includeAvailability": { "title": "Include live reservation availability", "type": "boolean", "description": "Also return bookable reservation slots for the date and party size below. Note: when on, Resy returns only restaurants with open tables on that date, so coverage narrows to bookable venues. Off = all restaurants regardless of availability.", "default": false }, "reservationDate": { "title": "Reservation date (YYYY-MM-DD)", "type": "string", "description": "Date to check availability for (used only when 'Include live reservation availability' is on). Defaults to two days from the run date.", "default": "" }, "partySize": { "title": "Party size", "minimum": 1, "maximum": 20, "type": "integer", "description": "Party size for availability checks.", "default": 2 }, "priceBands": { "title": "Price bands", "type": "array", "description": "Keep only restaurants in these price bands: 1 = $, 2 = $$, 3 = $$$, 4 = $$$$. Leave empty for all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4" ], "enumTitles": [ "$", "$$", "$$$", "$$$$" ] }, "default": [] }, "cuisineFilter": { "title": "Cuisine filter (output)", "type": "array", "description": "Keep only restaurants whose cuisine matches one of these (case-insensitive substring, e.g. \"italian\", \"sushi\"). Leave empty for all.", "items": { "type": "string" } }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "integer", "description": "Keep only restaurants with a Resy rating at or above this value (1–5). 0 = no filter.", "default": 0 }, "deduplicate": { "title": "Deduplicate restaurants", "type": "boolean", "description": "Skip a restaurant already emitted earlier in the same run (common when scraping a city across several cuisines).", "default": true }, "monitorMode": { "title": "Monitoring mode — only new restaurants", "type": "boolean", "description": "Remember which restaurants were already returned and emit ONLY restaurants not seen in previous runs. Pairs with Apify Schedules to track new restaurant openings in a market over time (it does not conflict with Schedules — Schedules decide when to run, this decides what is new).", "default": false }, "monitorStoreName": { "title": "Monitor store name", "type": "string", "description": "Named key-value store that holds the 'already seen' venue ids for monitoring mode. Use a different name per tracked market to keep histories separate.", "default": "resy-scraper-monitor" }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum parallel API requests. Lower it if you see transient blocks; raise it for speed.", "default": 8 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Resy's public data API is read over standard Apify Proxy with automatic IP rotation; the default works well. Blocked requests retry automatically on a fresh IP.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }