> ## 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 listing

> Read an Airbnb listing page as JSON with the airbnb-listing parser. $1 per 1,000 calls. Send the page to scrape. Examples in cURL, TypeScript and Python.

Reads an Airbnb listing page, like airbnb.com/rooms/18249319, and returns one listing 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/rooms/18249319","formats":[{"type":"json","parser":"airbnb-listing"}]}'
```

```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/rooms/18249319",
    formats: [{ type: "json", parser: "airbnb-listing" }],
  }),
});
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/rooms/18249319",
        "formats": [{"type": "json", "parser": "airbnb-listing"}],
    },
)
print(response.json())
```

## Read the response

The parser's data is in `data.json`. Its fields include `id`, `url`, `title`, `description`, `price`, `pricePeriod`, `status`, `address`, `location`, `bedrooms`, `bathrooms`, `area`, `propertyType`, `rating`, `reviewCount`, `images` and `host`. This sample is cut to the first items.

```json theme={null}
{
  "success": true,
  "data": {
    "json": {
      "id": "18249319",
      "url": "https://www.airbnb.com/rooms/18249319",
      "title": "Boutique Flat Cris do Carmo",
      "description": "Located in the trendy, buzzing, and historic neighborhood of Chiado, this one-bedroom flat is both cozy and stylish,…",
      "price": null,
      "pricePeriod": "night",
      "status": null,
      "address": "Lisbon, Portugal",
      "location": {
        "latitude": 38.71345,
        "longitude": -9.14014
      },
      "bedrooms": 1,
      "bathrooms": 1,
      "area": null,
      "propertyType": "Entire rental unit",
      "rating": 4.88,
      "reviewCount": 432,
      "images": [
        "https://a0.muscache.com/im/pictures/502c9731-ade7-4661-ad6b-bf8d7f11a039.jpg",
        "https://a0.muscache.com/im/pictures/1cfb830e-c5a2-4653-aa4e-7763183827f5.jpg",
        "https://a0.muscache.com/im/pictures/36e150aa-079b-4732-b616-da4e48256e15.jpg"
      ],
      "host": {
        "id": null,
        "name": "GestHomes By Alexandra & Pedro",
        "handle": null,
        "url": null,
        "avatarUrl": null,
        "isSuperhost": true
      },
      "guests": 2,
      "beds": 2,
      "amenities": [
        "Hair dryer",
        "Cleaning products",
        "Shampoo"
      ],
      "isGuestFavorite": true,
      "ratingAccuracy": 4.87,
      "ratingCheckin": 4.88,
      "ratingCleanliness": 4.92,
      "ratingCommunication": 4.92,
      "ratingLocation": 4.96,
      "ratingValue": 4.78,
      "houseRules": [
        "Up to 2 overnight guests",
        "No pets",
        "No smoking: Including vaping and e-cigarettes"
      ],
      "isAvailable": null,
      "totalPrice": null,
      "priceBeforeDiscount": null
    }
  }
}
```

## Options

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

| Option | What it does |
| - | - |
| `checkIn` | First night, as YYYY-MM-DD. Send it with checkOut to get the price. |
| `checkOut` | Day you leave, as YYYY-MM-DD. Send it with checkIn to get the price. |
| `guests` | Number of guests. Only stays that fit this many. |
| `currency` | Currency of every price in the answer and of minPrice and maxPrice. |

## Price

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

## Limits and errors

* The URL must be an Airbnb listing page, like airbnb.com/rooms/18249319. With check\_in, check\_out and adults in the link it also returns the price for those dates. Any other URL fails with `invalidRequest`.
* 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 search](https://docs.stophy.dev/scrape/prebuilt-parsers/places-and-travel/airbnb-search.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.