API reference

Airbnb Stay API

One stay's page: name and headline, property type, location and position, capacity, rating and reviews, description, highlights, amenities by group, house rules, safety, cancellation policies, instant booking, the host with their tags and response figures, and the photos. Sections the page carried beyond this are named in _warnings.

Read as Markdown Use with an AI agent

Endpoint

GET/v1/airbnb/staylive · proven6 credits

Try in Playground

Parameters

Query parameters

Name	Required	Description	Example
`id`	yes	The listing number (or pass url, the stay's page)	`6332745`
`url`	no	The stay's page URL instead of an id
`checkin`	no	Check-in date, YYYY-MM-DD (with checkout), for dated pricing
`checkout`	no	Check-out date, YYYY-MM-DD (with checkin)
`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
`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.	`1`

Examples

Make the request

curl

curl "https://www.monocrawl.com/v1/airbnb/stay?id=6332745" \
  -H "x-api-key: mn_your_key_here"

TypeScript

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/stay?id=6332745",
  { 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

python

import os
import requests

res = requests.get(
    "https://www.monocrawl.com/v1/airbnb/stay?id=6332745",
    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.

200 · application/json

{
  "success": true,
  "platform": "airbnb",
  "endpoint": "/v1/airbnb/stay",
  "data": {
    "_warnings": [],
    "amenities": [
      {
        "group": "example",
        "items": [
          {}
        ]
      }
    ],
    "amenities_count": 0,
    "cancellation_policies": [
      {
        "id": "example",
        "name": "example",
        "summary": "example"
      }
    ],
    "category_ratings": [
      {
        "label": "example",
        "rating": 0,
        "share": 0
      }
    ],
    "description": "example",
    "details": [
      "example"
    ],
    "guests": 0,
    "headline": "example",
    "highlights": [
      {
        "subtitle": "example",
        "title": "example"
      }
    ],
    "house_rule_sections": [],
    "house_rules": [
      "example"
    ],
    "id": "example",
    "image_url": "https://example.com/example",
    "latitude": 0,
    "location": "example",
    "location_radius_m": 0,
    "longitude": 0,
    "name": "example",
    "photos": [
      {
        "caption": "example",
        "url": "https://example.com/example"
      }
    ],
    "platform": "example",
    "property_type": "example",
    "rating": 0,
    "rating_distribution": [],
    "reviews": 0,
    "reviews_note": "example",
    "safety": [
      "example"
    ],
    "type": "example",
    "url": "https://example.com/example"
  },
  "credits_used": 6,
  "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
`_warnings`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`amenities`	`array \| null`	Optional amenities supplied by this operation. Null means unknown.
`amenities[].group`	`string \| null`	Optional group supplied by this operation. Null means unknown.
`amenities[].items`	`array \| null`	Returned records. Source coverage and completeness vary.
`amenities_count`	`number \| null`	Optional amenities count supplied by this operation. Null means unknown.
`cancellation_policies`	`array \| null`	Optional cancellation policies supplied by this operation. Null means unknown.
`cancellation_policies[].id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`cancellation_policies[].name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`cancellation_policies[].summary`	`string \| null`	Optional summary supplied by this operation. Null means unknown.
`category_ratings`	`array \| null`	Optional category ratings supplied by this operation. Null means unknown.
`category_ratings[].label`	`string \| null`	Optional label supplied by this operation. Null means unknown.
`category_ratings[].rating`	`number \| null`	Source rating; read its accompanying scale and vote count.
`category_ratings[].share`	`number \| null`	Optional share supplied by this operation. Null means unknown.
`description`	`string \| null`	Source description; null or absent means not supplied.
`details`	`array \| null`	Optional details supplied by this operation. Null means unknown.
`guests`	`number \| null`	Optional guests supplied by this operation. Null means unknown.
`headline`	`string \| null`	Optional headline supplied by this operation. Null means unknown.
`highlights`	`array \| null`	Optional highlights supplied by this operation. Null means unknown.
`highlights[].subtitle`	`string \| null`	Optional subtitle supplied by this operation. Null means unknown.
`highlights[].title`	`string \| null`	Source title when supplied.
`house_rule_sections`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`house_rules`	`array \| null`	Optional house rules supplied by this operation. Null means unknown.
`id`	`string \| null`	Source identifier. Preserve the supplied type and exact value.
`image_url`	`string \| null`	Optional image url supplied by this operation. Null means unknown.
`latitude`	`number \| null`	Optional latitude supplied by this operation. Null means unknown.
`location`	`string \| null`	Optional location supplied by this operation. Null means unknown.
`location_radius_m`	`number \| null`	Optional location radius m supplied by this operation. Null means unknown.
`longitude`	`number \| null`	Optional longitude supplied by this operation. Null means unknown.
`name`	`string \| null`	Optional name supplied by this operation. Null means unknown.
`photos`	`array \| null`	Optional photos supplied by this operation. Null means unknown.
`photos[].caption`	`string \| null`	Optional caption supplied by this operation. Null means unknown.
`photos[].url`	`string \| null`	Original source URL when supplied.
`platform`	`string \| null`	Optional platform supplied by this operation. Null means unknown.
`property_type`	`string \| null`	Optional property type supplied by this operation. Null means unknown.
`rating`	`number \| null`	Source rating; read its accompanying scale and vote count.
`rating_distribution`	`array \| null`	Source array was empty in the reviewed captures; item fields remain unspecified.
`reviews`	`number \| null`	Optional reviews supplied by this operation. Null means unknown.
`reviews_note`	`string \| null`	Optional reviews note supplied by this operation. Null means unknown.
`safety`	`array \| null`	Optional safety supplied by this operation. Null means unknown.
`type`	`string \| null`	Optional type supplied by this operation. Null means unknown.
`url`	`string \| null`	Original source URL when supplied.

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

Airbnb Stay API

Query parameters

Make the request

Response fields and example

More Airbnb reference

First call in under a minute