Skip to main content
POST
Start a lead extraction

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