API reference
Airbnb Stay Search API
Stays in a place for a trip: name, city, room type, rating and review count, position, the nightly price and the trip total as the site shows them, photos, instant booking and the host with their rating and years hosting. Pages by cursor.
Endpoint
/v1/airbnb/search-stayslive · proven11 creditsParameters
Query parameters
Useful optional inputs
limit— Bound the returned rows to what your task needs.A smaller limit does not necessarily reduce source calls or price; inspect the quote.
cursor— Continue the same source traversal with the complete returned cursor.Saved-result retrieval and a new source page can have different prices; quote the next call.
dry_run— Read a free estimate before fetching sources or scheduling paid work.Zero credits; cache status and availability are snapshots rather than guarantees.
| Name | Required | Description | Example |
|---|---|---|---|
location | no | A city, area or address; resolved to a place once and remembered (or pass place_id) | Lisbon |
place_id | no | A place id from airbnb/locations | |
checkin | no | Check-in date, YYYY-MM-DD (with checkout) | 2026-10-10 |
checkout | no | Check-out date, YYYY-MM-DD (with checkin) | 2026-10-14 |
adults | no | Adults, up to 16 | 2 |
children | no | Children, up to 15 | |
infants | no | Infants, up to 5 | |
pets | no | Pets, up to 5 | |
min_price | no | Minimum price per night in the currency | |
max_price | no | Maximum price per night in the currency | |
type_of_place | no | The site's type-of-place filter | |
property_type | no | The site's property-type filter | |
bedrooms | no | Minimum bedrooms | |
beds | no | Minimum beds | |
bathrooms | no | Minimum bathrooms | |
amenities | no | The site's amenity ids, separated by commas | |
booking_options | no | The site's booking-option filters | |
host_language | no | The site's host-language filter | |
top_tier | no | The site's top-tier-stays filter | |
total_price | no | Show the trip total instead of the nightly price | false |
limit | no | Results per page, 1 to 50 | 16 |
cursor | no | The cursor from the previous page | |
currency | no | Three-letter currency code | GBP |
language | no | Language code for the site's text | |
dry_run | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. | 1 |
Examples
Make the request
curl "https://www.monocrawl.com/v1/airbnb/search-stays" \ -H "x-api-key: mn_your_key_here"
TypeScript
const key = process.env.MONOCRAWL_API_KEY;
if (!key) throw new Error('Set MONOCRAWL_API_KEY on your server.');
const res = await fetch(
"https://www.monocrawl.com/v1/airbnb/search-stays",
{ headers: { "x-api-key": key } },
);
const body = await res.json();
if (!body.success) {
// one error shape for every endpoint — see /docs/errors
throw new Error(`${body.error.type}: ${body.error.message}`);
}
console.log(body.data, "credits left:", body.credits_remaining);Python
import os
import requests
res = requests.get(
"https://www.monocrawl.com/v1/airbnb/search-stays",
headers={"x-api-key": os.environ["MONOCRAWL_API_KEY"]},
timeout=60,
)
body = res.json()
if not body["success"]:
# one error shape for every endpoint — see /docs/errors
raise RuntimeError(f"{body['error']['type']}: {body['error']['message']}")
print(body["data"], "credits left:", body["credits_remaining"])Response
Response fields and example
This example is illustrative, not a captured live response. Variable-cost operations may settle a charge different from the list price below. A successful response puts the platform payload in data and reports the exact credits used, remaining balance, request id and cache status beside it.
{
"success": true,
"platform": "airbnb",
"endpoint": "/v1/airbnb/search-stays",
"data": {
"count": 0,
"cursor": null,
"dropped": 0,
"has_more": false,
"items": [
{
"badges": [
"example"
],
"city": "example",
"id": "example",
"image_url": "https://example.com/example",
"images": [
"example"
],
"latitude": 0,
"longitude": 0,
"name": "example",
"notes": [
"example"
],
"platform": "example",
"price": {
"accessibility_label": "example",
"amount": 0,
"label": "example",
"original_amount": 0,
"original_label": "example",
"qualifier": "example"
},
"price_breakdown": [
{}
],
"rating": 0,
"reviews": 0,
"subtitle": "example",
"title": "example",
"type": "example",
"url": "https://example.com/example"
}
],
"place": {
"id": "example",
"name": "example"
}
},
"credits_used": 11,
"credits_remaining": 99,
"request_id": "req_…",
"cached": false
}The example is illustrative and shows a documented subset of data. The fields below are optional across supported sources; nullable fields can also be absent. Preserve unknown values and accept additional fields.
Schema basis: observed response shapes, not an exhaustive field specification. See schema coverage and validation limits.
Download the data JSON Schema. Validate response.data, not the whole envelope. A valid shape does not establish that every field or source record was returned.
| Field inside data | Type | Meaning |
|---|---|---|
count | number | null | Number of records in this response, not lifetime or total matches. |
cursor | string | null | Opaque next-page token; pass it back unchanged. Null does not prove complete history. |
dropped | number | null | Optional dropped supplied by this operation. Null means unknown. |
has_more | boolean | null | Source continuation indicator; null means unknown. |
items | array | null | Returned records. Source coverage and completeness vary. |
items[].badges | array | null | Optional badges supplied by this operation. Null means unknown. |
items[].city | string | null | Optional city supplied by this operation. Null means unknown. |
items[].id | string | null | Source identifier. Preserve the supplied type and exact value. |
items[].image_url | string | null | Optional image url supplied by this operation. Null means unknown. |
items[].images | array | null | Optional images supplied by this operation. Null means unknown. |
items[].latitude | number | null | Optional latitude supplied by this operation. Null means unknown. |
items[].longitude | number | null | Optional longitude supplied by this operation. Null means unknown. |
items[].name | string | null | Optional name supplied by this operation. Null means unknown. |
items[].notes | array | null | Optional notes supplied by this operation. Null means unknown. |
items[].platform | string | null | Optional platform supplied by this operation. Null means unknown. |
items[].price | object | null | Source price. Currency, taxes and availability depend on the listing. |
items[].price.accessibility_label | string | null | Optional accessibility label supplied by this operation. Null means unknown. |
items[].price.amount | number | null | Optional amount supplied by this operation. Null means unknown. |
items[].price.label | string | null | Optional label supplied by this operation. Null means unknown. |
items[].price.original_amount | number | null | Optional original amount supplied by this operation. Null means unknown. |
items[].price.original_label | string | null | Optional original label supplied by this operation. Null means unknown. |
items[].price.qualifier | string | null | Optional qualifier supplied by this operation. Null means unknown. |
items[].price_breakdown | array | null | Optional price breakdown supplied by this operation. Null means unknown. |
items[].rating | number | null | Source rating; read its accompanying scale and vote count. |
items[].reviews | number | null | Optional reviews supplied by this operation. Null means unknown. |
items[].subtitle | string | null | Optional subtitle supplied by this operation. Null means unknown. |
items[].title | string | null | Source title when supplied. |
items[].type | string | null | Optional type supplied by this operation. Null means unknown. |
items[].url | string | null | Original source URL when supplied. |
place | object | null | Optional place supplied by this operation. Null means unknown. |
place.id | string | null | Source identifier. Preserve the supplied type and exact value. |
place.name | string | null | Optional name supplied by this operation. Null means unknown. |
Optional fields reviewed from preserved successful responses. Additive fields and source variations remain allowed; validate the fields your workflow requires.
The example is invented and illustrates types only; zero and empty values are not claims about a real result.
Failures use the typed error envelope. A confirmed uncharged or refunded failure reports zero; a pending reconciliation can report an unknown charge. Read credits_used and error.details.billing_status, and keep request_id for recovery. Response contract · Error reference