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

Zonaprop Location Tree

GET https://scrappa.co/api/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694

Returns the location tree for a search context, so you can list every neighbourhood or zone inside a province without hardcoding slugs. Pass a parent location id to walk down the tree. Results are cached for speed, and a response served from the cache costs nothing: data.cached tells you which one you got.

Zonaprop Location Tree 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694
Auth header
x-api-key
Cost
1 credit/request
onboarding_searcher = 1
Response preview
200 OK
{
    "success": true,
    "data": {
        "popular_locations": [],
        "all_locations": [],
        "cached": false
    }
}

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.

2 optional filters available.

onboarding_searcher integer Required

Required. The search context whose location tree you want.

Example value 1
real_estate_type integer Optional

Restrict the tree to one property type.

Example value 2
location string Optional

Walk down from this location id.

Example value V1-C-1003694

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694",
    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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694');

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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694', 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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694',
    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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694")
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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694", 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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694', 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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694")
        .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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694", 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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694"
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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694"));
            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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694',
            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/zonaprop/locations?onboarding_searcher=1&real_estate_type=2&location=V1-C-1003694")
        .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
JSON Response
200 OK
{
    "success": true,
    "data": {
        "popular_locations": [],
        "all_locations": [],
        "cached": false
    }
}

Errors

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

Not Found

No Zonaprop posting or location matches that id. This response is not billable.

Validation Error

A parameter is invalid, including an unknown operation, property type, currency or sort value. Invalid enum values are rejected here rather than upstream, because upstream answers them with an empty result. This response is not billable.

Upstream Unavailable

Zonaprop did not return a usable result for this read. This response is not billable.

Service Unavailable

The upstream service is temporarily unavailable. Please retry shortly.

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.