{ "openapi": "3.0.1", "info": { "title": "Agoda API (Unofficial) | Agoda Guest Reviews & Ratings", "description": "Scrape Agoda guest reviews at $0.50 per 1,000 with this unofficial Agoda API, cheaper than the leading tools: Agoda and Booking.com reviews, owner replies, ratings, hotel scores and sub-scores. Many hotels per run by link, ID or name.", "version": "0.1", "x-build-id": "56epSu9VfvaimvWaZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/aurelix~agoda-reviews-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-aurelix-agoda-reviews-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/aurelix~agoda-reviews-scraper/runs": { "post": { "operationId": "runs-sync-aurelix-agoda-reviews-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/aurelix~agoda-reviews-scraper/run-sync": { "post": { "operationId": "run-sync-aurelix-agoda-reviews-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": { "hotels": { "title": "Hotels", "type": "array", "description": "Agoda hotels, mixed freely: a hotel link (e.g. 'https://www.agoda.com/the-peninsula-bangkok/hotel/bangkok-th.html', any language version, its reviews page or a link with ?hid= / selectedproperty=), an Agoda hotel ID (e.g. '10715') or a hotel name with its city (e.g. 'Ibis Budapest City'; the first property Agoda's own search suggests is used and named in the run's status).", "default": [], "items": { "type": "string" } }, "maxReviewsPerHotel": { "title": "Reviews per hotel", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most reviews to return for each hotel, e.g. 500. Big hotels list a few thousand written reviews; Agoda's review list stops at 5,000 per review source. Set a high number to get them all.", "default": 100 }, "sortBy": { "title": "Review order", "enum": [ "newest", "highest", "lowest", "helpful" ], "type": "string", "description": "Which reviews come first. With 'Reviews newer than' or 'Only new reviews' the Actor always reads newest first, so it can stop each hotel as soon as nothing more can match.", "default": "newest" }, "sources": { "title": "Review sources", "type": "array", "description": "Agoda shows reviews from its own guests and from Booking.com guests on the same page. Leave empty for all of them.", "items": { "type": "string", "enum": [ "Agoda", "Booking.com" ], "enumTitles": [ "Agoda guests", "Booking.com guests" ] }, "default": [] }, "language": { "title": "Review language", "type": "string", "description": "Only reviews written in this language: a code such as en, ja, ko, de, fr, zh-TW, th or pt (or the language's English name). Every review comes with Agoda's English translation where it has one, plus the original text. Leave empty for all languages.", "default": "" }, "minRating": { "title": "Lowest rating", "minimum": 1, "maximum": 10, "type": "number", "description": "Only reviews rated at least this on Agoda's 1-10 scale, e.g. 8 or 8.5. Leave empty for all." }, "maxRating": { "title": "Highest rating", "minimum": 1, "maximum": 10, "type": "number", "description": "Only reviews rated at most this, e.g. 6 to collect complaints. Leave empty for all." }, "reviewsNewerThan": { "title": "Reviews newer than", "type": "string", "description": "Only reviews written on or after this date, e.g. 2026-01-31, or a relative time such as '30 days'. Leave empty for all." }, "onlyNewReviews": { "title": "Only new reviews", "type": "boolean", "description": "Return only reviews that your earlier runs did not return (one memory per hotel). The first run returns everything; schedule it daily to get each day's new reviews.", "default": false }, "trackingName": { "title": "Tracking name (optional)", "type": "string", "description": "Name for the 'previous runs' memory used by 'Only new reviews', e.g. 'my-hotels-daily'. Runs with the same name share one memory; leave empty to share one memory across all your runs." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxy (the default, no extra cost) lets the Actor move to a fresh IP when Agoda starts slowing one connection down, which keeps long runs complete. Residential proxy is not offered: Agoda does not need it.", "default": { "useApifyProxy": true } }, "slackWebhookUrl": { "title": "Slack webhook URL (optional)", "type": "string", "description": "After each run, post a short digest to Slack: how many reviews were saved (new reviews only when 'Only new reviews' is on) and the top 10, e.g. https://hooks.slack.com/services/T000/B000/XXXX. Nothing is posted when the run saved nothing. Leave empty to skip." }, "webhookUrl": { "title": "Webhook URL (optional)", "type": "string", "description": "After each run, POST the same digest as JSON (actor, newOnly, count, items = top 10 reviews, runUrl, text) to any URL, e.g. a Zapier, Make or n8n webhook. Nothing is sent when the run saved nothing. Leave empty to skip." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }