One key, many sources
Use the same credential across supported operations and check capabilities for each source.
Collect supported source details for your saved dated stay through an opt-in beta workflow. Get structured JSON through one RealtyCrawl API key.
Use the stay_id from your account’s supported dated Booking.com, Trip.com or VRBO search. This opt-in beta makes one fresh source request using the retained source identity and dates. It does not verify bookability or create a booking quote. This operation requests source data through its enabled adapter. Preserve observation times, source warnings and any idempotent-replay metadata. Check live capabilities for accepted inputs and availability before running your request.
Collect supported source details for your saved dated stay through an opt-in beta workflow.
Example request
curl --request GET 'https://realtycrawl.dev/v1/stays/YOUR_STAY_ID/details' \
--header "x-api-key: $REALTYCRAWL_API_KEY" \
--header 'X-Max-Credits: 50'import os
import json
import requests
headers = {
"X-Max-Credits": "50"
}
headers["x-api-key"] = os.environ["REALTYCRAWL_API_KEY"]
response = requests.request("GET", "https://realtycrawl.dev/v1/stays/YOUR_STAY_ID/details",
headers=headers, timeout=60)
response.raise_for_status()
print(json.dumps(response.json(), indent=2))const response = await fetch("https://realtycrawl.dev/v1/stays/YOUR_STAY_ID/details", {
method: "GET",
headers: {
"x-api-key": process.env.REALTYCRAWL_API_KEY,
...{
"X-Max-Credits": "50"
}
}
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
console.log(await response.json());| Parameter | Required | Description |
|---|---|---|
| stay_id | Yes | stay_id |
| fields | No | Response-only comma-separated field paths relative to data items; up to 32 paths. Source requests and billing are unchanged. |
| format | No | Response-only export format. JSON retains the envelope; CSV/NDJSON contain data records, with request/credit metadata in headers. Errors stay JSON. |
Use the stay_id from your account’s supported dated Booking.com, Trip.com or VRBO search. This opt-in beta makes one fresh source request using the retained source identity and dates. It does not verify bookability or create a booking quote.
The response includes a fresh source accommodation observation in data, plus source outcomes and request metadata. Explore the structure below before making a call.
{
"data": {
"id": "YOUR_STAY_ID",
"source": {
"platform": "booking",
"provider": "example",
"country": "FR",
"native_id": "EXAMPLE_STAY_ID",
"observed_at": "2026-01-01T12:00:00Z",
"access_class": "public_portal"
},
"property": {
"id": null,
"address": {
"country": "FR"
},
"property_type": "unknown"
},
"accommodation_type": "unknown",
"extensions": {
"check_in": "2026-12-01",
"check_out": "2026-12-03",
"adults": 2,
"availability": "unknown",
"source_price": null,
"observation_kind": "stay_search_result",
"detail_observation": true,
"stay_sections": {
"media": [
{
"url": "https://cf.bstatic.com/xdata/images/hotel/max1280x900/789363433.jpg?k=e882cf6c17d7c9d95a47cffabf179ae2c41bb064bca4b11dc04bf2ea0e5e1cbc&o=",
"type": "photo",
"position": 0,
"caption": null,
"source": {
"platform": "booking",
"provider": "example",
"country": "FR",
"native_id": "EXAMPLE_STAY_ID",
"observed_at": "2026-01-01T12:00:00Z",
"access_class": "public_portal"
}
},
{
"url": "https://cf.bstatic.com/xdata/images/hotel/square600/789363433.webp?k=1662f41d5f14795b2963d6a9f2a01f1b99d01e110b6a02db41584c34075461bd&o=",
"type": "photo",
"position": 1,
"caption": null,
"source": {
"platform": "booking",
"provider": "example",
"country": "FR",
"native_id": "EXAMPLE_STAY_ID",
"observed_at": "2026-01-01T12:00:00Z",
"access_class": "public_portal"
}
}
],
"context": {
"description": null,
"amenities": null,
"source_policies": null,
"stay_id": "YOUR_STAY_ID",
"room": {
"bedrooms": 1,
"bathrooms": 1,
"beds": 2,
"kitchens": 1,
"living_rooms": 1,
"room_area": {
"value": 42,
"unit": "sqm",
"basis": "source_room_area"
},
"source_room_label": "Apartment"
},
"ratings": [
{
"kind": "source_star_classification",
"category": null,
"value": 4,
"scale": null,
"source": {
"platform": "booking",
"provider": "example",
"country": "FR",
"native_id": "EXAMPLE_STAY_ID",
"observed_at": "2026-01-01T12:00:00Z",
"access_class": "public_portal"
}
},
{
"kind": "source_category_score",
"category": "Location",
"value": 9.7,
"scale": null,
"source": {
"platform": "booking",
"provider": "example",
"country": "FR",
"native_id": "EXAMPLE_STAY_ID",
"observed_at": "2026-01-01T12:00:00Z",
"access_class": "public_portal"
}
}
],
"source_offer_observations": {
"free_cancellation": false,
"no_prepayment": false,
"breakfast_included": false,
"scope": "dated_search_offer_observation",
"bookable_offer_verified": false
},
"check_in": "2026-12-01",
"check_out": "2026-12-03",
"origin": "source_reported",
"completeness": "unknown",
"source": {
"platform": "booking",
"provider": "example",
"country": "FR",
"native_id": "EXAMPLE_STAY_ID",
"observed_at": "2026-01-01T12:00:00Z",
"access_class": "public_portal"
}
}
}
}
},
"meta": {
"request_id": "example_request",
"schema_version": "1.0.0",
"generated_at": "2026-01-01T12:00:00Z",
"completeness": "unknown",
"sources": []
}
}Schema example with placeholder values; not a live source result. Actual fields, values, and completeness vary by source and request.
Send a GET request with your API key and accepted inputs. RealtyCrawl returns structured JSON and preserves the source context for your application.
Method
GET
Response
JSON · CSV · NDJSON
GET /v1/stays/{stay_id}/detailsKeep source collection behind a shared interface so you can focus on the product you’re building.
Use familiar HTTP requests, inspect a common schema, and connect the results to the tools your team already uses.
Use the same credential across supported operations and check capabilities for each source.
Keep currencies, area units, source identifiers, and observation times with your results.
Call the API with cURL, Python, TypeScript, or any backend that can send an HTTP request.
import requests
# Check current source availability before collecting.
response = requests.get(
'https://realtycrawl.dev/v1/meta/capabilities',
params={'platform': 'zillow'}
)
response.raise_for_status()
capabilities = response.json()// Check current source availability before collecting.
const response = await fetch(
'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=zillow'import requests
# Check current source availability before collecting.
response = requests.get(
'https://realtycrawl.dev/v1/meta/capabilities',
params={'platform': 'redfin'}
)
response.raise_for_status()
capabilities = response.json()// Check current source availability before collecting.
const response = await fetch(
'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=redfin'import requests
# Check current source availability before collecting.
response = requests.get(
'https://realtycrawl.dev/v1/meta/capabilities',
params={'platform': 'realtor'}
)
response.raise_for_status()
capabilities = response.json()// Check current source availability before collecting.
const response = await fetch(
'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=realtor'import requests
# Check current source availability before collecting.
response = requests.get(
'https://realtycrawl.dev/v1/meta/capabilities',
params={'platform': 'rightmove'}
)
response.raise_for_status()
capabilities = response.json()// Check current source availability before collecting.
const response = await fetch(
'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=rightmove'import requests
# Check current source availability before collecting.
response = requests.get(
'https://realtycrawl.dev/v1/meta/capabilities',
params={'platform': 'idealista'}
)
response.raise_for_status()
capabilities = response.json()// Check current source availability before collecting.
const response = await fetch(
'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'
);
if (!response.ok) throw new Error('Request failed');
const capabilities = await response.json();curl 'https://realtycrawl.dev/v1/meta/capabilities?platform=idealista'{
"platform": "zillow",
"operation": "searchPlatformListings",
"status": "active",
"geographies": [
"US"
],
"execution": "sync"
}{
"platform": "redfin",
"operation": "searchPlatformListings",
"status": "active",
"geographies": [
"US"
],
"execution": "sync"
}{
"platform": "realtor",
"operation": "searchPlatformListings",
"status": "active",
"geographies": [
"US"
],
"execution": "sync"
}{
"platform": "rightmove",
"operation": "searchPlatformListings",
"status": "active",
"geographies": [
"GB"
],
"execution": "sync"
}{
"platform": "idealista",
"operation": "searchPlatformListings",
"status": "active",
"geographies": [
"ES"
],
"execution": "sync"
}Find answers to common questions about Booking.com Apartments requests, responses, and credits.
Contact usCreate an account for 500 trial credits, check live capabilities for Booking.com Apartments, and use the example request above with your API key. This operation lists 50 credits per successful call.
The JSON response contains a fresh source accommodation observation in data. The meta object carries request diagnostics and source outcomes. CSV/NDJSON exports contain data records with request and credit metadata in headers.
Use the stay_id from your account’s supported dated Booking.com, Trip.com or VRBO search. This opt-in beta makes one fresh source request using the retained source identity and dates. It does not verify bookability or create a booking quote.
Availability is operation-specific. Check /v1/meta/capabilities for the platform’s live status, accepted selectors, and markets. Unavailable requests are not charged.
RealtyCrawl is an independent real estate data API and is not affiliated with Booking.com Apartments.
Get your API key and start building a source-linked property workflow.
50 credits per successful call · Failed calls are refunded