{ "openapi": "3.0.1", "info": { "title": "Agoda Scraper", "description": "Scrape Agoda: every hotel, apartment and hostel in any city with live prices for your dates, discounts, free cancellation, stars, guest scores, facilities, GPS and photos. Gets past the 1,000-result cap. Filter by price, stars, score, type, area. Optional reviews.", "version": "1.0", "x-build-id": "OmiUJbNPnGexEYNwn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/normdata~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-normdata-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/normdata~agoda-scraper/runs": { "post": { "operationId": "runs-sync-normdata-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/normdata~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-normdata-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": { "maxItems": { "title": "Maximum properties", "minimum": 1, "type": "integer", "description": "Stop after this many properties. Leave empty for no limit (every property that matches, even past Agoda's 1,000-result cap). The Apify Free plan is always capped at 10." }, "cities": { "title": "Cities", "type": "array", "description": "City names in English, e.g. \"Lisbon\", \"Bangkok\", \"Tokyo\". Add the country for ambiguous names (\"Paris, France\"). A number is read as an Agoda city ID.", "items": { "type": "string" } }, "urls": { "title": "...or paste links", "type": "array", "description": "City pages (agoda.com/city/lisbon-pt.html) or search pages that carry a city ID (agoda.com/search?city=16364).", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "checkIn": { "title": "Check-in date", "type": "string", "description": "A date (2026-11-20) or a relative one (\"+14 days\")." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 30, "type": "integer", "description": "Length of the stay (1 to 30).", "default": 1 }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 9, "type": "integer", "description": "Rooms to book (1 to 9). Prices are per room per night.", "default": 1 }, "adults": { "title": "Adults", "minimum": 1, "maximum": 36, "type": "integer", "description": "Adults in total (at least one per room).", "default": 2 }, "childAges": { "title": "Children ages", "type": "array", "description": "One age (0 to 17) per child, e.g. 5 and 9 for two children. Leave empty for none.", "items": { "type": "string" } }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "NZD", "CHF", "SEK", "NOK", "DKK", "PLN", "CZK", "HUF", "JPY", "KRW", "CNY", "HKD", "TWD", "SGD", "THB", "INR", "IDR", "MYR", "PHP", "VND", "BRL", "MXN", "ARS", "CLP", "COP", "PEN", "ZAR", "TRY", "ILS", "AED", "SAR" ], "type": "string", "description": "Currency for every price.", "default": "USD" }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only these types. Leave empty for all.", "items": { "type": "string", "enum": [ "34", "29", "120", "37", "122", "28", "131", "32", "141", "135", "33", "108", "111", "35", "112", "38", "105", "113", "103", "136", "106", "107", "109", "110", "114", "102", "145", "147", "148", "140", "144" ], "enumTitles": [ "Hotel", "Apartment", "Serviced apartment", "Resort", "Resort villa", "Villa", "Entire house", "Guesthouse / B&B", "Guest house", "Bed & breakfast", "Hostel", "Homestay", "Inn", "Motel", "Lodge", "Ryokan", "Capsule hotel", "Love hotel", "Entire bungalow", "Cabin", "Chalet", "Country house", "Farm stay", "Holiday park", "Tent", "Boat / cruise", "Loft", "Townhouse", "Treehouse", "Dome house", "Igloo" ] } }, "starRatings": { "title": "Star ratings", "type": "array", "description": "Keep only these star ratings. \"Unrated\" covers apartments and homes without stars.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1", "0" ], "enumTitles": [ "5 stars", "4 stars", "3 stars", "2 stars", "1 star", "Unrated" ] } }, "minReviewScore": { "title": "Min guest score", "enum": [ "6", "7", "8", "9" ], "type": "string", "description": "Out of 10." }, "minReviews": { "title": "Min reviews", "minimum": 0, "type": "integer", "description": "Skip places with fewer reviews than this." }, "minPrice": { "title": "Min price per night", "minimum": 0, "type": "integer", "description": "Per room per night, in the chosen currency, before taxes and fees." }, "maxPrice": { "title": "Max price per night", "minimum": 0, "type": "integer", "description": "Per room per night, in the chosen currency, before taxes and fees." }, "facilities": { "title": "Must have", "type": "array", "description": "Keep only places with ALL of these.", "items": { "type": "string", "enum": [ "90", "93", "80", "17", "92", "116", "89", "15", "91", "11", "83", "24", "10", "16", "88", "56" ], "enumTitles": [ "Internet", "Swimming pool", "Car park", "Airport transfer", "Gym / fitness", "24-hour front desk", "Family / child friendly", "Non-smoking", "Spa / sauna", "Restaurants", "Smoking area", "Pets allowed", "Nightclub", "Facilities for disabled guests", "Business facilities", "Golf course (on site)" ] } }, "areas": { "title": "Neighbourhoods", "type": "array", "description": "Keep only these areas of the city, as Agoda names them, e.g. \"Baixa\", \"Alfama\" in Lisbon or \"Sukhumvit\" in Bangkok. A partial name works. The log lists the city's areas if a name isn't found.", "items": { "type": "string" } }, "freeCancellationOnly": { "title": "Free cancellation only", "type": "boolean", "description": "Keep only offers you can cancel for free.", "default": false }, "payAtHotelOnly": { "title": "Pay at the hotel only", "type": "boolean", "description": "Keep only offers you pay at the property.", "default": false }, "noCreditCardOnly": { "title": "No credit card needed only", "type": "boolean", "description": "Keep only offers you can book without a credit card.", "default": false }, "dealsOnly": { "title": "Discounted only", "type": "boolean", "description": "Keep only places showing a discount against their usual price.", "default": false }, "includeSoldOut": { "title": "Include sold-out places", "type": "boolean", "description": "Also save places with no rooms left for your stay (without prices). Off by default.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "recommended", "price_asc", "price_desc", "rating", "reviews", "stars", "distance" ], "type": "string", "description": "Order of the results. Matters most when you set a Maximum.", "default": "recommended" }, "includeImages": { "title": "Photo gallery", "type": "boolean", "description": "Adds \"images\": up to 10 photo links with captions per property. The main photo is always included.", "default": false }, "includeReviews": { "title": "Reviews", "type": "boolean", "description": "Adds \"reviews\": newest guest reviews with score, title, text, pros and cons, stay dates, room, traveller type and country. Paid add-on: one extra charge per property saved with reviews (see Pricing).", "default": false }, "maxReviews": { "title": "Reviews per property", "minimum": 1, "type": "integer", "description": "How many of the newest reviews to keep per property.", "default": 20 } } }, "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 } } } } } } } } } }