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

# Scrape Airbnb stay listings

> Searches Airbnb for `location` and returns the stay listings as JSON: `name`, `roomType`, `price` (USD by default) with any original price, `rating` and `reviewCount`, coordinates, `badges` (e.g. Guest favourite), `image` and a clean room `url`. Filter with `checkin`/`checkout`, `adults`, `min_price`/`max_price` and `room_type`, and collect up to `max_results` across pages.



## OpenAPI

````yaml /api-reference/openapi.json post /travel/airbnb
openapi: 3.1.0
info:
  title: ScrapeUnblocker API
  description: >-
    Public API for the ScrapeUnblocker proxy/anti-bot service. Authenticate
    every request with the `x-scrapeunblocker-key` header. Three endpoints are
    documented here: page-source extraction, Google SERP scraping, and image
    fetch. All other paths exist for internal operations and are intentionally
    hidden from this spec.
  version: 3.0.0
servers:
  - url: https://api.scrapeunblocker.com
    description: Production
security: []
paths:
  /travel/airbnb:
    post:
      tags:
        - Plugins
      summary: Scrape Airbnb stay listings
      description: >-
        Searches Airbnb for `location` and returns the stay listings as JSON:
        `name`, `roomType`, `price` (USD by default) with any original price,
        `rating` and `reviewCount`, coordinates, `badges` (e.g. Guest
        favourite), `image` and a clean room `url`. Filter with
        `checkin`/`checkout`, `adults`, `min_price`/`max_price` and `room_type`,
        and collect up to `max_results` across pages.
      operationId: airbnb_search_travel_airbnb_post
      parameters:
        - name: location
          in: query
          required: true
          schema:
            type: string
            description: City to search, e.g. 'Austin, TX' or 'Paris, France'.
            title: Location
          description: City to search, e.g. 'Austin, TX' or 'Paris, France'.
        - name: checkin
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Check-in date YYYY-MM-DD (with checkout).
            title: Checkin
          description: Check-in date YYYY-MM-DD (with checkout).
        - name: checkout
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Check-out date YYYY-MM-DD (with checkin).
            title: Checkout
          description: Check-out date YYYY-MM-DD (with checkin).
        - name: adults
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 1
              - type: 'null'
            description: Number of adult guests.
            title: Adults
          description: Number of adult guests.
        - name: room_type
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Room type filter: entire_home, private_room, hotel_room,
              shared_room. Omit for all.
            title: Room Type
          description: >-
            Room type filter: entire_home, private_room, hotel_room,
            shared_room. Omit for all.
        - name: min_price
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 0
              - type: 'null'
            description: Minimum nightly price.
            title: Min Price
          description: Minimum nightly price.
        - name: max_price
          in: query
          required: false
          schema:
            anyOf:
              - type: integer
                minimum: 0
              - type: 'null'
            description: Maximum nightly price.
            title: Max Price
          description: Maximum nightly price.
        - name: max_results
          in: query
          required: false
          schema:
            type: integer
            maximum: 720
            minimum: 1
            description: How many listings to collect across pages.
            default: 48
            title: Max Results
          description: How many listings to collect across pages.
        - name: proxy_country
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Exit-IP country (ISO-2). Defaults to US so prices are in USD.
            title: Proxy Country
          description: Exit-IP country (ISO-2). Defaults to US so prices are in USD.
      responses:
        '200':
          description: JSON with a `listings` array.
          content:
            application/json:
              schema: {}
        '400':
          description: Invalid parameters.
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '502':
          description: Blocked by Airbnb or no results page returned.
        '504':
          description: Fetch timed out.
      security:
        - ScrapeUnblockerKey: []
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    ScrapeUnblockerKey:
      type: apiKey
      in: header
      name: x-scrapeunblocker-key
      description: Your ScrapeUnblocker API key. Apply on every request.

````