Skip to content
Browsabledocs
↑ ↓ to navigate · Enter to openQuick links
Staging API reference · Requests use https://api-ingress-worker-staging.browsable-staging.workers.dev
Documentation Airbnb search
Markdown ↗
Airbnb APIs

Airbnb search

Search Airbnb stay results for a destination/date combination and return normalized listings with cursor pagination.

POST/v1/airbnb/search
Authenticate every request

Send Authorization: Bearer YOUR_API_KEY. Get an API key →

Parameters

Send these fields in a flat JSON body. Add _run to choose execution options.

querystringRequired

Airbnb destination query, such as a city or neighborhood name. Minimum length: 1. Maximum length: 2000.

checkinstringRequired

Check-in date in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$.

checkoutstringRequired

Check-out date in YYYY-MM-DD format. Pattern: ^\d{4}-\d{2}-\d{2}$.

accessibility_featuresstring | array<string | number>Optional

Accessibility feature labels from Airbnb such as "Step-free access" or "Disabled parking spot". Accepts a comma-separated string or an array.

adultsintegerOptional

Number of adult guests. Default: 1. Minimum: 1. Maximum: 16.

amenitiesstring | array<string | number>Optional

Amenity labels from Airbnb such as "Wifi", "Kitchen", or "Free parking". Raw Airbnb amenity IDs are also accepted.

bathroom_privacystring | array<string | number>Optional

Bathroom privacy labels or raw values such as "Private attached bathroom" or "ENSUITE". Accepts a comma-separated string or an array.

bathroomsstring | numberOptional

Minimum number of bathrooms.

bedroomsstring | numberOptional

Minimum number of bedrooms.

bedsstring | numberOptional

Minimum number of beds.

booking_optionsstring | array<string | number>Optional

Booking option labels from Airbnb such as "Instant Book", "Self check-in", "Free cancellation", or "Allows pets". Accepts a comma-separated string or an array.

childrenintegerOptional

Number of child guests. Default: 0. Minimum: 0. Maximum: 16.

cursorstringOptional

Optional Airbnb pagination cursor from a search URL or previous response to start from a later result page.

flexible_cancellationboolean | string | numberOptional

Flexible cancellation filter. Accepts true/false or 1/0.

guest_favoriteboolean | string | numberOptional

Guest favorite filter. Accepts true/false or 1/0.

host_languagesstring | array<string | number>Optional

Host language labels such as "English", "French", or "Sign Language". Raw language codes like en and fr are also accepted.

instant_bookboolean | string | numberOptional

Instant Book filter. Accepts true/false or 1/0.

pagesintegerOptional

Number of paginated Airbnb result pages to fetch (1-20). Default: 1. Minimum: 1. Maximum: 20.

petsstring | numberOptional

Pet-friendly filter as a positive count, typically 1.

price_maxstring | numberOptional

Maximum nightly price filter from an Airbnb search URL.

price_minstring | numberOptional

Minimum nightly price filter from an Airbnb search URL.

property_typesstring | array<string | number>Optional

Property type labels from Airbnb such as "House", "Apartment", or "Guesthouse". Accepts a comma-separated string or an array.

room_typesstring | array<string | number>Optional

Room type labels such as "Room" or "Entire home". Raw Airbnb values like "Private room" are also accepted.

standout_staysstring | array<string | number>Optional

Standout stay labels from Airbnb such as "Guest favorite" or "Luxe". Accepts a comma-separated string or an array.

type_of_placestring | array<string | number>Optional

Type of place labels from Airbnb such as "Room" or "Entire home". Accepts a comma-separated string or an array.

Advanced & compatibility inputs 2
property_type_idsstring | array<string | number>Optional

Raw Airbnb property type IDs. Prefer property_types for human-readable labels.

tier_idsstring | array<string | number>Optional

Raw Airbnb tier IDs, or labels such as "Luxe" when the option is available.

Response

Every response describes a run. Read result once run_status is succeeded.

