{ "openapi": "3.0.1", "info": { "title": "Agoda API Scraper", "description": "Scrapes Agoda accommodation search results, pricing and property details via Agoda's public GraphQL endpoints (requests-based, no browser).", "version": "0.1", "x-build-id": "USPeTH0HcFO5Yg7sj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/rl1987~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-rl1987-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/rl1987~agoda-scraper/runs": { "post": { "operationId": "runs-sync-rl1987-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/rl1987~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-rl1987-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": { "search": { "title": "Destination", "type": "string", "description": "Place name (city, region, landmark) resolved via Agoda's own destination autocomplete. The easiest way to start — e.g. \"Bangkok\". Leave City ID empty if you use this." }, "cityId": { "title": "City ID", "type": "integer", "description": "Advanced: exact numeric Agoda city id, e.g. 9395 for Bangkok. Use only if you already know the id; otherwise just fill in Destination above." }, "propertyIds": { "title": "Property IDs", "type": "array", "description": "Scrape specific properties by their numeric Agoda property ID (bypasses search, returns static details only — no live pricing). Add one ID per line, e.g. 10636. When set, Destination/City ID is ignored.", "items": { "type": "string" } }, "checkin": { "title": "Check-in", "type": "string", "description": "Arrival date. Defaults to 30 days from the run date." }, "checkout": { "title": "Check-out", "type": "string", "description": "Departure date. Defaults to check-in + 1 night." }, "rooms": { "title": "Rooms", "minimum": 1, "type": "integer", "description": "Number of rooms to book for.", "default": 1 }, "adults": { "title": "Adults", "minimum": 1, "type": "integer", "description": "Number of adult guests.", "default": 2 }, "childrenAges": { "title": "Children ages", "type": "array", "description": "Add one child age (in years) per line, e.g. 5 then 9 for two children. Leave empty for no children.", "items": { "type": "string" } }, "currency": { "title": "Currency", "enum": [ "USD", "EUR", "GBP", "AUD", "CAD", "CHF", "CNY", "JPY", "INR", "BRL", "MXN", "SEK", "NOK", "DKK", "PLN", "AED", "SGD", "ZAR", "TRY", "THB" ], "type": "string", "description": "Currency for displayed prices.", "default": "USD" }, "language": { "title": "Language / locale", "enum": [ "en-us", "en-gb", "de", "fr", "es", "it", "nl", "pt", "pt-br", "pl", "ru", "ja", "zh-cn", "zh-tw", "ko", "ar", "tr", "sv", "da", "no", "fi" ], "type": "string", "description": "Locale for localized text (names, facilities).", "default": "en-us" }, "sortBy": { "title": "Sort by", "enum": [ "Ranking", "Price", "AllGuestsReviewScore" ], "type": "string", "description": "Order of the returned accommodations.", "default": "Ranking" }, "includeDetails": { "title": "Include static details", "type": "boolean", "description": "Add a `details` object per property: address, review breakdown and useful info (check-in/out times, property age, extras). Costs one extra request per batch of 20 properties in search mode.", "default": false }, "maxItems": { "title": "Max accommodations", "minimum": 1, "type": "integer", "description": "Maximum number of accommodations to return.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. Apify Proxy recommended.", "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 } } } } } } } } } }