Resolve Homegate locations by name (autocomplete) or by a comma-separated geo id list. Each result carries the id, type, multilingual names, url names, centre coordinates, child ids and the public search url. Feed url_names.en back into the search endpoint as the location parameter. Unknown ids answer a non-billable 404.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
5 optional filters available.
string
Optional
Search term (city, district or postal code). One of name or ids is required. Example: zurich.
zurich
string
Optional
Comma-separated Homegate geo ids. Example: geo-city-zurich.
example
string
Optional
Result language: de, en, fr or it. Defaults to en.
en
integer
Optional
Offset for name results. Defaults to 0.
10
integer
Optional
Results per page for name lookup. Defaults to 10.
3
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/homegate/locations?name=zurich&lang=en&size=3",
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/homegate/locations?name=zurich&lang=en&size=3');
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/homegate/locations?name=zurich&lang=en&size=3', 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/homegate/locations?name=zurich&lang=en&size=3',
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/homegate/locations?name=zurich&lang=en&size=3")
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/homegate/locations?name=zurich&lang=en&size=3", 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/homegate/locations?name=zurich&lang=en&size=3', 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/homegate/locations?name=zurich&lang=en&size=3")
.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/homegate/locations?name=zurich&lang=en&size=3", 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/homegate/locations?name=zurich&lang=en&size=3"
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/homegate/locations?name=zurich&lang=en&size=3"));
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/homegate/locations?name=zurich&lang=en&size=3',
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/homegate/locations?name=zurich&lang=en&size=3")
.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": {
"query": {
"name": "zurich"
},
"pagination": {
"from": 0,
"size": 3,
"total": 75
},
"results": [
{
"id": "geo-city-zurich",
"type": "place",
"names": {
"de": [
"Z\u00fcrich"
],
"en": [
"Zurich"
],
"fr": [
"Zurich"
],
"it": [
"Zurigo"
]
},
"url_names": {
"en": "city-zurich",
"de": "ort-zuerich",
"fr": "lieu-zurich",
"it": "luogo-zurigo"
},
"center": {
"lat": 47.377194615088676,
"lon": 8.539285808314094
},
"children": [
"geo-zipcode-8001",
"geo-zipcode-8002"
],
"url": "https://www.homegate.ch/rent/real-estate/city-zurich/matching-list"
}
]
},
"meta": {
"endpoint_family": "locations",
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Validation Error
Neither name nor ids was supplied. This response is not billable.
{
"errors": {
"name": [
"Provide a name to search, or an ids list to resolve."
]
},
"message": "The request validation failed"
}Location Not Found
None of the supplied ids resolved to a location. This response is not billable.
{
"meta": {
"billable": false,
"retryable": false,
"endpoint_family": "locations"
},
"error": {
"code": "NOT_FOUND",
"message": "The requested Homegate resource was not found."
},
"success": false
}Upstream Unavailable
Homegate is temporarily unreachable, blocked the request, or answered a shape we could not parse. Retry later; this response is not billable.
{
"meta": {
"billable": false,
"retryable": true,
"endpoint_family": "locations"
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "Homegate 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.