/hemnet/brokers/search

POST /api/hemnet/brokers/search

Price: 1 credit

Search Hemnet real estate brokers (mäklare) and broker agencies (mäklarkontor) — by area (location ids) with the number of sales in the area and configurable sorting, or by broker name. Returns broker/agency cards with name, total sales, sales in the searched area, primary agency, logo and profile url.

How to use it

Search Hemnet brokers or broker agencies. Two modes: area search (location_ids — numeric Hemnet location ids, resolve free text via hemnet/locations/search — plus type broker/agency, optional radius, and sort by last_sale / sales_in_area / total_sales / name) or name search (name). Each result has id, type (broker/agency), name, alias, sale_count (total), sale_count_in_area (for area search), profile_url, image and agency (for brokers: id, name, alias, sale_count).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• location_ids array nullable — Hemnet numeric location ids for area search (resolve free text via hemnet/locations/search) (examples: ["17744"])
• name string nullable — Search brokers by name instead of by area (minLength: 1)
• type string — Search individual brokers or broker agencies (area search only) (default: "broker"; one of: "broker", "agency")
• radius string nullable — Expand the area search by this radius (one of: "1", "2", "5", "10", "15", "30", "50", "100")
• sort string — Result ordering (area search only) (default: "last_sale"; one of: "last_sale", "sales_in_area", "total_sales", "name_asc", "name_desc")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "HemnetBrokerResult")
• id string required
• type string required
• name string nullable
• alias string nullable
• sale_count integer nullable
• sale_count_in_area integer nullable
• profile_url string nullable
• image string nullable
• agency object nullable
  • @type string (default: "HemnetBrokerAgencyRef")
  • id string nullable
  • name string nullable
  • alias string nullable
  • sale_count integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.