{ "openapi": "3.0.1", "info": { "title": "Agoda Prices Scraper — Hotel Rates & Availability by Date", "description": "Agoda hotel prices for exact dates and guests: every property in a destination or the hotels you name, with the cheapest nightly and total price, taxes, cancellation terms, stars, guest score and location. Sold-out and filtered hotels are free. Pay per priced hotel.", "version": "1.0", "x-build-id": "tY6jbH7v6sO39XPHJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kestrel~agoda-prices-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kestrel-agoda-prices-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/kestrel~agoda-prices-scraper/runs": { "post": { "operationId": "runs-sync-kestrel-agoda-prices-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/kestrel~agoda-prices-scraper/run-sync": { "post": { "operationId": "run-sync-kestrel-agoda-prices-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": { "locationQueries": { "title": "Destinations", "type": "array", "description": "Cities or areas as you would type them into Agoda (\"Lisbon\", \"Bangkok\", \"Bali\"), an Agoda city id (\"16364\"), or a search URL from agoda.com. Each becomes one search returning up to `maxHotelsPerQuery` properties in `sortBy` order.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Agoda URLs", "type": "array", "description": "Agoda property pages (agoda.com//hotel/.html) or search-result pages (agoda.com/search?city=…). A property URL is priced on its own; a search URL is treated like a destination.", "default": [], "items": { "type": "string" } }, "hotelIds": { "title": "Hotel ids", "type": "array", "description": "Agoda's numeric property ids, e.g. \"63820\". The fastest way to price a known list of properties: one small request each, no page read.", "default": [], "items": { "type": "string" } }, "hotelNames": { "title": "Hotel names", "type": "array", "description": "Property names, e.g. \"Tivoli Avenida Liberdade Lisbon\". Resolved through Agoda's own autocomplete; the best match is priced.", "default": [], "items": { "type": "string" } }, "checkIn": { "title": "Check-in", "type": "string", "description": "YYYY-MM-DD, or relative so schedules never go stale: \"30 days\", \"6 weeks\", \"tomorrow\". Past dates are refused.", "default": "30 days" }, "nights": { "title": "Nights", "minimum": 1, "maximum": 30, "type": "integer", "description": "Length of stay, 1-30. Totals are for the whole stay; nightly prices are per room per night.", "default": 1 }, "adults": { "title": "Adults", "minimum": 1, "maximum": 9, "type": "integer", "description": "Adults per booking, 1-9. Agoda prices the cheapest room that fits everyone.", "default": 2 }, "children": { "title": "Children", "minimum": 0, "maximum": 9, "type": "integer", "description": "Children per booking, 0-9. Give their ages in `childAges` for exact child rates.", "default": 0 }, "childAges": { "title": "Child ages", "type": "array", "description": "One age (0-17) per child, in order. Leave empty when there are no children.", "default": [], "items": { "type": "string" } }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 9, "type": "integer", "description": "Rooms per booking, 1-9. Prices are per room; totals cover all rooms for the stay.", "default": 1 }, "currency": { "title": "Currency", "type": "string", "description": "ISO code for every price, e.g. USD, EUR, GBP, THB, JPY. Agoda converts at its own rate.", "default": "USD" }, "sortBy": { "title": "Sort destination results", "enum": [ "best_match", "price_low", "guest_rating", "secret_deals" ], "type": "string", "description": "Order Agoda returns a destination's properties in, which is also the order the `rank` column follows and the order `maxHotelsPerQuery` cuts at. Property inputs ignore this.", "default": "best_match" }, "maxHotelsPerQuery": { "title": "Max hotels per destination", "minimum": 0, "maximum": 2000, "type": "integer", "description": "0 = every property Agoda lists for the stay (a big city runs to a few thousand). N = the first N in `sortBy` order — the main cost control. Agoda pages 45 at a time.", "default": 45 }, "maxPrice": { "title": "Max nightly price", "minimum": 0, "type": "number", "description": "0 = keep every priced hotel. N = keep only hotels whose cheapest nightly rate (before taxes, in `currency`) is at or under N. Filtered hotels are never billed — a daily \"anything under 80\" alert costs nothing on days without a match.", "default": 0 }, "minStars": { "title": "Min star rating", "minimum": 0, "maximum": 5, "type": "number", "description": "0 = any. 1-5 = keep only properties with at least this many stars. Unrated properties are filtered when this is set.", "default": 0 }, "minReviewScore": { "title": "Min guest score", "minimum": 0, "maximum": 10, "type": "number", "description": "0 = any. 1-10 = keep only properties whose guest review score is at least this. Unreviewed properties are filtered when this is set.", "default": 0 }, "freeCancellationOnly": { "title": "Free cancellation only", "type": "boolean", "description": "Keep only hotels whose cheapest rate is free to cancel. Filtered hotels are never billed.", "default": false }, "includeSoldOut": { "title": "Include sold-out properties", "type": "boolean", "description": "Also write a row (free) for properties Agoda lists but cannot price for the stay, with `sold_out: true` and every price empty. Off by default so the dataset stays a price list.", "default": false }, "calendarDays": { "title": "Price calendar days (properties only)", "minimum": 0, "maximum": 60, "type": "integer", "description": "0 = off. N = for each named property also read Agoda's price-trend calendar for N check-in dates from `checkIn` (up to 60): one `calendar` row per date that has a price, with Agoda's low/normal/high flag and the cheapest date ranked first. Dates Agoda has no cached price for are skipped and free.", "default": 0 }, "locale": { "title": "Locale", "type": "string", "description": "Agoda locale for names and areas, e.g. en-us, de-de, ja-jp, th-th. Prices are not affected.", "default": "en-us" }, "sessions": { "title": "Parallel sessions", "minimum": 1, "maximum": 16, "type": "integer", "description": "How many proxy sessions (egress IPs) run in parallel. More is faster; each is paced separately.", "default": 4 }, "perIp": { "title": "Requests per second per session", "minimum": 0.1, "maximum": 3, "type": "number", "description": "Pace for each session. Agoda tolerates about one request per second per IP; faster causes retries, not speed.", "default": 1 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy is required: Agoda throttles a single busy IP within a few pages. Datacenter proxies are enough for this endpoint.", "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 } } }, "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 } } } } } } } } } }