{ "openapi": "3.0.1", "info": { "title": "HomeToGo Scraper", "description": "Scrape HomeToGo vacation rental listings by destination - prices, images, amenities, property type, geo-coordinates, and booking links from the world's largest vacation rental metasearch engine.", "version": "1.0", "x-build-id": "KGHH4PrAf9qedVlSP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~hometogo-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-hometogo-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/crawlerbros~hometogo-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-hometogo-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/crawlerbros~hometogo-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-hometogo-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "searchByLocationId", "autocomplete" ], "type": "string", "description": "What to fetch. `search` resolves a free-text destination (e.g. \"Miami\") and returns vacation rental offers. `searchByLocationId` skips resolution and searches a known HomeToGo location ID directly (faster, avoids ambiguity). `autocomplete` only returns matching destinations for a text query (useful for discovering location IDs).", "default": "search" }, "locationQuery": { "title": "Destination (mode=search, mode=autocomplete)", "type": "string", "description": "Free-text destination — city, region, or landmark (e.g. \"Miami\", \"Paris\", \"Aspen\"). Resolved to a HomeToGo location ID via autocomplete.", "default": "Miami" }, "locationId": { "title": "Location ID (mode=searchByLocationId)", "type": "string", "description": "A HomeToGo destination/location ID (e.g. `5460aeac36aa2`), or a full `/search/` URL. Get one from mode=autocomplete or mode=search logs." }, "checkInDate": { "title": "Check-in date", "type": "string", "description": "Trip start date, format YYYY-MM-DD. Leave empty to search availability-agnostic (shows all listed offers, dates unset)." }, "nights": { "title": "Number of nights", "minimum": 1, "maximum": 90, "type": "integer", "description": "Length of stay in nights. Only applied when Check-in date is set.", "default": 7 }, "guests": { "title": "Guests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Total number of guests." }, "propertyType": { "title": "Property type", "enum": [ "condo", "cabin", "lodge", "holiday_apartment", "holiday_house", "hotel", "bed_and_breakfast", "dedicated_room", "holiday_park", "pension", "castle", "farm", "other_accommodation", "boat", "hostel", "camping_suite", "shared_room" ], "type": "string", "description": "Restrict results to a single accommodation type." }, "amenities": { "title": "Required amenities", "type": "array", "description": "Only return offers that have ALL selected amenities.", "items": { "type": "string", "enum": [ "internet", "kitchen", "pool", "pets_allowed", "tv", "air_conditioning", "terrace", "garage", "microwave", "washing_machine_available", "fireplace", "smoking_not_allowed", "whirlpool", "smoking_allowed", "dishwasher", "garden", "no_dogs", "barbecue", "accessible", "fishing", "sauna", "cot", "fenced", "detached", "children_friendly", "coffee_machine", "hairdryer", "high_chair", "iron", "kettle", "pool_heated", "pool_private", "pool_shared", "spa", "toaster", "telephone" ], "enumTitles": [ "WiFi", "Kitchen", "Pool", "Pet-friendly", "TV", "Air conditioning", "Balcony/patio", "Parking", "Microwave", "Washing machine", "Fireplace", "No smoking", "Hot tub", "Smoking allowed", "Dishwasher", "Yard", "No pets", "Grill", "Wheelchair access", "Fishing", "Sauna", "Crib", "Fenced", "Detached", "Family-friendly", "Coffee machine", "Hairdryer", "High chair", "Iron", "Kettle", "Heated pool", "Private pool", "Shared pool", "Spa", "Toaster", "Telephone" ] }, "default": [] }, "minPricePerNight": { "title": "Min price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum price, in the currency HomeToGo serves for the request's origin market (see `priceCurrency` on output records). Applies per-night or total-stay depending on Price type below." }, "maxPricePerNight": { "title": "Max price", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum price, same currency/unit rules as Min price." }, "priceType": { "title": "Price type", "enum": [ "totalPrice", "perNight" ], "type": "string", "description": "Whether Min/Max price refer to a nightly rate or the total stay price.", "default": "totalPrice" }, "minSizeSqm": { "title": "Min size (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum property size in square meters. Only applied to offers that expose a size (many listings omit it)." }, "maxSizeSqm": { "title": "Max size (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum property size in square meters." }, "sortBy": { "title": "Sort by", "enum": [ "default", "best_value" ], "type": "string", "description": "Result ordering.", "default": "default" }, "includeNearby": { "title": "Include nearby offers", "type": "boolean", "description": "HomeToGo pads results with offers slightly outside the searched destination when the exact area has few listings. Disable to keep only offers HomeToGo tags as inside the destination.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of records to return.", "default": 50 } } }, "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 } } } } } } } } } }