Search Spotahome rentals in one city: for each listing the position, id, title, public url, type, property type, monthly price (the lowest price; max_price is set when the listing has a price range), currency, first available date (YYYY-MM-DD), bills, bedrooms, bathrooms, area, instant booking, deposit flags, address, coordinates, photos, rating and a plain-text description. Pages hold 48 listings. Use total_pages, has_more and next_page to walk the results. A valid search with no matching listings is a successful response with an empty listings array. An unknown city returns 404 and is not billed.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
2 required parameters needed before sending a request.
5 optional filters available.
string
Required
City slug as used by Spotahome, lowercase letters, numbers and hyphens. Example: madrid.
madrid
string
Required
Country slug as used by Spotahome, lowercase letters, numbers and hyphens. Example: spain.
spain
integer
Optional
Page number, 1 to 1000. Defaults to 1. A page past the last page returns an empty listings array.
1
integer
Optional
Lowest monthly price in the city currency. Send together with max_price. Example: 500.
10
integer
Optional
Highest monthly price in the city currency. Send together with min_price. Example: 900.
10
string
Optional
One of rooms, apartments, studios, residences. Example: studios.
example
string
Optional
Earliest move-in date as YYYY-MM-DD, not in the past and at most two years ahead. Example: 2026-12-01.
example
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/spotahome/search?city=madrid&country=spain",
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/spotahome/search?city=madrid&country=spain');
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/spotahome/search?city=madrid&country=spain', 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/spotahome/search?city=madrid&country=spain',
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/spotahome/search?city=madrid&country=spain")
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/spotahome/search?city=madrid&country=spain", 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/spotahome/search?city=madrid&country=spain', 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/spotahome/search?city=madrid&country=spain")
.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/spotahome/search?city=madrid&country=spain", 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/spotahome/search?city=madrid&country=spain"
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/spotahome/search?city=madrid&country=spain"));
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/spotahome/search?city=madrid&country=spain',
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/spotahome/search?city=madrid&country=spain")
.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": {
"city": {
"id": "madrid",
"name": "Madrid",
"country_code": "ES",
"currency": "EUR"
},
"total_results": 9704,
"total_pages": 203,
"page": 1,
"has_more": true,
"listings": [
{
"position": 1,
"id": "80504",
"title": "Room in shared apartment for rent in Gaztambide, Madrid",
"url": "https://www.spotahome.com/madrid/for-rent:rooms/80504",
"type": "room_shared",
"property_type": "rooms",
"price": 660,
"currency": "EUR",
"available_from": "2027-01-31",
"bills_included": "none",
"bedrooms": 5,
"bathrooms": 2,
"is_instant_booking": false,
"is_checked": true,
"no_security_deposit": false,
"has_deposit_protection": false,
"address": {
"street": "Guzman el Bueno",
"postal_code": "28015",
"city": "Madrid"
},
"latitude": 40.43137,
"longitude": -3.71313,
"main_photo_url": "https://photos.spotahome.com/smw_768/11f7eb0b4a5bf48d04be29239ad3f231f75e0b0d1b11b3df3845577a.jpg",
"photo_urls": [
"https://photos.spotahome.com/smww_768_verified_ur_6_50/11f7eb0b4a5bf48d04be29239ad3f231f75e0b0d1b11b3df3845577a.jpg",
"https://photos.spotahome.com/smww_768_verified_ur_6_50/e238b2f85a0f1e4fa4c6404e98689ae31dbe41290f748f7ec451af8a.jpg"
],
"description": "This spacious and well-furnished room is located in a shared 5-bedroom apartment in the Gaztambide neighborhood of Madrid. The apartment includes features such as a private washing machine, equipped kitchen with an oven, heating system, and a television for tenant use. Spotahome has personally checked and verified this property."
},
{
"position": 2,
"id": "130400",
"title": "Cozy room in 12-bedroom apartment in Atocha, Madrid",
"url": "https://www.spotahome.com/madrid/for-rent:rooms/130400",
"type": "room_shared",
"property_type": "rooms",
"price": 850,
"currency": "EUR",
"available_from": "2026-10-15",
"bills_included": "all",
"bedrooms": 12,
"bathrooms": 1,
"is_instant_booking": false,
"is_checked": true,
"no_security_deposit": false,
"has_deposit_protection": false,
"address": {
"street": "Calle de Atocha, 43, 28012 Madrid, Spain",
"postal_code": "28012",
"city": "Madrid"
},
"latitude": 40.41396,
"longitude": -3.7012,
"main_photo_url": "https://photos.spotahome.com/smww_768_verified_ur_6_50/88b056d37e1fdefe01f9c8c08a96796a66c275d6cdf2cc5d36094dac.jpg",
"photo_urls": [
"https://photos.spotahome.com/smww_768_verified_ur_6_50/88b056d37e1fdefe01f9c8c08a96796a66c275d6cdf2cc5d36094dac.jpg",
"https://photos.spotahome.com/smww_768_verified_ur_6_50/3f0c9167c52cdabcc5120891525e3c65181906f55186ca31d480ce21.jpg"
],
"description": "Rooms are available for rent in a 12-bedroom shared apartment in the Central Zone of Madrid. All rooms come with a desk, lamp and a wardrobe. There are two communal areas, a kitchen that is fully equipped for the house capacity and a living area. The kitchen has sufficient space to socialise and relax with your friends or other housemates."
}
],
"next_page": 2
},
"meta": {
"endpoint_family": "search_city",
"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": {
"city": [
"The city field is required."
]
},
"message": "The request validation failed"
}Resource Not Found
The requested Spotahome city or listing does not exist. This response is not billable.
{
"error": {
"code": "NOT_FOUND",
"message": "The requested Spotahome resource was not found."
},
"success": false
}Service Unavailable
The upstream service is temporarily unavailable. Please retry shortly.
{
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "The Spotahome API 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.