curl --request POST \
--url https://api.hostreach.io/v2/public/v1/extractions \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"platform": "idealista",
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46-46250-999-2-009",
"label": "Valencia"
}
},
"maxResults": 100,
"options": "<unknown>"
}
'import requests
url = "https://api.hostreach.io/v2/public/v1/extractions"
payload = {
"platform": "idealista",
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46-46250-999-2-009",
"label": "Valencia"
}
},
"maxResults": 100,
"options": "<unknown>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platform: 'idealista',
filters: {
operation: 'rent',
location: {id: '0-EU-ES-VC-46-46250-999-2-009', label: 'Valencia'}
},
maxResults: 100,
options: '<unknown>'
})
};
fetch('https://api.hostreach.io/v2/public/v1/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hostreach.io/v2/public/v1/extractions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'platform' => 'idealista',
'filters' => [
'operation' => 'rent',
'location' => [
'id' => '0-EU-ES-VC-46-46250-999-2-009',
'label' => 'Valencia'
]
],
'maxResults' => 100,
'options' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hostreach.io/v2/public/v1/extractions"
payload := strings.NewReader("{\n \"platform\": \"idealista\",\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46-46250-999-2-009\",\n \"label\": \"Valencia\"\n }\n },\n \"maxResults\": 100,\n \"options\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hostreach.io/v2/public/v1/extractions")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platform\": \"idealista\",\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46-46250-999-2-009\",\n \"label\": \"Valencia\"\n }\n },\n \"maxResults\": 100,\n \"options\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hostreach.io/v2/public/v1/extractions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platform\": \"idealista\",\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46-46250-999-2-009\",\n \"label\": \"Valencia\"\n }\n },\n \"maxResults\": 100,\n \"options\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_bodyStart a lead extraction
Starts an asynchronous lead extraction on a real-estate portal. Returns immediately with extractionId and status: QUEUED.
Polling pattern: call GET /extractions/{id} every 5–10 s until status is COMPLETED or FAILED. Alternatively, subscribe to the extraction.completed webhook event.
Use GET /platforms to list supported portals and GET /platforms/{platform}/filters to discover filter keys.
curl --request POST \
--url https://api.hostreach.io/v2/public/v1/extractions \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"platform": "idealista",
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46-46250-999-2-009",
"label": "Valencia"
}
},
"maxResults": 100,
"options": "<unknown>"
}
'import requests
url = "https://api.hostreach.io/v2/public/v1/extractions"
payload = {
"platform": "idealista",
"filters": {
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46-46250-999-2-009",
"label": "Valencia"
}
},
"maxResults": 100,
"options": "<unknown>"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
platform: 'idealista',
filters: {
operation: 'rent',
location: {id: '0-EU-ES-VC-46-46250-999-2-009', label: 'Valencia'}
},
maxResults: 100,
options: '<unknown>'
})
};
fetch('https://api.hostreach.io/v2/public/v1/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hostreach.io/v2/public/v1/extractions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'platform' => 'idealista',
'filters' => [
'operation' => 'rent',
'location' => [
'id' => '0-EU-ES-VC-46-46250-999-2-009',
'label' => 'Valencia'
]
],
'maxResults' => 100,
'options' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hostreach.io/v2/public/v1/extractions"
payload := strings.NewReader("{\n \"platform\": \"idealista\",\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46-46250-999-2-009\",\n \"label\": \"Valencia\"\n }\n },\n \"maxResults\": 100,\n \"options\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hostreach.io/v2/public/v1/extractions")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"platform\": \"idealista\",\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46-46250-999-2-009\",\n \"label\": \"Valencia\"\n }\n },\n \"maxResults\": 100,\n \"options\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hostreach.io/v2/public/v1/extractions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"platform\": \"idealista\",\n \"filters\": {\n \"operation\": \"rent\",\n \"location\": {\n \"id\": \"0-EU-ES-VC-46-46250-999-2-009\",\n \"label\": \"Valencia\"\n }\n },\n \"maxResults\": 100,\n \"options\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.
Body
Real-estate portal to extract leads from. Use GET /platforms to list supported portals and GET /platforms/{platform}/filters to discover the filter schema.
idealista, fotocasa, metrocuadrado, inmuebles24, zonaprop "idealista"
Platform-specific filter object. Required keys vary by portal — use GET /platforms/{platform}/filters to discover them. Typical fields: operation (rent|sale), location (object from /platforms/{platform}/locations), propertyType, minPrice, maxPrice, minRooms.
{
"operation": "rent",
"location": {
"id": "0-EU-ES-VC-46-46250-999-2-009",
"label": "Valencia"
}
}
Maximum number of leads to extract. Default: 50.
x >= 1100
Advanced extraction options.
Response
Was this page helpful?