{
"openapi": "3.0.1",
"info": {
"title": "Agoda Reviews Scraper โ Hotel Guest Reviews & Ratings",
"description": "Scrape hotel guest reviews and ratings from Agoda, including the Booking.com review pool on the same page: rating, text, traveler type, room booked, length of stay, reviewer country and date, plus live room prices. Hotel review data for any property.",
"version": "0.1",
"x-build-id": "kmD7sMVXJ5hEIU93e"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/lergassy~agoda-reviews-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-lergassy-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/lergassy~agoda-reviews-scraper/runs": {
"post": {
"operationId": "runs-sync-lergassy-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/lergassy~agoda-reviews-scraper/run-sync": {
"post": {
"operationId": "run-sync-lergassy-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",
"required": [
"startUrls"
],
"properties": {
"startUrls": {
"title": "๐จ Agoda hotel URLs",
"type": "array",
"description": "Paste one or more links to hotel pages on Agoda.com โ open a hotel there and copy the address from your browser. Example: https://www.agoda.com/the-magani-hotel-and-spa/hotel/bali-id.html",
"items": {
"type": "string"
}
},
"mode": {
"title": "What to scrape",
"enum": [
"reviews",
"hotel",
"both",
"rooms"
],
"type": "string",
"description": "Hotel info, reviews, or both. \"Hotel info + reviews\" writes two kinds of row into one dataset, so columns that belong to the other kind stay empty โ pick it only if you want both in one export.",
"default": "reviews"
},
"includeRooms": {
"title": "๐๏ธ Room rates and availability ($)",
"type": "boolean",
"description": "Fetch the rooms on sale for your dates: room name, size, bedding, occupancy, breakfast, cancellation terms and the nightly price. Charged per offer returned.",
"default": false
},
"checkIn": {
"title": "๐
Check-in",
"type": "string",
"description": "First night of the stay, YYYY-MM-DD. Leave empty and the Actor prices a stay 30 days out, which is what most rate checks want."
},
"checkOut": {
"title": "๐
Check-out",
"type": "string",
"description": "Last day of the stay, YYYY-MM-DD. Leave empty to use the number of nights below."
},
"nights": {
"title": "Nights",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "Used when only a check-in date is given.",
"default": 1
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 20,
"type": "integer",
"description": "Guests to price the room for.",
"default": 2
},
"children": {
"title": "Children",
"minimum": 0,
"maximum": 10,
"type": "integer",
"description": "Number of children in the room.",
"default": 0
},
"childrenAges": {
"title": "Children's ages",
"type": "array",
"description": "One age per child. Agoda prices some rooms differently by age.",
"items": {
"type": "string"
}
},
"roomsWanted": {
"title": "Rooms",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many rooms the stay needs.",
"default": 1
},
"currency": {
"title": "๐ฑ Currency",
"enum": [
"USD",
"EUR",
"GBP",
"AUD",
"NZD",
"SGD",
"HKD",
"MYR",
"THB",
"IDR",
"KRW"
],
"type": "string",
"description": "Currency for the prices.",
"default": "USD"
},
"reviewsProvider": {
"title": "Review source",
"enum": [
"agoda",
"booking",
"all"
],
"type": "string",
"description": "Which review feed to read. Agoda shows guest reviews from its own site and from Booking.com, and it genuinely serves the same review under both โ so picking one or the other changes the order and the mix, not always the whole set, and a review can appear in either. With All each review is written once and charged once, whichever feed it came through; the source column says which one that was.",
"default": "all"
},
"reviewLanguages": {
"title": "๐ Review languages",
"type": "array",
"description": "Reviews come back in whatever language they were written in, whichever option you pick here โ this is not a translation setting. Each language edition of Agoda orders the review pool differently, so walking a second edition picks up rows the first walk was cut short of, worth about 5% on a measured Bali hotel. Extra editions cost nothing until the first one runs out of reviews. Narrow this to one language only if you want a faster, shallower run.",
"items": {
"type": "string",
"enum": [
"en-us",
"ja-jp",
"zh-cn",
"zh-tw",
"ko-kr",
"id-id",
"th-th",
"vi-vn",
"ms-my",
"ru-ru",
"de-de",
"fr-fr",
"es-es",
"it-it",
"nl-nl",
"pt-pt",
"ar-ae",
"tr-tr"
],
"enumTitles": [
"English",
"Japanese",
"Chinese (Simplified)",
"Chinese (Traditional)",
"Korean",
"Indonesian",
"Thai",
"Vietnamese",
"Malay",
"Russian",
"German",
"French",
"Spanish",
"Italian",
"Dutch",
"Portuguese",
"Arabic",
"Turkish"
]
},
"default": [
"en-us",
"ja-jp",
"zh-cn",
"zh-tw",
"ko-kr",
"id-id",
"th-th",
"vi-vn",
"ms-my",
"ru-ru",
"de-de",
"fr-fr",
"es-es",
"it-it",
"nl-nl",
"pt-pt",
"ar-ae",
"tr-tr"
]
},
"maxReviewsPerHotel": {
"title": "๐ฏ Max reviews per hotel",
"minimum": 1,
"maximum": 10000,
"type": "integer",
"description": "How many reviews to return for each hotel, counted across both review sources together. The same review is never written twice, so picking both sources gives you a wider pool to fill this number from, not a doubled bill.",
"default": 100
},
"maxResults": {
"title": "๐งพ Max results for the whole run",
"minimum": 1,
"type": "integer",
"description": "A ceiling on the rows this run may return, counted over every hotel in the list. The per-hotel limit above says nothing about how many hotels you pasted, so this is the safety net: forty hotels at 10,000 reviews each is 400,000 rows. Leave empty for no ceiling."
},
"reviewsSort": {
"title": "Sort reviews by",
"enum": [
"recent",
"ratingDesc",
"ratingAsc",
"helpful"
],
"type": "string",
"description": "Order in which reviews are scraped",
"default": "recent"
},
"minRating": {
"title": "โญ Minimum rating",
"minimum": 1,
"maximum": 10,
"type": "number",
"description": "Keep only reviews rated at least this, on Agoda's 1โ10 scale. Leave empty for all reviews."
},
"cutoffDate": {
"title": "๐
Only reviews since",
"pattern": "^\\d{4}-\\d{2}-\\d{2}$",
"type": "string",
"description": "Skip reviews written before this date, format YYYY-MM-DD. With the default \"Most recent\" sort the Actor stops paging once it reaches older reviews, so incremental daily runs cost only the new reviews."
},
"proxyConfiguration": {
"title": "Proxy configuration",
"type": "object",
"description": "Proxy settings. Recommended for larger runs.",
"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
},
"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
}
}
}
}
}
}
}
}
}
}