run_id
The run to track. Keep it when contacting support.
run_status
Queued, running, waiting for sign-in, succeeded, or failed. Check this even after an HTTP 200.
status_url
Poll this URL while the run is pending. Keep the same run instead of starting another request.
result
The endpoint’s returned data. The example is illustrative; actual fields may be empty or unavailable.
error
On failure, inspect its code, message, retryable and action fields.
View the complete output schema
JSON
{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "success",
    "query",
    "checkin",
    "checkout",
    "adults",
    "children",
    "applied_filters",
    "pages_requested",
    "pages_fetched",
    "count",
    "results",
    "pagination"
  ],
  "properties": {
    "count": {
      "type": "number"
    },
    "query": {
      "type": "string"
    },
    "adults": {
      "type": "number"
    },
    "checkin": {
      "type": "string"
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "page",
          "link",
          "badges",
          "payment_messages",
          "image_urls",
          "details",
          "price"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "link": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "page": {
            "type": "number"
          },
          "price": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "display",
                  "amount_numeric",
                  "currency",
                  "qualifier"
                ],
                "properties": {
                  "display": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "currency": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "qualifier": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "amount_numeric": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "original_display": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "accessibility_label": {
                    "anyOf": [
                      {
                        "type": "string"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "original_amount_numeric": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "title": {
            "type": "string"
          },
          "badges": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rating": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          },
          "details": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "location": {
            "anyOf": [
              {
                "type": "object",
                "required": [
                  "lat",
                  "lng"
                ],
                "properties": {
                  "lat": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  },
                  "lng": {
                    "anyOf": [
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                "additionalProperties": false
              },
              {
                "type": "null"
              }
            ]
          },
          "subtitle": {
            "type": "string"
          },
          "image_urls": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "rating_text": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "review_count": {
            "anyOf": [
              {
                "type": "number"
              },
              {
                "type": "null"
              }
            ]
          },
          "payment_messages": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "additionalProperties": true
      }
    },
    "success": {
      "type": "boolean"
    },
    "checkout": {
      "type": "string"
    },
    "children": {
      "type": "number"
    },
    "pagination": {
      "type": "object",
      "required": [
        "has_next_page",
        "next_page",
        "next_page_cursor",
        "previous_page_cursor",
        "page_cursors"
      ],
      "properties": {
        "next_page": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "total_pages": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "current_page": {
          "anyOf": [
            {
              "type": "number"
            },
            {
              "type": "null"
            }
          ]
        },
        "page_cursors": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "has_next_page": {
          "type": "boolean"
        },
        "next_page_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "previous_page_cursor": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": false
    },
    "section_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "pages_fetched": {
      "type": "number"
    },
    "applied_filters": {
      "type": "object",
      "properties": {
        "beds": {
          "type": "number"
        },
        "pets": {
          "type": "number"
        },
        "bedrooms": {
          "type": "number"
        },
        "tier_ids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "amenities": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "bathrooms": {
          "type": "number"
        },
        "price_max": {
          "type": "number"
        },
        "price_min": {
          "type": "number"
        },
        "room_types": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "instant_book": {
          "type": "boolean"
        },
        "type_of_place": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "guest_favorite": {
          "type": "boolean"
        },
        "host_languages": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "property_types": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "standout_stays": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "booking_options": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "bathroom_privacy": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "property_type_ids": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "flexible_cancellation": {
          "type": "boolean"
        },
        "accessibility_features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      },
      "additionalProperties": false
    },
    "pages_requested": {
      "type": "number"
    },
    "search_session_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "additionalProperties": true
}
View a polled run response
JSON
{
  "run_id": "00000000-0000-4000-8000-000000000001",
  "task_key": "airbnb-search",
  "task_name": "Airbnb search",
  "run_status": "succeeded",
  "status_url": "/v1/runs/00000000-0000-4000-8000-000000000001",
  "result": {
    "success": true,
    "query": "London",
    "checkin": "2027-06-14",
    "checkout": "2027-06-21",
    "adults": 2,
    "children": 1,
    "applied_filters": {
      "amenities": [
        "Wifi",
        "Kitchen"
      ],
      "room_types": [
        "Entire home"
      ],
      "instant_book": true,
      "guest_favorite": true,
      "price_min": 180,
      "price_max": 350
    },
    "pages_requested": 2,
    "pages_fetched": 2,
    "count": 2,
    "search_session_id": "search-session-1",
    "section_id": "EXPLORE_SEARCH_RESULTS",
    "results": [
      {
        "id": "101",
        "page": 1,
        "link": "https://www.airbnb.com/rooms/101",
        "name": "Stylish Shoreditch Loft with Balcony",
        "title": "Stylish Shoreditch Loft with Balcony",
        "subtitle": "Entire rental unit in Greater London",
        "badges": [
          "Guest favorite"
        ],
        "payment_messages": [
          "Free cancellation"
        ],
        "image_urls": [
          "https://images.example.com/airbnb/101-1.jpg",
          "https://images.example.com/airbnb/101-2.jpg"
        ],
        "details": [
          "2 guests",
          "1 bedroom",
          "1 bed",
          "1 bath"
        ],
        "price": {
          "display": "GBP 210 total",
          "amount_numeric": 210,
          "currency": "GBP",
          "qualifier": "for 1 night",
          "original_display": "GBP 240 total",
          "accessibility_label": "GBP 210 total for 1 night",
          "original_amount_numeric": 240
        },
        "rating": 4.91,
        "location": {
          "lat": 51.5246,
          "lng": -0.0759
        },
        "rating_text": "4.91 · 128 reviews",
        "review_count": 128
      },
      {
        "id": "202",
        "page": 2,
        "link": "https://www.airbnb.com/rooms/202",
        "name": "Bright Notting Hill Apartment Near Tube",
        "title": "Bright Notting Hill Apartment Near Tube",
        "subtitle": "Private room in Kensington",
        "badges": [
          "Superhost"
        ],
        "payment_messages": [
          "Reserve now, pay later"
        ],
        "image_urls": [
          "https://images.example.com/airbnb/202-1.jpg",
          "https://images.example.com/airbnb/202-2.jpg"
        ],
        "details": [
          "2 guests",
          "1 bedroom",
          "1 bed",
          "Shared bath"
        ],
        "price": {
          "display": "GBP 245 total",
          "amount_numeric": 245,
          "currency": "GBP",
          "qualifier": "for 1 night",
          "original_display": "GBP 280 total",
          "accessibility_label": "GBP 245 total for 1 night",
          "original_amount_numeric": 280
        },
        "rating": 4.84,
        "location": {
          "lat": 51.5092,
          "lng": -0.1964
        },
        "rating_text": "4.84 · 76 reviews",
        "review_count": 76
      }
    ],
    "pagination": {
      "current_page": 2,
      "total_pages": 2,
      "page_cursors": [
        "cursor-page-1",
        "cursor-page-2"
      ],
      "has_next_page": false,
      "next_page": null,
      "next_page_cursor": null,
      "previous_page_cursor": "cursor-page-1"
    }
  },
  "error": null
}

Errors & retries

  • 400Fix the fields listed in errors before retrying.
  • 428Connect the requested website account using the returned sign-in link.
  • 429Wait for the duration in Retry-After.
  • 5xxRetry transient failures with backoff. Keep the request ID.

A failed run has its own error inside the response. Retry it only when error.retryable is true.

Validation, pagination and recovery →

More examples

Async request with polling
RUN=$(curl -s -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/airbnb/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"London","checkin":"2027-06-14","checkout":"2027-06-21"}')

RUN_ID=$(echo "$RUN" | jq -er '.run_id // empty') || { echo "$RUN" >&2; exit 1; }
POLL_DELAY=3

while true; do
  RESULT=$(curl -s -H "Authorization: Bearer YOUR_API_KEY" "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/runs/$RUN_ID")
  STATUS=$(echo "$RESULT" | jq -r '.run_status')
  if [[ "$STATUS" =~ ^(succeeded|failed|errored|cancelled|canceled|expired)$ ]]; then
    echo "$RESULT"
    break
  fi
  sleep "$(awk "BEGIN { print $POLL_DELAY * (0.9 + ($RANDOM % 21) / 100) }")"
  POLL_DELAY=$((POLL_DELAY < 30 ? POLL_DELAY * 2 : 30))
  [ "$POLL_DELAY" -gt 30 ] && POLL_DELAY=30
done
Wait-for-results request
curl -X POST "https://api-ingress-worker-staging.browsable-staging.workers.dev/v1/airbnb/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"London","checkin":"2027-06-14","checkout":"2027-06-21","_run":{"async":false}}'
Canonical & compatibility routes

You can also send the same JSON body to /v1/tasks/airbnb-search/runs.