> ## 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.

# Introduction

> Automate real-estate lead generation, CRM, and WhatsApp outreach with the Hostreach API.

## 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

| Module          | What you can do                                                                       |
| --------------- | ------------------------------------------------------------------------------------- |
| **Extractions** | Extract leads from Idealista, Fotocasa, Metrocuadrado, Inmuebles24, Zonaprop and more |
| **Campaigns**   | Schedule recurring extractions and WhatsApp outreach sequences                        |
| **Leads**       | Manage lead pipeline: status updates, notes, CSV export                               |
| **Messaging**   | Send WhatsApp messages and templates; read conversation history                       |
| **Valuations**  | Generate automated price estimates with comparable properties                         |
| **Fichas**      | Create branded property sheets from listing URLs                                      |
| **Scheduling**  | Manage bookable event types and appointments                                          |
| **Webhooks**    | Subscribe 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.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Make your first API call in under 5 minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn how API keys work and how to manage scopes.
  </Card>
</CardGroup>