{ "openapi": "3.0.1", "info": { "title": "Agoda Scraper — Hotel Prices, Ratings & Availability", "description": "Scrape Agoda hotels, apartments and homes in any city for your dates: name, type, stars, review score and count, nightly and total price in any currency, discount, free cancellation, rooms left, address, coordinates and photos. Filter by stars, score, price and type. No login.", "version": "0.1", "x-build-id": "ekpYjiSathX9yh2Uk" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/yugenox~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-yugenox-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/yugenox~agoda-scraper/runs": { "post": { "operationId": "runs-sync-yugenox-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/yugenox~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-yugenox-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": { "locations": { "title": "📍 Cities", "type": "array", "description": "Cities to search, e.g. \"London\", \"Bangkok\", \"Paris, France\" (add the country when a name exists in several places). You can also paste Agoda city IDs (233 = London) or Agoda search / city page URLs.", "items": { "type": "string" } }, "maxItems": { "title": "Max properties", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Maximum number of properties for the whole run, shared fairly between your cities (a city with fewer leaves its share to the others). 0 = everything Agoda lists (up to 50,000).", "default": 100 }, "checkIn": { "title": "📅 Check-in", "type": "string", "description": "Check-in date (YYYY-MM-DD), or relative like \"30 days\". Empty = 14 days from today. Prices and availability are for these dates." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 30, "type": "integer", "description": "Length of stay (1–30 nights).", "default": 1 }, "checkOut": { "title": "Check-out (optional)", "type": "string", "description": "The check-out date (YYYY-MM-DD) or relative like \"33 days\". When set, it decides the number of nights instead of Nights." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 36, "type": "integer", "description": "Number of adults.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 9, "type": "integer", "description": "Number of children.", "default": 0 }, "childAges": { "title": "Children’s ages", "type": "array", "description": "Age of each child (0–17), e.g. 5 and 9. Missing ages count as 8.", "items": { "type": "string" } }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 9, "type": "integer", "description": "Number of rooms.", "default": 1 }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "CAD", "AUD", "NZD", "SGD", "HKD", "JPY", "KRW", "CNY", "TWD", "THB", "MYR", "IDR", "PHP", "VND", "INR", "AED", "SAR", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "TRY", "ILS", "BRL", "MXN", "ZAR", "RUB" ], "type": "string", "description": "Currency for all prices.", "default": "USD" }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "price-asc", "price-desc", "review-score", "review-count", "stars-desc", "stars-asc", "distance" ], "type": "string", "description": "Order of the results (as on Agoda).", "default": "recommended" }, "language": { "title": "Language", "enum": [ "en-us", "en-gb", "en-au", "en-ca", "en-in", "en-sg", "fr-fr", "de-de", "es-es", "it-it", "pt-pt", "nl-nl", "ja-jp", "ko-kr", "zh-cn", "zh-tw", "zh-hk", "th-th", "vi-vn", "id-id", "ms-my" ], "type": "string", "description": "Language of property names and areas.", "default": "en-us" }, "starRatings": { "title": "Star rating", "type": "array", "description": "Only properties with these star ratings (4 includes 4.5). Empty = all.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "minReviewScore": { "title": "Minimum guest score", "minimum": 1, "maximum": 10, "type": "integer", "description": "Only properties with a guest review score of at least this (out of 10), e.g. 8. Empty = all." }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "type": "integer", "description": "In the chosen currency, before taxes." }, "maxPrice": { "title": "Maximum price per night", "minimum": 0, "type": "integer", "description": "In the chosen currency, before taxes." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Only these types. Empty = all.", "items": { "type": "string", "enum": [ "hotel", "apartment", "serviced-apartment", "resort", "hostel", "guesthouse", "bed-and-breakfast", "villa", "entire-house", "homestay", "country-house", "boat", "holiday-park" ], "enumTitles": [ "Hotel", "Apartment / flat", "Serviced apartment", "Resort", "Hostel", "Guesthouse / B&B", "Bed & breakfast", "Villa", "Entire house", "Homestay", "Country house", "Boat / cruise", "Holiday park / caravan park" ] } }, "onlyAvailable": { "title": "Only available properties", "type": "boolean", "description": "Leave out properties that are sold out for your dates (they are never charged). Off = sold-out properties are included with isAvailable false and no price.", "default": false }, "marketCountry": { "title": "Market country", "type": "string", "description": "Two-letter country code of the market Agoda prices for (prices and deals can differ by the visitor’s country). Default US.", "default": "US" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) is the default and comes with every Apify plan. If Agoda refuses datacenter IPs for a while, the run switches to residential proxies when your account has them.", "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 } } } } } } } } } }