Skip to content
Scrappa Get API key
Habitaclia API 1 credit/request

Habitaclia Search API Documentation

GET https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc

Search the live Habitaclia catalogue for Spain. Pass a place code and layer_id from /locations to scope the search, for example code 46250 with layer_id 20 (municipality) or layer_id 11 (province). Paginate with page and page_size; total_count and has_more come from the same response, so they always agree with the page you fetched. An unknown place code returns an empty data array, which is a successful, billable response. Prices are in EUR.

Habitaclia Search API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc
Auth header
x-api-key
Cost
1 credit/request
transaction_type = buy property_type = flat code = 46250
Response preview
200 OK
{
    "success": true,
    "data": [
        {
            "ad_id": "5f6a57a2-f588-47e8-8182-588957475340",
            "legacy_id": "i41124000089339",
            "url": "https://www.habitaclia.com/i41124000089339.htm",
            "reference": "CL-00729-0001",
            "title": "Solvia Inmobiliaria Piso Valencia",
            "property_type": "flat",
            "property_subtype": "flat",
            "transaction_type": "buy",
            "price": 24600,
            "currency": "EUR",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

4 required parameters needed before sending a request.

9 optional filters available.

transaction_type string Required

buy or rent.

Example value buy
property_type string Required

flat, house, office, garage, building or land.

Example value flat
code string Required

Numeric place code from /locations, for example 46250.

Example value 46250
layer_id integer Required

Place level from /locations: 11 province, 14 zone, 20 municipality, 26 street.

Example value 20
page integer Optional

1-based page number. Defaults to 1.

Example value 1
page_size integer Optional

Items per page, 1 to 1000. Defaults to 20.

Example value 5
sort_by string Optional

relevance, price_asc, price_desc or newest. Defaults to relevance.

Example value price_asc
min_price integer Optional

Minimum price in EUR.

Example value 10
max_price integer Optional

Maximum price in EUR.

Example value 10
min_rooms integer Optional

Minimum number of rooms.

Example value 10
min_bathrooms integer Optional

Minimum number of bathrooms.

Example value 10
features array Optional

Repeatable feature filter, for example features=pool&features=terrace. Allowed: pool, terrace, elevator, furnished, unfurnished, private_parking, private_garden, nearby_public_transport.

Example value ["example"]
is_private boolean Optional

Only private-owner listings when true.

Example value true

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc",
    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
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc")
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
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc")
        .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());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc"
C#
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/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
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/habitaclia/search?transaction_type=buy&property_type=flat&code=46250&layer_id=20&page=1&page_size=5&sort_by=price_asc")
        .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

Common data fields

ad_id legacy_id url reference
JSON Response
200 OK
{
    "success": true,
    "data": [
        {
            "ad_id": "5f6a57a2-f588-47e8-8182-588957475340",
            "legacy_id": "i41124000089339",
            "url": "https://www.habitaclia.com/i41124000089339.htm",
            "reference": "CL-00729-0001",
            "title": "Solvia Inmobiliaria Piso Valencia",
            "property_type": "flat",
            "property_subtype": "flat",
            "transaction_type": "buy",
            "price": 24600,
            "currency": "EUR",
            "rooms": 2,
            "bathrooms": 1,
            "built_surface": 76,
            "state": "PUBLISHED",
            "coordinates": {
                "lat": 39.497327652217486,
                "lon": -0.37446511845189434
            }
        }
    ],
    "meta": {
        "endpoint_family": "search",
        "billable": true,
        "page": 1,
        "page_size": 5,
        "total_count": 3634,
        "has_more": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

Not Found

The requested listing was not found. This response is not billable.

Validation Error

A public parameter is invalid, including an unknown transaction_type, property_type or sort_by. This response is not billable.

Service Unavailable

The service could not obtain a complete result from Habitaclia. This response is not billable.

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.