{
"openapi": "3.0.1",
"info": {
"title": "Hotels.com Scraper",
"description": "Scrape Hotels.com rates and compare them with Expedia, Booking.com, Agoda and other booking sites for any city and dates. Get hotel prices, star class, ratings, reviews, amenities, address, phone and GPS.",
"version": "1.0",
"x-build-id": "fBQXdSm3UmvJa7AmP"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/parsebird~hotels-com-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-parsebird-hotels-com-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/parsebird~hotels-com-scraper/runs": {
"post": {
"operationId": "runs-sync-parsebird-hotels-com-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/parsebird~hotels-com-scraper/run-sync": {
"post": {
"operationId": "run-sync-parsebird-hotels-com-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": {
"location": {
"title": "Location",
"type": "string",
"description": "Enter a city, neighborhood, landmark or hotel name, as you would type it into a hotel search box (for example Paris, Las Vegas Strip or Hotel Arts Barcelona)."
},
"propertyTokens": {
"title": "Property tokens",
"type": "array",
"description": "Look up exact hotels by the propertyToken value from an earlier run (Google Hotels property links also work). Each hotel is returned with its Hotels.com rate and competitor prices. Leave empty to search by location only.",
"items": {
"type": "string"
}
},
"maxResults": {
"title": "Max hotels",
"minimum": 1,
"maximum": 5000,
"type": "integer",
"description": "Maximum number of hotels to save from the location search. Results come in pages of about 20 hotels.",
"default": 20
},
"enrichDetails": {
"title": "Add Hotels.com rate and competitor prices",
"type": "boolean",
"description": "Open each hotel's page to add the Hotels.com nightly rate, prices from every other booking site, room rates, full address, typical price range, the full amenity list and third-party review scores. Charged as an extra event per hotel.",
"default": false
},
"checkInDate": {
"title": "Check-in date",
"type": "string",
"description": "Leave empty to use a 2-night stay starting 30 days from today. Stays can be up to 30 nights."
},
"checkOutDate": {
"title": "Check-out date",
"type": "string",
"description": "Leave empty for a 2-night stay after the check-in date."
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 12,
"type": "integer",
"description": "Number of adult guests.",
"default": 2
},
"children": {
"title": "Children",
"minimum": 0,
"maximum": 11,
"type": "integer",
"description": "Number of children. Add their ages below for accurate prices; children without an age are counted as 10 years old.",
"default": 0
},
"childrenAges": {
"title": "Children ages",
"type": "array",
"description": "Age of each child (1 to 17), one per line.",
"items": {
"type": "string"
}
},
"currency": {
"title": "Currency",
"enum": [
"USD",
"EUR",
"GBP",
"ALL",
"DZD",
"ARS",
"AMD",
"AWG",
"AUD",
"AZN",
"BSD",
"BHD",
"BYN",
"BMD",
"BAM",
"BRL",
"BGN",
"XPF",
"CAD",
"CLP",
"CNY",
"COP",
"CRC",
"HRK",
"CUP",
"CZK",
"DKK",
"DOP",
"EGP",
"GEL",
"HKD",
"HUF",
"ISK",
"INR",
"IDR",
"IRR",
"ILS",
"JMD",
"JPY",
"JOD",
"KZT",
"KWD",
"LBP",
"MKD",
"MYR",
"MXN",
"MDL",
"MAD",
"TWD",
"NZD",
"NOK",
"OMR",
"PKR",
"PAB",
"PEN",
"PHP",
"PLN",
"QAR",
"RON",
"RUB",
"SAR",
"RSD",
"SGD",
"ZAR",
"KRW",
"SEK",
"CHF",
"THB",
"TRY",
"UAH",
"AED",
"VND"
],
"type": "string",
"description": "Currency for all prices.",
"default": "USD"
},
"sortBy": {
"title": "Sort by",
"enum": [
"Relevance",
"Lowest price",
"Highest rating",
"Most reviewed"
],
"type": "string",
"description": "Order of the search results.",
"default": "Relevance"
},
"minPrice": {
"title": "Min price per night",
"minimum": 0,
"type": "integer",
"description": "Only show hotels from this nightly price, in the selected currency."
},
"maxPrice": {
"title": "Max price per night",
"minimum": 0,
"type": "integer",
"description": "Only show hotels up to this nightly price, in the selected currency."
},
"minRating": {
"title": "Guest rating",
"enum": [
"3.5",
"4.0",
"4.5"
],
"type": "string",
"description": "Only show hotels with at least this guest rating (out of 5)."
},
"hotelClasses": {
"title": "Hotel class",
"type": "array",
"description": "Only show hotels with these star classes. Leave empty for all.",
"items": {
"type": "string",
"enum": [
"2",
"3",
"4",
"5"
],
"enumTitles": [
"2-star",
"3-star",
"4-star",
"5-star"
]
}
},
"freeCancellation": {
"title": "Free cancellation only",
"type": "boolean",
"description": "Only show hotels that offer a free-cancellation rate for your dates.",
"default": false
},
"vacationRentals": {
"title": "Search vacation rentals",
"type": "boolean",
"description": "Search vacation rentals (apartments, houses, villas) instead of hotels. Hotel class and free-cancellation filters don't apply to rentals.",
"default": false
},
"countryCode": {
"title": "Country",
"type": "string",
"description": "Two-letter country code of the market to search from (for example us, gb, de). Booking sites and their local domains can differ by market.",
"default": "us"
},
"language": {
"title": "Language",
"type": "string",
"description": "Language code for text such as descriptions, amenities and review themes (for example en, fr, de).",
"default": "en"
}
}
},
"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
}
}
}
}
}
}
}
}
}
}