{ "openapi": "3.0.1", "info": { "title": "Resy Restaurant Availability Scraper", "description": "Scrape Resy restaurants: search by name and city for the full venue record — address, phone, website, cuisine, price, ratings, photos, Google Place ID — plus every open table for a date and party size, or a calendar of when a booked-out place opens up. Unofficial.", "version": "0.1", "x-build-id": "QvWl4i9mQAmvVBNmk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/simple.actors~resy-availability/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-simple.actors-resy-availability", "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/simple.actors~resy-availability/runs": { "post": { "operationId": "runs-sync-simple.actors-resy-availability", "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/simple.actors~resy-availability/run-sync": { "post": { "operationId": "run-sync-simple.actors-resy-availability", "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": [ "query" ], "properties": { "query": { "title": "Search query", "type": "string", "description": "Restaurant name to search for. Resy ranks matches nationwide with the chosen city first, so 'Carbone' returns the New York, Miami, Dallas and Las Vegas locations — set Search radius to keep results inside one city. Ignored when Venue URLs are set.", "default": "Carbone" }, "city": { "title": "City", "type": "string", "description": "City the search is anchored on, e.g. 'Miami', 'Chicago', 'Mexico City', 'Tokyo'. Matched against Resy's own list of 2,000+ markets across the US, Mexico, Spain, Italy, Japan, Canada and more; a city Resy does not cover falls back to New York (override with Geo override).", "default": "New York" }, "radiusKm": { "title": "Search radius (km)", "minimum": 1, "type": "integer", "description": "Restrict search results to this many kilometres around the city. Leave empty to rank the whole country by relevance — set it (e.g. 25) when you want only restaurants in that one city." }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Maximum venues to emit (search mode) or URLs to process (URL mode). Search results are paged automatically to reach this number.", "default": 3 }, "startUrls": { "title": "Venue URLs", "type": "array", "description": "Resy venue URLs (https://resy.com/cities/{city}/venues/{slug}). When set, the search inputs are ignored and each URL is read directly.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeAvailability": { "title": "Include availability", "type": "boolean", "description": "Fetch every bookable table for Date and Party size. Works in both search and URL mode. A venue with no open tables is left out of the results unless Keep unavailable venues is on.", "default": false }, "date": { "title": "Date", "type": "string", "description": "Day to read availability for, YYYY-MM-DD. Required when Include availability is on." }, "partySize": { "title": "Party size", "minimum": 1, "type": "integer", "description": "Number of guests. Drives both the availability lookup and the calendar — a table for 2 and a table for 8 are different questions.", "default": 2 }, "keepUnavailable": { "title": "Keep unavailable venues", "type": "boolean", "description": "Keep venues that have no open tables, with slotCount 0, instead of leaving them out. Turn this on when you want the full list with a booked/not-booked flag rather than only what is bookable.", "default": false }, "includeCalendar": { "title": "Include booking calendar", "type": "boolean", "description": "Add a day-by-day calendar showing which dates are available, sold out or closed for Party size — the fastest way to find when a hard-to-book restaurant opens up.", "default": false }, "calendarStartDate": { "title": "Calendar start date", "type": "string", "description": "First day of the calendar, YYYY-MM-DD. Defaults to Date if set, otherwise today." }, "calendarDays": { "title": "Calendar length (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many days of calendar to read from the start date. Resy stops at each venue's own booking horizon, reported back as calendarLastBookableDate.", "default": 30 }, "calendarEndDate": { "title": "Calendar end date", "type": "string", "description": "Last day of the calendar, YYYY-MM-DD. Overrides Calendar length when set." }, "includeRaw": { "title": "Include raw Resy payloads", "type": "boolean", "description": "Attach Resy's untouched JSON for the venue, its availability and its calendar under a `raw` field. Useful when you need a detail this actor does not map to a named field; it makes the output several times larger.", "default": false }, "locationSlug": { "title": "Resy city slug", "type": "string", "description": "Advanced: the city path segment Resy uses, e.g. 'new-york-ny'. Search results carry their own, so this is only a fallback for hits that do not; URL mode reads it from the URL." }, "geo": { "title": "Geo override", "type": "object", "description": "Advanced: {\"latitude\": ..., \"longitude\": ...} to anchor the search on exact coordinates instead of a city name." }, "apiKeyFallback": { "title": "Fallback API key", "type": "string", "description": "Advanced: last-known Resy public frontend API key, used only if reading the current one off resy.com fails.", "default": "VbWk7s3L4KiK5fzlO7JD3Q5EYolJI7n5" }, "proxy": { "title": "Proxy", "type": "object", "description": "Apify Proxy settings. Datacenter (the default) is included in every plan; switch the group to RESIDENTIAL if Resy starts blocking.", "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 } } } } } } } } } }