> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stophy.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Airbnb search

> Read an Airbnb search page for a place with checkin and checkout dates as JSON with the airbnb-search parser. $1 per 1,000 calls.

Reads an Airbnb search page for a place with checkin and checkout dates, like airbnb.com/s/Lisbon--Portugal/homes?checkin=2026-12-10\&checkout=2026-12-12, and returns a list of listings as JSON.

## Make a request

Send the page's URL to [scrape](https://docs.stophy.dev/api-reference/endpoint/scrape.md) with a `json` format that names the parser. Get an API key in the [Quickstart](https://docs.stophy.dev/quickstart).

```bash cURL theme={null}
curl -X POST https://api.stophy.dev/v1/scrape \
  -H "Authorization: Bearer $STOPHY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://www.airbnb.com/s/Lisbon--Portugal/homes?checkin=2026-12-10&checkout=2026-12-12&adults=2","formats":[{"type":"json","parser":"airbnb-search"}]}'
```

```typescript TypeScript theme={null}
const response = await fetch("https://api.stophy.dev/v1/scrape", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.STOPHY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://www.airbnb.com/s/Lisbon--Portugal/homes?checkin=2026-12-10&checkout=2026-12-12&adults=2",
    formats: [{ type: "json", parser: "airbnb-search" }],
  }),
});
console.log(await response.json());
```

```python Python theme={null}
import os

import requests

response = requests.post(
    "https://api.stophy.dev/v1/scrape",
    headers={"Authorization": f"Bearer {os.environ['STOPHY_API_KEY']}"},
    json={
        "url": "https://www.airbnb.com/s/Lisbon--Portugal/homes?checkin=2026-12-10&checkout=2026-12-12&adults=2",
        "formats": [{"type": "json", "parser": "airbnb-search"}],
    },
)
print(response.json())
```

## Read the response

The parser's data is in `data.json`. Its fields include `results`, `cursor`, `page` and `total`. This sample is cut to the first items.

```json theme={null}
{
  "success": true,
  "data": {
    "json": {
      "results": [
        {
          "id": "635404000587905839",
          "url": "https://www.airbnb.com/rooms/635404000587905839",
          "title": "Standard Studio with AC and Private bathroom",
          "description": null,
          "price": {
            "amount": 68.36,
            "currency": "USD"
          },
          "pricePeriod": "night",
          "status": null,
          "address": "Lisbon",
          "location": {
            "latitude": 38.7193,
            "longitude": -9.1572
          },
          "bedrooms": null,
          "bathrooms": null,
          "area": null,
          "propertyType": "Apartment",
          "rating": 4.92,
          "reviewCount": 350,
          "images": [
            "https://a0.muscache.com/im/pictures/miso/Hosting-635404000587905839/original/3131351e-96cc-4756-b74c-f644f5151efe.jpeg",
            "https://a0.muscache.com/im/pictures/miso/Hosting-635404000587905839/original/4a866961-2a6a-4cdd-9bde-dbe3fa76be06.jpeg",
            "https://a0.muscache.com/im/pictures/miso/Hosting-635404000587905839/original/65558c53-5aee-4d4d-8e4e-d7872c2e81bb.jpeg"
          ],
          "host": null,
          "badges": [
            "Guest favorite"
          ],
          "totalPrice": {
            "amount": 154.66,
            "currency": "USD"
          },
          "priceBeforeDiscount": {
            "amount": 170.64,
            "currency": "USD"
          }
        }
      ],
      "cursor": "eyJzZWN0aW9uX29mZnNldCI6MCwiaXRlbXNfb2Zmc2V0IjoxOCwidmVyc2lvbiI6MX0=~82f73074-e148-48f7-b3a3-d0c1f5fefc9e~1793832342_EAMmM5MDBmNjE4Zm~4tsfx44wwpwv.csstjkeoah...",
      "page": null,
      "total": null,
      "location": "Lisbon, Portugal"
    }
  }
}
```

## Options

Send options in the `options` object of the `json` format.

| Option | What it does |
| - | - |
| `minPrice` | Airbnb's own price range minimum: the nightly price after discounts and before taxes, in currency. |
| `maxPrice` | Airbnb's own price range maximum: the nightly price after discounts and before taxes, in currency. |
| `roomType` | Airbnb's own Type of place filter: entireHome (Entire home) or privateRoom (Room). |
| `currency` | Currency of every price in the answer and of minPrice and maxPrice. |
| `cursor` | The cursor from the previous response. Send it as is. |

## Price

\$1 per 1,000 calls. See [Pricing](https://docs.stophy.dev/account/pricing.md).

## Limits and errors

* The URL must be an Airbnb search page for a place with checkin and checkout dates, like airbnb.com/s/Lisbon--Portugal/homes?checkin=2026-12-10\&checkout=2026-12-12. Any other URL fails with `invalidRequest`.
* To read the next page, send the `cursor` from the response as the `cursor` option. Paging needs an API key.
* The answer comes back in `data.json`. If the page cannot be read, the call fails with an error code from [Errors](https://docs.stophy.dev/api-reference/errors.md).

## Related

* [Pre-built parsers](https://docs.stophy.dev/scrape/prebuilt-parsers) lists every parser.
* [Scrape](https://docs.stophy.dev/scrape/overview) has the options every scrape takes.
* [Airbnb listing](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/airbnb-listing.md)
* [Airbnb reviews](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/airbnb-reviews.md)
* [Google Maps](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/google-maps.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.