Agoda Scraper
Pricing
from $2.49 / 1,000 results
You can access the Agoda Scraper programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in API & Integrations in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "gsqj8REMaZYr81wQz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapeai~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapeai-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/scrapeai~agoda-scraper/runs": { "post": { "operationId": "runs-sync-scrapeai-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/scrapeai~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-scrapeai-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": "Shared Start URLs", "type": "array", "description": "Public Agoda search, listing, or detail URLs.", "items": { "type": "object", "properties": { "url": { "title": "URL", "description": "A public listing, detail, or search URL.", "type": "string" } }, "required": [ "url" ] }, "default": [ { "url": "https://www.agoda.com/city/bangkok-th.html" } ] }, "query": { "title": "Search Query", "type": "string", "description": "Optional query metadata passed to adapters. Use explicit public startUrls when the portal requires a concrete route or search identifier.", "default": "" }, "location": { "title": "Location", "type": "string", "description": "Optional city, postcode, state, country, or neighbourhood.", "default": "" }, "listingType": { "title": "Listing Type", "enum": [ "sale", "rent", "sold", "auction", "stay", "all" ], "type": "string", "description": "Preferred transaction or accommodation mode where supported.", "default": "sale" }, "propertyType": { "title": "Property Type", "type": "string", "description": "Optional portal-specific property type filter.", "default": "" }, "maxItemsPerActor": { "title": "Max Items per Actor", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum detailed records emitted by each selected adapter.", "default": 10 }, "maxPagesPerActor": { "title": "Max Pages per Actor", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum search/list pages followed per actor.", "default": 2 }, "includeDetails": { "title": "Open Detail Pages", "type": "boolean", "description": "Open each listing detail page to enrich the output.", "default": true }, "includeRawData": { "title": "Include Raw Data", "type": "boolean", "description": "Keep selected JSON-LD, metadata, card data, and JSON responses under rawData.", "default": true }, "scrollCount": { "title": "Scroll Count", "minimum": 0, "maximum": 20, "type": "integer", "description": "Number of incremental scrolls used for lazy-loaded results.", "default": 3 }, "requestTimeoutSecs": { "title": "Request Timeout", "minimum": 10, "maximum": 180, "type": "integer", "description": "Maximum seconds allowed for one page.", "default": 45 }, "maxConcurrency": { "title": "Max Concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Concurrent browser pages. Keep low for public portals.", "default": 2 }, "maxRequestRetries": { "title": "Max Request Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Retries for transient HTTP blocks and navigation failures. Retries use session rotation and backoff.", "default": 3 }, "sameDomainDelaySecs": { "title": "Same-Domain Delay", "minimum": 0, "maximum": 30, "type": "integer", "description": "Minimum delay between requests to the same portal, in seconds.", "default": 3 }, "proxyEnabled": { "title": "Enable Authorized Proxy", "type": "boolean", "description": "Use an authorized Apify or user-supplied proxy route when available. This does not bypass access controls and may incur proxy costs.", "default": false }, "proxyUrls": { "title": "Custom Proxy URLs", "type": "array", "description": "Optional custom proxy URLs (http://user:pass@host:port) to route requests through.", "items": { "type": "string" }, "default": [] }, "serpApiKey": { "title": "SerpApi API Key", "type": "string", "description": "Optional SerpApi API key used as fallback data provider when portals are blocked.", "default": "" }, "captchaApiKey": { "title": "CAPTCHA Solver API Key", "type": "string", "description": "Optional CapSolver, 2Captcha, or Anti-Captcha API key to automatically solve challenge pages.", "default": "" }, "headless": { "title": "Headless Browser", "type": "boolean", "description": "Run Chromium without a visible window.", "default": true }, "testMode": { "title": "Fixture Smoke Test", "type": "boolean", "description": "Run an offline fixture smoke test for every selected adapter instead of visiting websites.", "default": false }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Optional Apify proxy configuration used when proxyEnabled is true.", "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Agoda Scraper from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: