# Real-Time Short-Term Rental & Hospitality Yield API (`riad_h/real-time-short-term-rental-hospitality-yield-api`) Actor

Scrape real-time pricing, occupancy rates, and amenities for Airbnb, VRBO, and Booking.com properties in any geo-radius.

- **URL**: https://apify.com/riad\_h/real-time-short-term-rental-hospitality-yield-api.md
- **Developed by:** [Riad Hossain](https://apify.com/riad_h) (community)
- **Categories:**
- **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks
- **User rating**: No ratings yet

## Pricing

from $0.01 / 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.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#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

## Real-Time Short-Term Rental & Hospitality Yield API

> Scrape real-time pricing, occupancy rates, and amenities for Airbnb, VRBO, and Booking.com properties in any geo-radius. Built for property managers, real estate investors, and dynamic pricing engines.

### 🎯 What It Does

This Actor searches short-term rental platforms by geographic coordinates and returns structured listing data with:

- **Real-time pricing** — nightly rates, cleaning fees, service fees, weekly/monthly discounts
- **Occupancy analysis** — 30/60/90-day availability windows
- **Yield calculation** — estimated monthly revenue, average occupancy, top neighborhoods
- **Review sentiment** — positive/negative keywords, common complaints, sentiment score
- **Host data** — superhost status, response rate, response time
- **Price drop detection** — identify listings dropping prices by >20%

### 📥 Input

| Field | Type | Required | Default | Description |
|---|---|---|---|---|
| `lat` | number | ✅ | — | Center latitude |
| `lng` | number | ✅ | — | Center longitude |
| `radius_km` | integer | ❌ | `10` | Search radius in km (max 50) |
| `platform` | string | ❌ | `"airbnb"` | `airbnb`, `vrbo`, `booking.com`, or `all` |
| `checkin` | string | ❌ | today+7 | Check-in date (YYYY-MM-DD) |
| `nights` | integer | ❌ | `1` | Length of stay |
| `guests` | integer | ❌ | `2` | Number of adults |
| `max_results` | integer | ❌ | `50` | Max listings per platform (max 500) |
| `include_reviews` | boolean | ❌ | `false` | Analyze review sentiment |
| `include_host_data` | boolean | ❌ | `false` | Fetch host data |
| `price_drop_threshold` | integer | ❌ | `20` | Price drop detection threshold (%) |

#### Example Input

```json
{
  "lat": 29.7628,
  "lng": -95.3630,
  "radius_km": 10,
  "platform": "airbnb",
  "max_results": 50,
  "nights": 1,
  "guests": 2,
  "include_reviews": true
}
```

### 📤 Output

Each listing is pushed to the dataset as a structured `RentalListing` object. A yield analysis summary is stored in the Key-Value Store under the key `YIELD_ANALYSIS`.

#### Sample Listing

```json
{
  "platform": "airbnb",
  "listing_id": "32073378",
  "title": "Beautiful Downtown Loft",
  "property_type": "Apartment",
  "nightly_price": 120,
  "currency": "USD",
  "cleaning_fee": 45,
  "rating": 4.85,
  "review_count": 234,
  "superhost": true,
  "instant_bookable": true,
  "location": {
    "lat": 29.76,
    "lng": -95.36,
    "city": "Houston",
    "neighborhood": "Downtown"
  },
  "availability": {
    "available_days_30": 12,
    "available_days_60": 25,
    "available_days_90": 40
  }
}
```

#### Yield Analysis (Key-Value Store)

```json
{
  "total_listings": 50,
  "average_nightly_price": 145.50,
  "median_nightly_price": 120,
  "average_occupancy_rate_30d": 58.0,
  "estimated_monthly_revenue": 2528,
  "superhost_percentage": 35.0,
  "top_neighborhoods": [
    { "name": "Downtown", "listing_count": 15, "average_price": 165, "estimated_revenue": 2870 },
    { "name": "Midtown", "listing_count": 12, "average_price": 140, "estimated_revenue": 2436 }
  ]
}
```

### 💡 Use Cases

1. **Real Estate Investment** — Calculate ROI before purchasing a property
2. **Dynamic Pricing** — Set optimal nightly rates based on competitor data
3. **Market Research** — Analyze neighborhood-level rental performance
4. **Competitor Analysis** — Track pricing changes of competing properties
5. **Revenue Optimization** — Identify underpriced or overpriced listings

### 🔧 Technical Details

- **Runtime:** Node.js 20 + Playwright + TypeScript
- **Browser:** Stealth Chromium with anti-bot evasion scripts
- **Scraping method:** Network interception (GraphQL) + DOM fallback parsing
- **Platforms:** Airbnb (primary), VRBO, Booking.com
- **Concurrency:** Sequential per platform (avoids rate limiting)

### 📊 Pay-Per-Event Pricing

| Event | Price | Charged when |
|---|---|---|
| `listing-scraped` | $0.02 | For every listing returned |
| `listing-enriched` | $0.01 | When reviews or host data are extracted |

### License

MIT

# Actor input Schema

## `lat` (type: `number`):

Center latitude for the geo-radius search (e.g. 29.7628 for Houston).

## `lng` (type: `number`):

Center longitude (e.g. -95.3630 for Houston).

## `radius_km` (type: `integer`):

Search radius in kilometers around the center point. Default: 10. Max: 50.

## `platform` (type: `string`):

Which platform(s) to scrape. 'all' scrapes Airbnb + VRBO + Booking.com sequentially.

## `checkin` (type: `string`):

Check-in date in YYYY-MM-DD format. Default: today + 7 days.

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

Length of stay in nights. Default: 1.

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

Number of adults. Default: 2.

## `max_results` (type: `integer`):

Maximum number of listings to return per platform. Default: 50. Max: 500.

## `include_pricing_calendar` (type: `boolean`):

Fetch future pricing calendar (30/60/90 days). Slower but more comprehensive.

## `include_reviews` (type: `boolean`):

Analyze reviews for positive/negative keywords and complaints.

## `include_host_data` (type: `boolean`):

Fetch host response rate, response time, and superhost status.

## `price_drop_threshold` (type: `integer`):

Detect listings with price drops greater than this percentage. Default: 20%.

## `proxy_config` (type: `object`):

Optional proxy. Set use\_apify\_proxy=true to use Apify's residential pools.

## Actor input object example

```json
{
  "radius_km": 10,
  "platform": "airbnb",
  "checkin": "",
  "nights": 1,
  "guests": 2,
  "max_results": 50,
  "include_pricing_calendar": false,
  "include_reviews": false,
  "include_host_data": false,
  "price_drop_threshold": 20
}
```

# Actor output Schema

## `listings` (type: `string`):

View all scraped rental listings with pricing, ratings, and availability.

## `yield_analysis` (type: `string`):

Aggregated yield analysis including average prices, occupancy rates, and estimated revenue.

## `run_details` (type: `string`):

Full run metadata including input, output, and logs.

# 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 = {
    "radius_km": 10,
    "platform": "airbnb",
    "nights": 1,
    "guests": 2,
    "max_results": 50
};

// Run the Actor and wait for it to finish
const run = await client.actor("riad_h/real-time-short-term-rental-hospitality-yield-api").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 = {
    "radius_km": 10,
    "platform": "airbnb",
    "nights": 1,
    "guests": 2,
    "max_results": 50,
}

# Run the Actor and wait for it to finish
run = client.actor("riad_h/real-time-short-term-rental-hospitality-yield-api").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 '{
  "radius_km": 10,
  "platform": "airbnb",
  "nights": 1,
  "guests": 2,
  "max_results": 50
}' |
apify call riad_h/real-time-short-term-rental-hospitality-yield-api --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,riad_h/real-time-short-term-rental-hospitality-yield-api"
        }
    }
}

```

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/bwNufLiZI5yNbQK8T/builds/sWKAhy5ZzAsN61FWw/openapi.json