{
"openapi": "3.0.1",
"info": {
"title": "Hotels.com Rates Scraper",
"description": "Scrape Hotels.com hotel prices: the headline nightly and total price for a stay, every room type and rate plan, or a hotel's Hotels.com id by name. 11 country sites (US, UK, Canada, EU, Australia...). Batch many hotels. No proxies or API key needed.",
"version": "0.0",
"x-build-id": "nmisSjUhdMEuF1XPx"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapercompany~hotels-com-rates-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapercompany-hotels-com-rates-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/scrapercompany~hotels-com-rates-scraper/runs": {
"post": {
"operationId": "runs-sync-scrapercompany-hotels-com-rates-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/scrapercompany~hotels-com-rates-scraper/run-sync": {
"post": {
"operationId": "run-sync-scrapercompany-hotels-com-rates-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": {
"mode": {
"title": "Mode",
"enum": [
"rates",
"rooms",
"search"
],
"type": "string",
"description": "Headline price: the price Hotels.com shows for the stay. Rooms: every room type and rate plan. Find property id: look up the Hotels.com id for a hotel name.",
"default": "rates"
},
"propertyIds": {
"title": "Hotels.com property ids",
"type": "array",
"description": "Numeric Hotels.com ids, one request each: the digits after /h in hotels.com/h12570.Hotel-Information (not the legacy ho... number). Use Find property id mode if you only know the name.",
"default": [
"12570"
],
"items": {
"type": "string"
}
},
"check_in": {
"title": "Check-in",
"pattern": "^(\\d{4})-(0[1-9]|1[0-2])-(0[1-9]|[12]\\d|3[01])$|^(\\d+)\\s*(day|week|month|year)s?$",
"type": "string",
"description": "Exact (2026-12-01) or relative (30 days from today).",
"default": "30 days"
},
"nights": {
"title": "Nights",
"minimum": 1,
"maximum": 30,
"type": "integer",
"description": "Length of stay (1-30).",
"default": 1
},
"adults": {
"title": "Adults",
"minimum": 1,
"maximum": 8,
"type": "integer",
"description": "Adults in the room (1-8).",
"default": 2
},
"market": {
"title": "Market (point of sale)",
"enum": [
"AU",
"CA",
"DE",
"EU",
"FR",
"GB",
"IE",
"IT",
"NL",
"NZ",
"US"
],
"type": "string",
"description": "Hotels.com site to price on; it also sets the currency (US = USD, GB = GBP, CA = CAD, EU/DE/FR/IT/NL/IE = EUR, AU = AUD, NZ = NZD). Prices are not comparable across markets because the display basis differs.",
"default": "US"
},
"hotelNames": {
"title": "Hotel names (Find property id)",
"type": "array",
"description": "Hotel names to look up, one request each. Used only by the Find property id mode.",
"default": [
"Moxy Boston Downtown"
],
"items": {
"type": "string"
}
},
"city": {
"title": "City",
"type": "string",
"description": "City of the hotels you are looking up. Strongly recommended for chain hotels."
},
"limit": {
"title": "Candidates per name",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "Maximum candidates returned per name, best match first.",
"default": 5
},
"customRequests": {
"title": "Custom requests (advanced)",
"type": "array",
"description": "Optional list of JSON objects, one request each, using the API field names shown above. Each object is merged over the options above, so you only need to give what differs. Add \"mode\": \"rooms\" or \"mode\": \"search\" to use another mode for an object. Example: {\"property_id\":\"12570\",\"check_in\":\"2026-12-20\",\"nights\":2,\"market\":\"GB\"}"
},
"includeErrors": {
"title": "Include failed requests in the dataset",
"type": "boolean",
"description": "When on, a request that fails (for example an unknown property id) is saved as a dataset item with an error message so you can see what went wrong. Failed requests are never charged.",
"default": true
},
"maxConcurrency": {
"title": "Parallel requests",
"minimum": 1,
"maximum": 10,
"type": "integer",
"description": "How many API requests run at the same time.",
"default": 3
},
"maxRetries": {
"title": "Retries per request",
"minimum": 0,
"maximum": 5,
"type": "integer",
"description": "Retries for rate limits (HTTP 429), temporary server errors (5xx) and network errors, with exponential backoff. Validation errors are never retried.",
"default": 2
}
}
},
"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
}
}
}
}
}
}
}
}
}
}