Skip to main content
POST
/
public
/
v1
/
extractions
Start a lead extraction
curl --request POST \
  --url https://api.hostreach.io/v1/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>"
}
'

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.

Authorizations

​
X-Api-Key
string
header
required

API key (hr_live_... or hr_test_...). Generate from Settings › Workspace › Acceso API.

Body

application/json
​
platform
enum<string>
required

Real-estate portal to extract leads from. Use GET /platforms to list supported portals and GET /platforms/{platform}/filters to discover the filter schema.

Available options:
idealista,
fotocasa,
metrocuadrado,
inmuebles24,
zonaprop
Example:

"idealista"

​
filters
object
required

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.

Example:
{
  "operation": "rent",
  "location": {
    "id": "0-EU-ES-VC-46-46250-999-2-009",
    "label": "Valencia"
  }
}
​
maxResults
number
default:50

Maximum number of leads to extract. Default: 50.

Required range: x >= 1
Example:

100

​
options
any

Advanced extraction options.

Response

202 - undefined