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

Habitaclia Locations API Documentation

GET https://scrappa.co/api/habitaclia/locations?query=Valencia&transaction_type=buy&property_type=flat

Resolve a place name to the code and layer_id that /search expects. Returns a JSON array of matches, each with the place code, name, layer_id (11 province, 14 zone, 20 municipality, 26 street) and the live listing count. property_type is required upstream and the call answers a 400 without it. An unknown place name returns an empty array, which is a successful, billable response.

Habitaclia Locations API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/habitaclia/locations?query=Valencia&transaction_type=buy&property_type=flat
Auth header
x-api-key
Cost
1 credit/request
query = Valencia property_type = flat
Response preview
200 OK
{
    "success": true,
    "data": [
        {
            "code": "46250",
            "name": "Valencia, Valencia",
            "layer_id": 20,
            "count": 3588
        },
        {
            "code": "46",
            "name": "Valencia",
            "layer_id": 11,
            "count": 17064
...

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.

1 optional filter available.

query string Required

Place name to resolve, for example Valencia.

Example value Valencia
property_type string Required

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

Example value flat
transaction_type string Optional

buy or rent. Refines the listing counts.

Example value buy

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/habitaclia/locations?query=Valencia&transaction_type=buy&property_type=flat",
    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/locations?query=Valencia&transaction_type=buy&property_type=flat');

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/locations?query=Valencia&transaction_type=buy&property_type=flat', 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/locations?query=Valencia&transaction_type=buy&property_type=flat',
    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/locations?query=Valencia&transaction_type=buy&property_type=flat")
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/locations?query=Valencia&transaction_type=buy&property_type=flat", 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/locations?query=Valencia&transaction_type=buy&property_type=flat', 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/locations?query=Valencia&transaction_type=buy&property_type=flat")
        .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/locations?query=Valencia&transaction_type=buy&property_type=flat", 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/locations?query=Valencia&transaction_type=buy&property_type=flat"
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/locations?query=Valencia&transaction_type=buy&property_type=flat"));
            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/locations?query=Valencia&transaction_type=buy&property_type=flat',
            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/locations?query=Valencia&transaction_type=buy&property_type=flat")
        .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

code name layer_id count
JSON Response
200 OK
{
    "success": true,
    "data": [
        {
            "code": "46250",
            "name": "Valencia, Valencia",
            "layer_id": 20,
            "count": 3588
        },
        {
            "code": "46",
            "name": "Valencia",
            "layer_id": 11,
            "count": 17064
        },
        {
            "code": "358",
            "name": "Valencia, Zona de, Valencia",
            "layer_id": 14,
            "count": 3588
        }
    ],
    "meta": {
        "endpoint_family": "locations",
        "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.