Search public Airbnb stays for a place and optional dates and guests: for each stay the id, url, title, name, subtitle, rating, review count, total price with currency and price breakdown, bedrooms, beds, bathrooms, approximate coordinates, badges and images. Pass the place as City--Country (Paris--France) or as City, Country. Page with the cursor from the previous response next_cursor field. The price is the total for the stay; without dates Airbnb prices a default stay. An unknown place returns a not-billable 404.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
10 optional filters available.
string
Required
City and country, e.g. Paris--France or Paris, France.
Paris--France
string
Optional
Check-in date, YYYY-MM-DD. Send together with checkout. Must not be in the past.
2026-11-10
string
Optional
Check-out date, YYYY-MM-DD, after check-in.
2026-11-14
integer
Optional
Number of adults, 1 to 16. Defaults to 1.
2
integer
Optional
Number of children, 0 to 10.
10
integer
Optional
Number of infants, 0 to 10.
10
integer
Optional
Number of pets, 0 to 10.
10
string
Optional
ISO 4217 currency code for prices. Defaults to USD. Example: EUR.
EUR
integer
Optional
Maximum nightly price in the chosen currency.
10
string
Optional
One of entire_home, private_room, hotel_room.
example
string
Optional
Cursor from the previous response next_cursor field. Omit for the first page.
0
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: YOUR_API_KEY_HERE"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
<?php
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR', options)
.then(response => {
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
return response.text();
})
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR',
headers: {
x-api-key: 'YOUR_API_KEY_HERE',
}
};
try {
const response = await axios(options);
console.log(response.data);
} catch (error) {
console.error('Error:', error.message);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'
begin
response = http.request(request)
puts response.body
rescue => e
puts "Error: #{e.message}"
end
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
public class ApiExample {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR")
.addHeader("x-api-key", "YOUR_API_KEY_HERE")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Error: " + response.code());
}
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR", nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR"
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");
try
{
var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.get("https://scrappa.co/api/airbnb/search?place=Paris--France&checkin=2026-11-10&checkout=2026-11-14&adults=2¤cy=EUR")
.header("x-api-key", "YOUR_API_KEY_HERE")
.send()
.await?;
println!("{}", response.text().await?);
Ok(())
}
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
success
data
meta
{
"success": true,
"data": {
"place": "Paris, France",
"results": [
{
"id": "871709404587070017",
"url": "https://www.airbnb.com/rooms/871709404587070017",
"title": "Apartment in Paris",
"name": "Nice attic apartment - Haut-Marais",
"subtitle": "Nice attic apartment - Haut-Marais",
"rating": 4.8,
"review_count": 25,
"price": {
"amount": 558,
"currency": "EUR",
"qualifier": "total"
},
"price_breakdown": [
{
"description": "4 nights x \u20ac120.00",
"amount": 480
},
{
"description": "Taxes",
"amount": 78
},
{
"description": "Total",
"amount": 558
}
],
"bedrooms": 1,
"beds": 1,
"bathrooms": 1,
"latitude": 48.86726,
"longitude": 2.35481,
"badges": [
"Guest favorite"
],
"images": [
"https://a0.muscache.com/im/pictures/miso/Hosting-871709404587070017/original/9bbcbfb8-f508-4d78-b1aa-729f30141ba7.jpeg",
"https://a0.muscache.com/im/pictures/miso/Hosting-871709404587070017/original/5d4c23fb-2dcf-4462-a480-721b1a53313d.jpeg"
]
}
],
"has_more": true,
"next_cursor": "eyJzZWN0aW9uX29mZnNldCI6MCwiaXRlbXNfb2Zmc2V0IjoxOCwidmVyc2lvbiI6MX0="
},
"meta": {
"endpoint_family": "stay_search",
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
A required query parameter is missing or invalid. This response is not billable.
{
"errors": {
"place": [
"The place field is required."
]
},
"message": "The request validation failed"
}Resource Not Found
The requested Airbnb place was not found. Use City--Country such as Paris--France. This response is not billable.
{
"error": {
"code": "NOT_FOUND",
"message": "The requested Airbnb place or listing was not found."
},
"success": false
}Service Unavailable
Airbnb could not be reached, blocked the request or returned an unexpected response. This response is not billable. Retry later.
{
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Airbnb is temporarily unavailable. Please retry."
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.