{
"openapi": "3.0.1",
"info": {
"title": "ScraperCompany Hotel Rates API (All-in-One)",
"description": "One Actor for every ScraperCompany travel endpoint: Google Hotels calendars, offers and search, Booking.com, Expedia, Hotels.com, Agoda, Tripadvisor, Vrbo, Hostelworld, Airbnb, official hotel sites, rate comparison and Google Flights. Pick an endpoint, send a JSON body.",
"version": "0.0",
"x-build-id": "N7d5h65M8R67apbVP"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/scrapercompany~scrapercompany-hotel-rates/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-scrapercompany-scrapercompany-hotel-rates",
"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~scrapercompany-hotel-rates/runs": {
"post": {
"operationId": "runs-sync-scrapercompany-scrapercompany-hotel-rates",
"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~scrapercompany-hotel-rates/run-sync": {
"post": {
"operationId": "run-sync-scrapercompany-scrapercompany-hotel-rates",
"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": {
"endpoint": {
"title": "Endpoint",
"enum": [
"/v1/search",
"/v1/calendar",
"/v1/serp/google_hotels_calendar",
"/v1/stay",
"/v1/offers",
"/v1/rooms",
"/v1/serp/google_hotels_property",
"/v1/hotels/search",
"/v1/serp/google_hotels",
"/v1/hotels/property",
"/v1/hotels/resolve",
"/v1/hotels/reviews",
"/v1/official",
"/v1/ota/booking",
"/v1/ota/booking/rooms",
"/v1/ota/booking/search",
"/v1/ota/booking/reviews",
"/v1/ota/hotels",
"/v1/ota/hotels/rooms",
"/v1/ota/hotels/search",
"/v1/ota/hotels/reviews",
"/v1/ota/expedia",
"/v1/ota/expedia/search",
"/v1/ota/expedia/reviews",
"/v1/ota/agoda",
"/v1/ota/agoda/search",
"/v1/ota/tripadvisor",
"/v1/ota/tripadvisor/search",
"/v1/ota/tripadvisor/reviews",
"/v1/ota/vrbo",
"/v1/ota/vrbo/search",
"/v1/ota/hostelworld",
"/v1/ota/compare",
"/v1/serp/airbnb",
"/v1/airbnb/calendar",
"/v1/serp/airbnb_property_availability_calendar",
"/v1/serp/google_flights",
"/v1/serp/google_flights_return",
"/v1/serp/google_flights_booking",
"/v1/serp/google_flights_calendar",
"/v1/serp/google_flights_location_search"
],
"type": "string",
"description": "ScraperCompany API endpoint to call. The request body below uses that endpoint's field names, exactly as in the API reference.",
"default": "/v1/calendar"
},
"body": {
"title": "Request body",
"type": "object",
"description": "JSON body for the endpoint, e.g. {\"token\": \"ChUI...\", \"days\": 90} for the Google Hotels calendar. Date fields accept exact dates or relative ones such as \"30 days\" from today. Unknown fields are rejected by the API with a clear message.",
"default": {
"token": "ChUIoben2Mv6-CYaCi9tLzA3czVwbjQQAQ",
"days": 30,
"currency": "USD",
"market": "US"
}
},
"requests": {
"title": "Batch of requests (advanced)",
"type": "array",
"description": "Optional list of {\"endpoint\": \"...\", \"body\": {...}} objects, one request each, mixing any endpoints. When set, Endpoint and Request body above are ignored."
},
"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
}
}
}
}
}
}
}
}
}
}