# HomeToGo Scraper (`crawlerbros/hometogo-scraper`) Actor

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.

- **URL**: https://apify.com/crawlerbros/hometogo-scraper.md
- **Developed by:** [Crawler Bros](https://apify.com/crawlerbros) (community)
- **Categories:** Travel, Real estate, Automation
- **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.00 / 1,000 results

This Actor is paid per event and usage. You are charged both the fixed price for specific events and for Apify platform usage.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event

## What's an Apify Actor?

Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.
Actors are written with capital "A".

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.
The best way to integrate Actors is as follows.

- **AI agents and MCP clients** — the [Apify MCP server](https://docs.apify.com/integrations/mcp.md) at `https://mcp.apify.com` (remote, streamable HTTP, OAuth on first use).
- **Agentic workflows and local Actor development** — [Agent Skills](https://apify.com/.well-known/agent-skills/index.json) with the [Apify CLI](https://docs.apify.com/cli/docs.md): `npm install -g apify-cli`, then `apify login`.
- **JavaScript/TypeScript projects** — the official [JS/TS client](https://docs.apify.com/api/client/js/docs.md): `npm install apify-client`.
- **Python projects** — the official [Python client](https://docs.apify.com/api/client/python/docs.md): `pip install apify-client`.
- **Any other language** — the [REST API](https://docs.apify.com/api/v2.md).

For usage examples, see the [API](#api) section below.

For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt).

# README

## HomeToGo Scraper

Scrape vacation rental listings from [HomeToGo](https://www.hometogo.com) — the world's largest vacation rental metasearch engine, aggregating millions of offers from Vrbo, Booking.com, Airbnb-style providers, and more. Search any destination and get prices, images, property type, size, amenities, geo-coordinates, and direct booking links. No auth, no cookies, no paid proxy required.

### What this actor does

- **Three modes:** `search` (destination text → offers), `searchByLocationId` (skip resolution, use a known ID directly), `autocomplete` (destination lookup only)
- **Global coverage:** any city, region, or landmark HomeToGo indexes worldwide
- **Rich filters:** dates, guest count, price range, property type, amenities, size, sort order
- **Real per-offer data:** actual amenities and prices as returned by HomeToGo for the requested search — no filler/placeholder listings included
- **Empty fields are omitted**

### Output per rental offer

- `offerId`, `rentalObjectId`
- `title`, `propertyType`, `propertyTypeLabel`, `sizeSqm`
- `priceDisplay`, `priceAmount`, `priceCurrency`, `priceType`
- `locationLabel`, `searchLocationId`
- `latitude`, `longitude`
- `images` (`thumbnail`/`small`/`medium`/`large`), `imageUrl`, `imageAltText`
- `amenities[]` — `{code, label}` pairs, e.g. `pool`, `internet`, `pets_allowed`
- `nearby` — `true` if HomeToGo tagged the offer as just outside the searched area
- `listingUrl`, `sourceUrl`, `bookingDeepLink`
- `checkInDate`, `nights`, `guests` — echoed back when supplied
- `recordType: "rental"`, `scrapedAt`

### Output per destination (mode=autocomplete)

- `locationId`, `name`, `fullTitle`, `trail`, `meta[]`
- `parentLocationId`, `destinationType`, `suggestionCategory`
- `recordType: "destination"`, `scrapedAt`

### Input

| Field | Type | Default | Description |
|---|---|---|---|
| `mode` | string | `search` | `search` / `searchByLocationId` / `autocomplete` |
| `locationQuery` | string | `Miami` | Free-text destination (mode=search, mode=autocomplete) |
| `locationId` | string | – | Known HomeToGo location ID (mode=searchByLocationId) |
| `checkInDate` | string | – | `YYYY-MM-DD` trip start date |
| `nights` | int | `7` | Length of stay (applied only if `checkInDate` set) |
| `guests` | int | – | Total guest count |
| `propertyType` | string | – | One of 17 accommodation types (condo, cabin, apartment, house, hotel, etc.) |
| `amenities` | array | `[]` | Require ALL selected amenities (WiFi, pool, pet-friendly, etc.) |
| `minPricePerNight` / `maxPricePerNight` | int | – | Price bounds, unit set by `priceType` |
| `priceType` | string | `totalPrice` | `totalPrice` / `perNight` |
| `minSizeSqm` / `maxSizeSqm` | int | – | Property size bounds (m²) |
| `sortBy` | string | `default` | `default` (most popular) / `best_value` |
| `includeNearby` | bool | `true` | Include offers HomeToGo tags as just outside the destination |
| `maxItems` | int | `50` | Hard cap (1–2000) |

#### Example: search a destination with dates and filters

```json
{
  "mode": "search",
  "locationQuery": "Miami",
  "checkInDate": "2026-09-10",
  "nights": 7,
  "guests": 4,
  "propertyType": "condo",
  "amenities": ["pool", "internet"],
  "maxItems": 100
}
```

#### Example: search by a known location ID

```json
{
  "mode": "searchByLocationId",
  "locationId": "5460aeb030147",
  "maxPricePerNight": 300,
  "priceType": "perNight"
}
```

#### Example: destination lookup

```json
{
  "mode": "autocomplete",
  "locationQuery": "Aspen"
}
```

### Use cases

- **Travel search / metasearch aggregators** — build a comparison feed of vacation rental prices across destinations
- **Market research** — track nightly rate ranges and property-type mix in a destination over time
- **Real estate / short-term-rental analytics** — benchmark amenities and pricing for comparable listings
- **Travel content** — power "best value stays in X" articles with real, current listings
- **Lead generation** — surface direct booking links for travel affiliate programs

### FAQ

**What is HomeToGo?** A vacation rental metasearch engine that aggregates millions of offers from providers like Vrbo, Booking.com, and TUI Villas into one searchable index, similar to how Kayak aggregates flights.

**How do I find a `locationId` for mode=searchByLocationId?** Run mode=`autocomplete` with your destination text first, or run mode=`search` once — the actor logs the resolved `locationId` for reuse in future runs.

**Why do some offers have no `sizeSqm`?** Not every listing publishes a floor area; the field is only included when HomeToGo returns it.

**What currency are prices in?** `priceCurrency` reflects whatever market HomeToGo serves for the request's origin (commonly USD for US-run actors). The `priceDisplay` field always shows the exact string HomeToGo returned, so you can always see the real currency symbol even if `priceCurrency` differs from what you expected.

**Why did I get fewer results than `maxItems`?** HomeToGo returns real listings for the applied filters only; if a destination + filter combination has few matching offers, the actor stops early rather than padding output with placeholder data.

**Does this scraper book reservations?** No — it's read-only. `listingUrl` and `bookingDeepLink` point to the live HomeToGo listing/checkout flow for humans to complete a booking themselves.

**Is nearby/expanded-radius data reliable?** Offers with `nearby: true` are ones HomeToGo itself flags as being outside the exact searched area but shown as an alternative. Set `includeNearby: false` to exclude them.

# Actor input Schema

## `mode` (type: `string`):

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).

## `locationQuery` (type: `string`):

Free-text destination — city, region, or landmark (e.g. "Miami", "Paris", "Aspen"). Resolved to a HomeToGo location ID via autocomplete.

## `locationId` (type: `string`):

A HomeToGo destination/location ID (e.g. `5460aeac36aa2`), or a full `/search/<id>` URL. Get one from mode=autocomplete or mode=search logs.

## `checkInDate` (type: `string`):

Trip start date, format YYYY-MM-DD. Leave empty to search availability-agnostic (shows all listed offers, dates unset).

## `nights` (type: `integer`):

Length of stay in nights. Only applied when Check-in date is set.

## `guests` (type: `integer`):

Total number of guests.

## `propertyType` (type: `string`):

Restrict results to a single accommodation type.

## `amenities` (type: `array`):

Only return offers that have ALL selected amenities.

## `minPricePerNight` (type: `integer`):

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` (type: `integer`):

Maximum price, same currency/unit rules as Min price.

## `priceType` (type: `string`):

Whether Min/Max price refer to a nightly rate or the total stay price.

## `minSizeSqm` (type: `integer`):

Minimum property size in square meters. Only applied to offers that expose a size (many listings omit it).

## `maxSizeSqm` (type: `integer`):

Maximum property size in square meters.

## `sortBy` (type: `string`):

Result ordering.

## `includeNearby` (type: `boolean`):

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.

## `maxItems` (type: `integer`):

Maximum number of records to return.

## Actor input object example

```json
{
  "mode": "search",
  "locationQuery": "Miami",
  "nights": 7,
  "amenities": [],
  "priceType": "totalPrice",
  "sortBy": "default",
  "includeNearby": true,
  "maxItems": 50
}
```

# Actor output Schema

## `rentals` (type: `string`):

Dataset containing all scraped HomeToGo rental offers / destinations.

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "mode": "search",
    "locationQuery": "Miami",
    "nights": 7,
    "amenities": [],
    "priceType": "totalPrice",
    "sortBy": "default",
    "includeNearby": true,
    "maxItems": 50
};

// Run the Actor and wait for it to finish
const run = await client.actor("crawlerbros/hometogo-scraper").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "mode": "search",
    "locationQuery": "Miami",
    "nights": 7,
    "amenities": [],
    "priceType": "totalPrice",
    "sortBy": "default",
    "includeNearby": True,
    "maxItems": 50,
}

# Run the Actor and wait for it to finish
run = client.actor("crawlerbros/hometogo-scraper").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "mode": "search",
  "locationQuery": "Miami",
  "nights": 7,
  "amenities": [],
  "priceType": "totalPrice",
  "sortBy": "default",
  "includeNearby": true,
  "maxItems": 50
}' |
apify call crawlerbros/hometogo-scraper --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,crawlerbros/hometogo-scraper"
        }
    }
}

```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/ScLJELkLjRpvUnZG4/builds/KGHH4PrAf9qedVlSP/openapi.json