{ "openapi": "3.0.1", "info": { "title": "Agoda Hotel Scraper API πŸ’°$1/1k β€” Listings & Prices", "description": "Agoda Hotel Scraper API β€” search hotels & accommodations by destination + dates. Per hotel: name, star rating, review score & count, nightly price, area, city, coordinates, type, image & URL. Any city, currency & locale. Pure HTTP, no browser. $1/1k flat, JSON or CSV out.", "version": "0.0", "x-build-id": "jXAlUGwcJLTW7G13U" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/memo23~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-memo23-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/memo23~agoda-scraper/runs": { "post": { "operationId": "runs-sync-memo23-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/memo23~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-memo23-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": { "startUrls": { "title": "Hotel URLs", "type": "array", "description": "Optional. Paste one or more Agoda hotel-page URLs (e.g. https://www.agoda.com/alkhayma-medina/hotel/marrakech-ma.html) to scrape those exact hotels. When provided, the destination/date search below is ignored and each URL is returned as a full priced row β€” name, nightly price, star rating, review score & count, location, amenities, image β€” resolved to its Agoda propertyId automatically. Combine with 'Include detailed review scores' for per-category sub-scores and description.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "location": { "title": "Destination", "type": "string", "description": "City or destination to search, e.g. London, Bangkok, New York. Resolved to Agoda's cityId automatically. Defaults to London. (Ignored when Hotel URLs are provided above.)" }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Check-in date. Leave empty to default to ~30 days from today (so the Actor always runs out of the box)." }, "checkOut": { "title": "Check-out date (optional)", "type": "string", "description": "Check-out date. If set, the number of nights is derived from it. Otherwise 'Nights' is used." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 28, "type": "integer", "description": "Length of stay in nights (ignored if a check-out date is given). Default 1.", "default": 1 }, "rooms": { "title": "Rooms", "minimum": 1, "type": "integer", "description": "Number of rooms.", "default": 1 }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "type": "integer", "description": "Number of child guests.", "default": 0 }, "childAges": { "title": "Child ages (optional)", "type": "array", "description": "Ages of the children, e.g. [5, 9]. Only used when Children > 0.", "items": { "type": "string" } }, "sortField": { "title": "Sort by", "enum": [ "Ranking", "Price", "Recommended", "Review", "Distance" ], "type": "string", "description": "How to sort the hotel results.", "default": "Ranking" }, "currency": { "title": "Currency", "type": "string", "description": "ISO 4217 currency code for prices, e.g. USD, EUR, GBP, THB.", "default": "USD" }, "market": { "title": "Locale", "type": "string", "description": "Site locale, e.g. en-gb, en-us, de-de. Affects language and some pricing.", "default": "en-gb" }, "maxItems": { "title": "Max results", "type": "integer", "description": "Maximum number of hotels to return.", "default": 100 }, "includeDetails": { "title": "Include detailed review scores & description", "type": "boolean", "description": "For each hotel, fetch its detail page to add per-category review sub-scores (cleanliness, location, staff, value…) with city averages, score distribution, 30-day review trend, description, and AI review highlights. Adds one extra request per hotel, so runs are slower.", "default": false }, "maxReviews": { "title": "Guest reviews per hotel", "minimum": 0, "type": "integer", "description": "Scrape up to this many individual guest reviews per hotel β€” review text, title, rating, traveler type, room type, length of stay, reviewer country, the hotel's response, and any review photos. 0 = skip reviews (default). Works in both modes; paginates extra requests per hotel, so large values Γ— many hotels run slower.", "default": 0 }, "reviewsSort": { "title": "Reviews sort order", "enum": [ "Most recent", "Highest rated", "Lowest rated", "Most helpful" ], "type": "string", "description": "Order in which guest reviews are scraped (only used when 'Guest reviews per hotel' is above 0).", "default": "Most recent" }, "starRatings": { "title": "Star ratings", "type": "array", "description": "Keep only hotels with these official star ratings. Empty = any.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars" ] } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Keep only these accommodation types (matched against each hotel's type). Empty = all.", "items": { "type": "string", "enum": [ "hotel", "apartment", "hostel", "resort", "villa", "guest", "homestay", "bungalow", "vacation" ], "enumTitles": [ "Hotel", "Apartment", "Hostel", "Resort", "Villa", "Guest house", "Homestay", "Bungalow", "Vacation home" ] } }, "priceMin": { "title": "Min price per night", "type": "integer", "description": "Only hotels with a nightly price at or above this (in the selected currency). Empty = no minimum." }, "priceMax": { "title": "Max price per night", "type": "integer", "description": "Only hotels with a nightly price at or below this (in the selected currency). Empty = no maximum." }, "minReviewScore": { "title": "Min review score", "minimum": 0, "maximum": 10, "type": "number", "description": "Only hotels with a guest review score at or above this (Agoda scale 0-10). Empty = no minimum." }, "maxReviewScore": { "title": "Max review score", "minimum": 0, "maximum": 10, "type": "number", "description": "Only hotels with a guest review score at or below this (Agoda scale 0-10). Empty = no maximum." }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Residential proxy is recommended (and on by default).", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } }, "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 } } } } } } } } } }