{
"openapi": "3.0.1",
"info": {
"title": "Resy Scraper - Restaurants & Real-Time Availability",
"description": "Extract restaurant data and real-time reservation availability from Resy. Enter a city or paste URLs. Get ratings, cuisine, contact info, images, descriptions, waitlist status, and bookable time slots across 1,900+ cities. Export as JSON, CSV, or Excel.",
"version": "0.0",
"x-build-id": "bLF5kYrIWSEN5wRZo"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/clearpath~resy-api/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-clearpath-resy-api",
"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/clearpath~resy-api/runs": {
"post": {
"operationId": "runs-sync-clearpath-resy-api",
"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/clearpath~resy-api/run-sync": {
"post": {
"operationId": "run-sync-clearpath-resy-api",
"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": {
"maxItems": {
"title": "Max Restaurants",
"minimum": 1,
"maximum": 50000,
"type": "integer",
"description": "Maximum number of restaurants to scrape. Set a lower value for faster runs.",
"default": 100
},
"startUrls": {
"title": "Resy URLs",
"type": "array",
"description": "Paste one or more Resy URLs to scrape.
Supported formats:
• City page: https://resy.com/cities/new-york-ny
• Restaurant page: https://resy.com/cities/new-york-ny/carbone
Leave empty to use the City field instead.",
"items": {
"type": "object",
"required": [
"url"
],
"properties": {
"url": {
"type": "string",
"title": "URL of a web page",
"format": "uri"
}
}
}
},
"city": {
"title": "City",
"type": "string",
"description": "City name, code, or URL slug. Use English names (e.g. Munich not München). Supports 1,900+ cities worldwide.
Examples: New York, ny, los-angeles-ca, London, Munich
Ignored when Resy URLs are provided."
},
"query": {
"title": "Keyword Search",
"type": "string",
"description": "Search restaurants by name or keyword. Narrows results within the selected city.
Examples: Carbone, rooftop, brunch"
},
"cuisine": {
"title": "Cuisine Type",
"enum": [
"American",
"Asian",
"Chinese",
"French",
"Indian",
"Italian",
"Japanese",
"Korean",
"Mediterranean",
"Mexican",
"Middle Eastern",
"Seafood",
"Steakhouse",
"Sushi",
"Thai"
],
"type": "string",
"description": "Filter restaurants by cuisine. Available cuisines vary by city, so some options may return no results in smaller markets."
},
"includeAvailability": {
"title": "Include Availability (reduces results to restaurants with open slots)",
"type": "boolean",
"description": "Fetch real-time reservation time slots for each restaurant. Only restaurants with available slots for the given date and party size are returned, so the total result count will be lower than without this enabled.
Requires Reservation Date and Party Size below.",
"default": false
},
"date": {
"title": "Reservation Date",
"type": "string",
"description": "The date to check reservation availability for. Defaults to today if left empty.
Only used when Include Availability is enabled."
},
"partySize": {
"title": "Party Size",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Number of guests for the reservation (1–20).
Only used when Include Availability is enabled.",
"default": 2
}
}
},
"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
}
}
}
}
}
}
}
}
}
}