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

GET/v1/airbnb/search-stayslive · proven11 credits
Try in Playground

Parameters

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.

NameRequiredDescriptionExample
locationnoA city, area or address; resolved to a place once and remembered (or pass place_id)Lisbon
place_idnoA place id from airbnb/locations
checkinnoCheck-in date, YYYY-MM-DD (with checkout)2026-10-10
checkoutnoCheck-out date, YYYY-MM-DD (with checkin)2026-10-14
adultsnoAdults, up to 162
childrennoChildren, up to 15
infantsnoInfants, up to 5
petsnoPets, up to 5
min_pricenoMinimum price per night in the currency
max_pricenoMaximum price per night in the currency
type_of_placenoThe site's type-of-place filter
property_typenoThe site's property-type filter
bedroomsnoMinimum bedrooms
bedsnoMinimum beds
bathroomsnoMinimum bathrooms
amenitiesnoThe site's amenity ids, separated by commas
booking_optionsnoThe site's booking-option filters
host_languagenoThe site's host-language filter
top_tiernoThe site's top-tier-stays filter
total_pricenoShow the trip total instead of the nightly pricefalse
limitnoResults per page, 1 to 5016
cursornoThe cursor from the previous page
currencynoThree-letter currency codeGBP
languagenoLanguage code for the site's text
dry_runnoRead 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
curl "https://www.monocrawl.com/v1/airbnb/search-stays" \
  -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/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
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.

200 · application/json
{
  "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 dataTypeMeaning
countnumber | nullNumber of records in this response, not lifetime or total matches.
cursorstring | nullOpaque next-page token; pass it back unchanged. Null does not prove complete history.
droppednumber | nullOptional dropped supplied by this operation. Null means unknown.
has_moreboolean | nullSource continuation indicator; null means unknown.
itemsarray | nullReturned records. Source coverage and completeness vary.
items[].badgesarray | nullOptional badges supplied by this operation. Null means unknown.
items[].citystring | nullOptional city supplied by this operation. Null means unknown.
items[].idstring | nullSource identifier. Preserve the supplied type and exact value.
items[].image_urlstring | nullOptional image url supplied by this operation. Null means unknown.
items[].imagesarray | nullOptional images supplied by this operation. Null means unknown.
items[].latitudenumber | nullOptional latitude supplied by this operation. Null means unknown.
items[].longitudenumber | nullOptional longitude supplied by this operation. Null means unknown.
items[].namestring | nullOptional name supplied by this operation. Null means unknown.
items[].notesarray | nullOptional notes supplied by this operation. Null means unknown.
items[].platformstring | nullOptional platform supplied by this operation. Null means unknown.
items[].priceobject | nullSource price. Currency, taxes and availability depend on the listing.
items[].price.accessibility_labelstring | nullOptional accessibility label supplied by this operation. Null means unknown.
items[].price.amountnumber | nullOptional amount supplied by this operation. Null means unknown.
items[].price.labelstring | nullOptional label supplied by this operation. Null means unknown.
items[].price.original_amountnumber | nullOptional original amount supplied by this operation. Null means unknown.
items[].price.original_labelstring | nullOptional original label supplied by this operation. Null means unknown.
items[].price.qualifierstring | nullOptional qualifier supplied by this operation. Null means unknown.
items[].price_breakdownarray | nullOptional price breakdown supplied by this operation. Null means unknown.
items[].ratingnumber | nullSource rating; read its accompanying scale and vote count.
items[].reviewsnumber | nullOptional reviews supplied by this operation. Null means unknown.
items[].subtitlestring | nullOptional subtitle supplied by this operation. Null means unknown.
items[].titlestring | nullSource title when supplied.
items[].typestring | nullOptional type supplied by this operation. Null means unknown.
items[].urlstring | nullOriginal source URL when supplied.
placeobject | nullOptional place supplied by this operation. Null means unknown.
place.idstring | nullSource identifier. Preserve the supplied type and exact value.
place.namestring | nullOptional 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

First call in under a minute

150 free credits and a ready-made key the moment you sign up. No card.