Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.hostreach.io/llms.txt

Use this file to discover all available pages before exploring further.

​
What is Hostreach?

Hostreach is a real-estate automation platform that lets you extract leads from property portals, manage a CRM pipeline, send WhatsApp outreach, generate property valuations and fichas, and schedule appointments — all through a single API.

​
Platform capabilities

ModuleWhat you can do
ExtractionsExtract leads from Idealista, Fotocasa, Metrocuadrado, Inmuebles24, Zonaprop and more
CampaignsSchedule recurring extractions and WhatsApp outreach sequences
LeadsManage lead pipeline: status updates, notes, CSV export
MessagingSend WhatsApp messages and templates; read conversation history
ValuationsGenerate automated price estimates with comparable properties
FichasCreate branded property sheets from listing URLs
SchedulingManage bookable event types and appointments
WebhooksSubscribe to events: extraction.completed, leads.imported, lead.status_updated

​
Async pattern

Most write operations that involve external data sources are asynchronous. The API returns a 202 Accepted with a resource id, and you poll until the job is complete. 
POST /extractions      →  202 { extractionId, status: "QUEUED" }
GET  /extractions/:id  →  poll every 5–10s until status = "COMPLETED" | "FAILED"
GET  /extractions/:id/leads  →  paginated leads once COMPLETED
You can avoid polling by subscribing to webhook events instead.

Quickstart

Make your first API call in under 5 minutes.

Authentication

Learn how API keys work and how to manage scopes.