{ "openapi": "3.0.1", "info": { "title": "Resy Availability & Scarcity Monitor", "description": "Forward-dated restaurant reservation availability from Resy: slot counts, prime-time counts, first and last seating, seating types, sold-out flags. Delta mode returns only what moved. Read-only: books nothing, no account, no personal data.", "version": "0.1", "x-build-id": "g1duWPt5babZ3Xk1u" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/zhorex~resy-availability-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-zhorex-resy-availability-monitor", "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/zhorex~resy-availability-monitor/runs": { "post": { "operationId": "runs-sync-zhorex-resy-availability-monitor", "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/zhorex~resy-availability-monitor/run-sync": { "post": { "operationId": "run-sync-zhorex-resy-availability-monitor", "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": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "venue_watch", "metro_scan" ], "type": "string", "description": "'Watch venues' is the comp-set product: give it venue ids and it prices each one across your date window — one small, fast request per venue-date. 'Scan metro' sweeps a whole city by coordinates to discover venues and their ids, then you feed the ones you care about into watch mode.", "default": "metro_scan" }, "metros": { "title": "Metros (scan mode)", "type": "array", "description": "City slugs to sweep. Available: new-york, los-angeles, chicago, san-francisco, miami, boston, washington-dc, austin, seattle, denver, atlanta, philadelphia, dallas, houston, las-vegas, new-orleans, nashville, san-diego, toronto, london. Resy's depth is US-centric — New York, Miami, Chicago, San Francisco, Boston and Washington DC carry hundreds of venues; London and Toronto are thin.", "items": { "type": "string" } }, "venueIds": { "title": "Venue IDs (watch mode)", "type": "array", "description": "Resy venue ids for your comp set. Run 'Scan metro' once and take the venueId column — every row carries it, along with the venue's url slug. Each venue-date is a single ~34 KB request, so a 40-venue comp set across 30 dates is 1,200 fast requests.", "items": { "type": "string" } }, "startDaysAhead": { "title": "First date (days from today)", "minimum": 0, "maximum": 365, "type": "integer", "description": "Where the window starts. 1 = tomorrow. Tonight's availability behaves differently from forward dates, so comp-set work usually starts at 1.", "default": 1 }, "horizonDays": { "title": "Horizon (number of dates)", "minimum": 1, "maximum": 365, "type": "integer", "description": "How many dates to price from the first one. 14 gives a fortnight; 30 a month. Rows = venues x dates x party sizes, one request each.", "default": 14 }, "dateStepDays": { "title": "Date step", "minimum": 1, "maximum": 30, "type": "integer", "description": "1 = every date. 7 = the same weekday each week, which is the cheap way to watch a long season — Saturday scarcity is a different signal from Tuesday scarcity, so keeping the weekday fixed makes the trend readable.", "default": 1 }, "partySizes": { "title": "Party sizes", "type": "array", "description": "Availability is quoted per party size, and a table for 2 is a completely different scarcity picture from a table for 6. Add every size your analysis needs — each one multiplies rows.", "items": { "type": "string" }, "default": [ "2" ] }, "metroPageSize": { "title": "Venues per request (scan mode)", "minimum": 1, "maximum": 400, "type": "integer", "description": "Page size for a metro sweep. Keep it at 100 or below: the response carries roughly 80 KB per venue, so an uncapped New York request is around 180 MB — almost all of it images the Actor discards.", "default": 100 }, "metroMaxVenues": { "title": "Max venues per metro-date (scan mode)", "minimum": 1, "maximum": 4000, "type": "integer", "description": "How deep to paginate a metro. New York has thousands of venues; 200 gets you the well-known ones, 1,000+ approaches full coverage at proportional cost.", "default": 200 }, "deltaMode": { "title": "Delta mode — only availability that MOVED", "type": "boolean", "description": "Turn this on for a scheduled monitor. The first run records a baseline; every later run returns and bills ONLY cells that changed — sold out, reopened after being full, prime window emptied, or slot count shifted beyond the noise floor — with the previous counts attached. Unchanged cells are never charged. This is also the only way to build a scarcity history: nobody, including this Actor, can retro-fetch how full a restaurant was last Tuesday.", "default": false }, "deltaStateKey": { "title": "Delta stream name", "type": "string", "description": "Names an independent delta stream so several monitors don't collide (e.g. 'nyc-compset' vs 'miami-season'). Only used when Delta mode is on.", "default": "default" }, "latitude": { "title": "Custom latitude (optional)", "type": "string", "description": "Sweep a point that isn't in the metro list. Pair with longitude. Resy's radius covers a real metro — a New York sweep reaches ~19 miles out." }, "longitude": { "title": "Custom longitude (optional)", "type": "string", "description": "Sweep a point that isn't in the metro list. Pair with latitude." }, "proxyConfiguration": { "title": "Proxy (optional — not required)", "type": "object", "description": "Not needed: this data is served to ordinary datacenter IPs and 12 rapid consecutive requests returned 12 successes with no throttling. Leave it off unless you specifically want your traffic routed — turning it on costs proxy usage without improving results.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }