{ "openapi": "3.0.1", "info": { "title": "Agoda Scraper: Hotel and Home Prices, Availability", "description": "Agoda hotel and home prices for your stay by city, area, landmark, map area, link or id, a whole city per run, no login. Rows: nightly and stay price with taxes, deal, stars, guest score, rooms left, free cancellation. Add room offers, reviews or a country's prices. JSON, CSV, API; pay per property.", "version": "0.1", "x-build-id": "iiBmn1SCnbcmAnzy7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~agoda-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-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/automation_craft~agoda-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-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/automation_craft~agoda-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-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": "Places or property names", "type": "array", "description": "City, area, landmark, region or property names, for example \"Bangkok\", \"Sukhumvit\", \"Shinjuku\", \"Ubud\" or \"Marina Bay Sands\". A name must match one Agoda place exactly; \"Name, City\" or \"Name, country code\" picks between places of one name. A property's name reads that property. A name Agoda does not offer exactly gets a free row with the candidates.", "items": { "type": "string" } }, "startUrls": { "title": "Agoda links", "type": "array", "description": "Agoda search links (www.agoda.com/search?city=..., area, poi, region or toparea, with their dates, guests, currency, filters and sort) and property links (www.agoda.com//hotel/.html). A setting you give below replaces the link's own value of that setting.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "cityIds": { "title": "Agoda city ids", "type": "array", "description": "Agoda city ids (the number after city= in an Agoda search link, for example 9395 for Bangkok).", "items": { "type": "string" } }, "propertyIds": { "title": "Agoda property ids", "type": "array", "description": "Agoda property (hotel or home) ids, for example 1105091. Each is read for your stay; an id Agoda does not know gets a free not_found row.", "items": { "type": "string" } }, "mapAreas": { "title": "Map areas", "type": "array", "description": "Circles {\"latitude\": 13.74, \"longitude\": 100.56, \"radiusKm\": 3} (0.1 to 50 km) or boxes {\"north\": 13.76, \"south\": 13.72, \"east\": 100.58, \"west\": 100.53} (at most 1 degree by 1.5 degrees). Every property is checked to lie inside." }, "placeSuggestionsOnly": { "title": "Place suggestions only", "type": "boolean", "description": "Deliver Agoda's place suggestions for each name in \"search\" (cities, areas, landmarks, regions and properties with their ids) as free rows, and search nothing. Only the run's start fee is charged." }, "checkIn": { "title": "Check-in date", "type": "string", "description": "Check-in date, YYYY-MM-DD. Give it with \"checkOut\", or use the relative dates below instead." }, "checkOut": { "title": "Check-out date", "type": "string", "description": "Check-out date, YYYY-MM-DD, at most 30 nights after check-in." }, "checkInDaysFromToday": { "title": "Check-in in N days", "minimum": 0, "maximum": 480, "type": "integer", "description": "Check-in this many days after the run's day (UTC), so a scheduled run always searches ahead. Default 14." }, "nights": { "title": "Nights", "minimum": 1, "maximum": 30, "type": "integer", "description": "Nights of the stay with relative dates. Default 2." }, "checkInWindowDays": { "title": "Check-in window (days)", "minimum": 1, "maximum": 60, "type": "integer", "description": "Read every check-in day of a window starting at the check-in date, each as its own stay of the same nights (nightly or date by date prices). Each property and stay is its own row; a free stay dates row per property then lists the check-ins it is available and sold out on, the cheapest, and its price range." }, "checkInWindowStepDays": { "title": "Window step (days)", "minimum": 1, "maximum": 30, "type": "integer", "description": "With a check-in window, read every Nth day only (for example 7 for one check-in a week). Default 1." }, "adults": { "title": "Adults", "minimum": 1, "maximum": 36, "type": "integer", "description": "Adults in all rooms. Default 2." }, "rooms": { "title": "Rooms", "minimum": 1, "maximum": 9, "type": "integer", "description": "Rooms. Default 1. At most one room per adult." }, "childrenAges": { "title": "Children's ages", "type": "array", "description": "One age (0 to 17) per child, for example [4, 9]. Prices and availability are for this party." }, "currency": { "title": "Currency", "type": "string", "description": "Three letter currency code for every price, for example USD, EUR, THB, JPY or SGD. Default USD." }, "language": { "title": "Language", "enum": [ "en-us", "fr-fr", "de-de", "it-it", "es-es", "ja-jp", "zh-hk", "zh-cn", "ko-kr", "el-gr", "ru-ru", "pt-pt", "nl-nl", "en-gb", "zh-tw", "th-th", "ms-my", "vi-vn", "sv-se", "id-id", "pl-pl", "nb-no", "da-dk", "fi-fi", "cs-cz", "tr-tr", "hu-hu", "he-il", "ar-ae", "pt-br", "uk-ua", "en-au", "ro-ro" ], "type": "string", "description": "Agoda site language for names and texts, for example en-us, en-gb, ja-jp, th-th or zh-cn. Default en-us." }, "priceMarket": { "title": "Price market (local prices)", "enum": [ "AU", "CN", "GB", "HK", "ID", "IN", "JP", "KR", "MY", "NZ", "PH", "SG", "TH", "TW", "VN", "AE", "DE", "FR", "CA" ], "type": "string", "description": "Agoda prices by the visitor's country. Empty: prices as Agoda shows them to a US visitor. A country reads search pages and room lists through Apify residential exits in that country, billed as Local market page per page that delivered a property." }, "hotelsOrHomes": { "title": "Hotels or homes", "enum": [ "hotels", "homes" ], "type": "string", "description": "Only hotels, or only homes. Empty: both." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Agoda accommodation types, for example hotel, apartment, resort, hostel, villa or ryokan.", "items": { "type": "string", "enum": [ "hotel", "apartment", "resort", "servicedApartment", "guesthouse", "bedAndBreakfast", "hostel", "villa", "resortVilla", "entireHouse", "entireBungalow", "ryokan", "motel", "capsuleHotel", "homestay", "inn", "lodge", "chalet", "countryHouse", "farmStay", "holidayPark", "tent", "riad", "pension", "townhouse", "loft", "boat", "loveHotel" ], "enumTitles": [ "hotel", "apartment", "resort", "serviced apartment", "guesthouse", "bed and breakfast", "hostel", "villa", "resort villa", "entire house", "entire bungalow", "ryokan", "motel", "capsule hotel", "homestay", "inn", "lodge", "chalet", "country house", "farm stay", "holiday park", "tent", "riad", "pension", "townhouse", "loft", "boat", "love hotel" ] } }, "stars": { "title": "Stars", "type": "array", "description": "Star ratings to keep (a 4.5 star property counts as 4). \"unrated\" keeps properties without stars; then no star filter is sent and every row is checked.", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "unrated" ], "enumTitles": [ "1 star", "2 stars", "3 stars", "4 stars", "5 stars", "No star rating" ] } }, "agodaLuxeOnly": { "title": "Agoda Luxe only", "type": "boolean", "description": "Only properties of Agoda's luxury collection." }, "minReviewScore": { "title": "Minimum guest score", "type": "string", "description": "Lowest guest score from 1 to 10, one decimal at most, for example 8 or 8.5." }, "maxReviewScore": { "title": "Maximum guest score", "type": "string", "description": "Highest guest score from 1 to 10, one decimal at most, for example 6 or 7.5. Checked on every row (Agoda's own filter has no upper bound): rows above it, and properties without a score, are skipped free." }, "minReviewCount": { "title": "Minimum number of reviews", "minimum": 1, "type": "integer", "description": "Lowest number of reviews (checked on every row)." }, "minPrice": { "title": "Minimum price per night", "minimum": 0, "type": "number", "description": "Lowest price per room per night with taxes and fees, in the run's currency. Checked exactly on every row." }, "maxPrice": { "title": "Maximum price per night", "minimum": 1, "type": "number", "description": "Highest price per room per night with taxes and fees, in the run's currency. Checked exactly on every row." }, "freeCancellation": { "title": "Free cancellation", "type": "boolean", "description": "Only properties whose shown rate can be cancelled for free." }, "payLater": { "title": "Book now, pay later", "type": "boolean", "description": "Only properties whose shown rate can be paid later." }, "payAtHotel": { "title": "Pay at the property", "type": "boolean", "description": "Only properties whose shown rate is paid at the property." }, "bookWithoutCreditCard": { "title": "Book without a credit card", "type": "boolean", "description": "Only properties bookable without a credit card." }, "breakfastIncluded": { "title": "Breakfast included", "type": "boolean", "description": "Only properties whose shown rate includes breakfast." }, "kidsStayFree": { "title": "Kids stay free", "type": "boolean", "description": "Only properties where children stay free." }, "facilities": { "title": "Facilities", "type": "array", "description": "Property facilities, for example swimming pool, gym, spa, car park or pets allowed (all must be offered; sent as Agoda's filter).", "items": { "type": "string", "enum": [ "swimmingPool", "internet", "carPark", "airportTransfer", "gym", "frontDesk24h", "familyFriendly", "nonSmoking", "spa", "restaurants", "smokingArea", "petsAllowed", "businessFacilities", "nightclub", "golfCourse", "disabledFacilities" ], "enumTitles": [ "swimming pool", "internet", "car park", "airport transfer", "gym", "front desk24h", "family friendly", "non smoking", "spa", "restaurants", "smoking area", "pets allowed", "business facilities", "nightclub", "golf course", "disabled facilities" ] } }, "roomAmenities": { "title": "Room amenities", "type": "array", "description": "Room amenities, for example kitchen, balcony, private pool or washing machine (sent as Agoda's filter).", "items": { "type": "string", "enum": [ "airConditioning", "internetAccess", "ironing", "tv", "bathtub", "kitchen", "balcony", "coffeeTeaMaker", "privatePool", "refrigerator", "washingMachine", "heating", "petsAllowedInRoom" ], "enumTitles": [ "air conditioning", "internet access", "ironing", "TV", "bathtub", "kitchen", "balcony", "coffee tea maker", "private pool", "refrigerator", "washing machine", "heating", "pets allowed in room" ] } }, "roomBenefits": { "title": "Rate benefits", "type": "array", "description": "Rate benefits, for example breakfast, dinner, airport transfer or late check out (sent as Agoda's filter).", "items": { "type": "string", "enum": [ "breakfast", "lunch", "dinner", "airportTransfer", "lateCheckOut", "earlyCheckIn", "freeShuttle", "freeSauna", "halal", "vegetarian", "vegan", "glutenFree", "kidsMenu" ], "enumTitles": [ "breakfast", "lunch", "dinner", "airport transfer", "late check out", "early check in", "free shuttle", "free sauna", "halal", "vegetarian", "vegan", "gluten free", "kids menu" ] } }, "bedTypes": { "title": "Bed types", "type": "array", "description": "Bed types: single or twin, double, queen, king or bunk.", "items": { "type": "string", "enum": [ "singleOrTwin", "double", "queen", "king", "bunk" ], "enumTitles": [ "single or twin", "double", "queen", "king", "bunk" ] } }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "Homes with at least this many bedrooms." }, "minBathrooms": { "title": "Minimum bathrooms", "minimum": 1, "maximum": 10, "type": "integer", "description": "At least this many bathrooms." }, "minBeds": { "title": "Minimum beds", "minimum": 1, "maximum": 10, "type": "integer", "description": "At least this many beds." }, "maxDistanceFromCenterKm": { "title": "Maximum distance from the centre (km)", "minimum": 0, "maximum": 10, "type": "number", "description": "Only properties at most this far from the city centre Agoda draws (0 keeps those inside it). Checked on every row." }, "nameContains": { "title": "Name contains", "type": "string", "description": "Only properties whose name contains these words (Agoda's name filter, checked on every row)." }, "agodaFilters": { "title": "More Agoda filters", "type": "array", "description": "Agoda filters by id, \"Key:id,id\": HotelAreaId (an area of the city), HotelChainId (a chain or brand), LandmarkIds, TripPurpose, AffordableCategory or AtmosphereIds. The ids are in a search row's filter counts (turn on \"includeFilterCounts\").", "items": { "type": "string" } }, "excludePropertyIds": { "title": "Leave out these properties", "type": "array", "description": "Agoda property ids a search should not deliver, for example the ones you already hold. Skipped free; lookups by id or link are not affected.", "items": { "type": "string" } }, "includeSoldOut": { "title": "Include sold out properties", "type": "boolean", "description": "Also deliver properties Agoda shows sold out for the stay (no price), billed as Property. Off: they are skipped free." }, "sortBy": { "title": "Sort by", "enum": [ "bestMatch", "lowestPrice", "highestPrice", "topReviewed", "topReviewedByBusiness", "topReviewedByCouples", "topReviewedBySolo", "topReviewedByFamiliesYoungChildren", "topReviewedByFamiliesTeens", "topReviewedByGroups", "mostReviewed", "starsHighToLow", "starsLowToHigh", "closestToCenter", "closestToLandmark", "secretDeals", "insiderDeals" ], "type": "string", "description": "Agoda's order of the results. Default best match. Every row says its place in this order; rows a later walk found carry the order it used." }, "sortLandmarkId": { "title": "Landmark id for distance sort", "minimum": 1, "type": "integer", "description": "The Agoda landmark id \"closest to landmark\" sorts by (from a place suggestion or a search link's poi=)." }, "maxItems": { "title": "Maximum properties per run", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Most properties to deliver in the run, all searches and lookups together. Empty: no run cap." }, "maxItemsPerSearch": { "title": "Maximum properties per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Most properties per search and stay. Default 1,000. Above it, a search is read in further orders until Agoda's list stops growing, which reads the whole city (Bangkok about 6,700)." }, "includeDetails": { "title": "Property details", "type": "boolean", "description": "Add every room and offer for the stay (price, stay total with taxes, cancellation terms, payment, breakfast, benefits, rooms left, size, beds, photos), the exact rates per night with and without taxes, the description, facilities, policies, check in and out times, review grades, nearby places and photos. Billed as Property details per property read in full." }, "maxPropertiesWithDetails": { "title": "Maximum properties with details", "minimum": 1, "type": "integer", "description": "Read details for the first N properties of the run only." }, "includePriceTrend": { "title": "Price trend (free)", "type": "boolean", "description": "Add Agoda's date picker price trend of each property: a price and a trend word (Low, Normal, High) per check-in day for up to 60 days ahead, where Agoda keeps one (many properties have none). One extra request per property, free." }, "includeReviews": { "title": "Guest reviews", "type": "boolean", "description": "Add the guest reviews of each delivered property (Agoda's own, and the Booking.com and Priceline reviews Agoda shows), each billed as Review." }, "maxReviewsPerProperty": { "title": "Maximum reviews per property", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Most reviews per property. Default 20." }, "reviewsSort": { "title": "Review order", "enum": [ "newest", "highestScore", "lowestScore", "mostHelpful" ], "type": "string", "description": "Order of the reviews. Default newest first." }, "reviewsSources": { "title": "Review sources", "type": "array", "description": "Only reviews from these sources. Empty: all.", "items": { "type": "string", "enum": [ "agoda", "bookingCom", "priceline", "japanican", "other" ], "enumTitles": [ "Agoda", "Booking.com", "Priceline", "Japanican", "Other" ] } }, "reviewsLanguages": { "title": "Review languages", "type": "array", "description": "Only reviews written in these languages, for example en, ja, ko or zh-tw.", "items": { "type": "string", "enum": [ "en", "en-gb", "en-au", "en-ca", "en-in", "en-nz", "en-sg", "en-za", "fr", "de", "it", "es", "ja", "zh-hk", "zh-cn", "ko", "el", "ru", "pt", "nl", "zh-tw", "th", "ms", "vi", "sv", "id", "pl", "nb", "da", "fi", "cs", "tr", "ca", "hu", "bg", "ro", "sl", "he", "ar", "pt-br", "lt", "lv", "hr", "et", "uk" ] } }, "reviewsTravellerType": { "title": "Traveller type", "enum": [ "business", "couples", "solo", "familiesYoungChildren", "familiesTeens", "groups" ], "type": "string", "description": "Only reviews by this kind of traveller." }, "reviewsRatings": { "title": "Review score bands", "type": "array", "description": "Only reviews in these score bands.", "items": { "type": "string", "enum": [ "exceptional", "excellent", "veryGood", "good", "belowExpectation" ], "enumTitles": [ "Exceptional (9+)", "Excellent (8 to 9)", "Very good (7 to 8)", "Good (6 to 7)", "Below expectation (under 6)" ] } }, "reviewerCountries": { "title": "Reviewer countries", "type": "array", "description": "Only reviews by reviewers from these countries: a two letter code (JP, SG) or the English name (Japan).", "items": { "type": "string" } }, "reviewsFrom": { "title": "Reviews from", "type": "string", "description": "Only reviews written on or after this date (needs the newest first order)." }, "reviewsTo": { "title": "Reviews until", "type": "string", "description": "Only reviews written on or before this date." }, "includePersonalData": { "title": "Include personal data", "type": "boolean", "description": "All public data is always delivered, so this setting has no effect (it is kept so saved inputs keep working)." }, "includeFilterCounts": { "title": "Include filter counts", "type": "boolean", "description": "Add Agoda's own filter counts (areas, types, stars, facilities, chains and their ids) to each search row (free)." }, "includeRaw": { "title": "Include the raw Agoda object", "type": "boolean", "description": "Add Agoda's whole search answer for each property as \"raw\"." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxy is used and included in the price; give your own proxy links only if you need them." } } }, "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 } } } } } } } } } }