{ "openapi": "3.0.1", "info": { "title": "Restaurant Discovery API by City", "description": "Restaurants by city/country: ratings, reviews count, phone, address, coordinates, price, menu, cuisines, hours, delivery/booking, awards and review snippets. Optional full reviews.", "version": "0.3", "x-build-id": "z7EfTri0jaTfGfbms" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quiago~restaurant-discovery-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quiago-restaurant-discovery-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/quiago~restaurant-discovery-api/runs": { "post": { "operationId": "runs-sync-quiago-restaurant-discovery-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/quiago~restaurant-discovery-api/run-sync": { "post": { "operationId": "run-sync-quiago-restaurant-discovery-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": { "query": { "title": "City / country / municipality", "type": "string", "description": "Place name to resolve to a geoId (e.g. \"Dubai\", \"Spain\"). Ignored if geoId is set. Defaults to \"Dubai\" so a zero-config run works.", "default": "Dubai" }, "geoId": { "title": "TripAdvisor geoId", "type": "integer", "description": "Exact TripAdvisor geo id (e.g. 295424 for Dubai). Takes precedence over the query." }, "maxItems": { "title": "Max restaurants", "minimum": 1, "type": "integer", "description": "Cap on restaurants fetched (before filtering). Default 100. Ignored when 'Get ALL results' is on.", "default": 100 }, "getAllResults": { "title": "Get ALL results", "type": "boolean", "description": "Ignore 'Max restaurants' and fetch the entire geo (auto-partitions geos above TripAdvisor's ~10k cap). Can be large and slow.", "default": false }, "includeSponsored": { "title": "Include sponsored listings", "type": "boolean", "description": "Keep paid/sponsored listings mixed with organic ones.", "default": true }, "minRating": { "title": "Minimum rating", "minimum": 0, "maximum": 5, "type": "number", "description": "Keep only restaurants with rating >= this value (0-5)." }, "minReviews": { "title": "Minimum review count", "minimum": 0, "type": "integer", "description": "Keep only restaurants with at least this many reviews." }, "onlyOpenNow": { "title": "Only open now", "type": "boolean", "description": "Keep only restaurants currently open.", "default": false }, "withReviews": { "title": "Fetch full reviews", "type": "boolean", "description": "Also fetch full reviews per restaurant (slower / more units).", "default": false }, "reviewsLimit": { "title": "Reviews per restaurant", "minimum": 1, "type": "integer", "description": "Cap reviews per restaurant. Empty = all reviews. Only used when 'Fetch full reviews' is on." }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Strongly recommended: use Apify Residential proxies. Datacenter IPs are challenged by TripAdvisor's anti-bot (datadome).", "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 } } } } } } } } } }