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

Habitaclia Listing API Documentation

GET https://scrappa.co/api/habitaclia/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5

Returns the full record for one listing, addressed by the ad_id UUID from a search or publisher item. The record carries the complete description, the postal address, the publisher, the price history, the energy certificate and the media sets (images, videos, virtual tours and documents; a floor plan is a document with type FLOOR_PLAN). An unknown id answers a 404 with error.code NOT_FOUND, which is not billable.

Habitaclia Listing API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/habitaclia/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5
Auth header
x-api-key
Cost
1 credit/request
id = 82d1e398-a167-465a-bfe9-465afb9197d5
Response preview
200 OK
{
    "success": true,
    "data": {
        "ad_id": "82d1e398-a167-465a-bfe9-465afb9197d5",
        "legacy_id": "i55824000002922",
        "url": "https://www.habitaclia.com/i55824000002922.htm",
        "reference": "VIRIA-13",
        "property_type": "flat",
        "property_subtype": "flat",
        "transaction_type": "buy",
        "price": 545000,
        "currency": "EUR",
        "rooms": 2,
        "bathrooms": 2,
...

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.

id string Required

The ad_id UUID from a search or publisher item, for example 82d1e398-a167-465a-bfe9-465afb9197d5.

Example value 82d1e398-a167-465a-bfe9-465afb9197d5

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/habitaclia/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5",
    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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5');

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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5', 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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5',
    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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5")
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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5", 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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5', 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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5")
        .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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5", 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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5"
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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5"));
            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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5',
            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/listing?id=82d1e398-a167-465a-bfe9-465afb9197d5")
        .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
JSON Response
200 OK
{
    "success": true,
    "data": {
        "ad_id": "82d1e398-a167-465a-bfe9-465afb9197d5",
        "legacy_id": "i55824000002922",
        "url": "https://www.habitaclia.com/i55824000002922.htm",
        "reference": "VIRIA-13",
        "property_type": "flat",
        "property_subtype": "flat",
        "transaction_type": "buy",
        "price": 545000,
        "currency": "EUR",
        "rooms": 2,
        "bathrooms": 2,
        "built_surface": 94,
        "state": "PUBLISHED",
        "publisher": {
            "id": "7f0a4bc7-bae1-483f-a90d-0b94dcf276aa",
            "name": "AEDAS HOMES",
            "trade_name": "AEDAS HOMES"
        },
        "created_at": "2026-09-22T08:46:03Z"
    },
    "meta": {
        "endpoint_family": "listing",
        "billable": 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.