{ "openapi": "3.0.1", "info": { "title": "Agoda Scraper - Hotel Prices, Details and Reviews", "description": "Extract Agoda hotel prices, ratings, addresses and optional guest reviews across regional sites. Search cities or read hotel URLs, and pay per delivered row plus a start fee.", "version": "0.5", "x-build-id": "egS8tLCQXFQp6Gn5p" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lentic_clockss~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lentic_clockss-agoda-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/lentic_clockss~agoda-scraper/runs": { "post": { "operationId": "runs-sync-lentic_clockss-agoda-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/lentic_clockss~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-lentic_clockss-agoda-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": { "destination": { "title": "Destination", "type": "string", "description": "A city name such as Chiang Mai, Seoul or Tokyo, in a language Agoda recognizes. A name that is not recognized as a city returns no rows; hotel page URLs, a city page URL or a city ID take precedence." }, "regionId": { "title": "Agoda city ID", "pattern": "^\\d*$", "type": "string", "description": "Numeric Agoda city ID, such as 9395 for Bangkok. Used instead of destination, unless hotel page URLs or a city page URL are set." }, "cityPageUrl": { "title": "City page URL", "pattern": "^$|^(https?://)?([A-Za-z0-9-]+\\.)*agoda\\.[A-Za-z.]{2,10}/.*city/.+$", "type": "string", "description": "Agoda city page URL, such as https://www.agoda.com/city/bangkok-th.html. Returns listed hotels without dated prices; takes precedence over destination and regionId, but not detailUrls." }, "detailUrls": { "title": "Hotel page URLs", "type": "array", "description": "Up to 20 distinct Agoda hotel page URLs, such as https://www.agoda.com/asia-hotel-bangkok/hotel/bangkok-th.html. These take precedence over other targets; readable pages return hotel rows, with dated prices when available and optional review rows.", "items": { "type": "string" } }, "checkin": { "title": "Check-in date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Check-in date in YYYY-MM-DD format. Leave empty to use 21 days from today." }, "checkout": { "title": "Check-out date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Check-out date in YYYY-MM-DD format, 1 to 30 nights after check-in. Leave empty to use two nights after check-in." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of adults, from 1 to 10.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 10, "type": "integer", "description": "Number of children, from 0 to 10. Set childAges when children is above zero.", "default": 0 }, "childAges": { "title": "Children ages", "type": "array", "description": "Ages in years for each child, one entry per child (0-17). Required when children is above zero; each age becomes part of the search and pricing request.", "items": { "type": "string" } }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Number of rooms, from 1 to 10.", "default": 1 }, "maxResults": { "title": "Max results per search or hotel URL", "minimum": 1, "maximum": 500, "type": "integer", "description": "Most rows for each destination search, city page URL, or hotel page URL. Default 70; larger numbers are collected in parts of 70. Hotels and reviews count together. The whole run stops at your maximum total charge. Free Apify plan: up to 200 rows per run and 10 runs of this Actor.", "default": 70 }, "enrichDetails": { "title": "Read hotel pages", "type": "boolean", "description": "Add descriptions, amenities, FAQs and available address details to the first search-result hotels. Guest reviews are separate rows only when includeReviews is enabled.", "default": true }, "enrichLimit": { "title": "Hotel pages to read", "minimum": 0, "maximum": 20, "type": "integer", "description": "Number of search-result hotels to enrich, from 0 to 20. Direct hotel page inputs are read separately from this setting.", "default": 1 }, "includeReviews": { "title": "Return guest reviews", "type": "boolean", "description": "Return each available guest review as a separate billed row. Hotel and review rows share maxResults; this also enables hotel details.", "default": false }, "includeSponsored": { "title": "Include sponsored hotels", "type": "boolean", "description": "Keep hotels Agoda marks as sponsored.", "default": false }, "includeRooms": { "title": "Return room variants", "type": "boolean", "description": "Return each sellable room variant (room type, bed configuration, price plan) as a separate billed row, in addition to hotel and review rows. Room rows share maxResults.", "default": false }, "domain": { "title": "Agoda site", "pattern": "^(([A-Za-z0-9-]+\\.)*agoda\\.[A-Za-z.]{2,10})?$", "type": "string", "description": "Agoda site, such as www.agoda.com, www.agoda.co.th or www.agoda.co.jp. A supported country site determines the language and currency.", "default": "www.agoda.com" }, "locale": { "title": "Language (www.agoda.com)", "type": "string", "description": "Language and currency setting on www.agoda.com, such as en-us for USD or ja-jp for JPY. A supported country site overrides this setting.", "default": "en-us" } } }, "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 } } } } } } } } } }