/yandexrealty/sites/search

POST /api/yandexrealty/sites/search

Price: 20 credits

Search Yandex Realty new buildings (residential complexes) in a region with optional filters: price, total area, building class, commissioning year, metro, developer and finished-apartments availability. Returns new building cards with name, developer, price range, building class, construction state, address, metro, review rating and photos.

How to use it

Search Yandex Realty new buildings. region is the site region slug ('moskva', 'sankt-peterburg', 'moskva_i_moskovskaya_oblast'); price_min/max, area_min/max, building_class, built_year_max, metro_id, developer_id and has_finished_apartments are optional filters. Each result has id, url, name, full_name, description, building_class, state, has_virtual_tour, price_from, price_to, developer_id, developer_name, address, rgid, metro (name, transport, time_to_metro), review_count, review_rating, image and images.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• region string required — Region path slug as used on the site, e.g. 'moskva', 'sankt-peterburg', 'moskva_i_moskovskaya_oblast' (examples: "moskva", "sankt-peterburg", "moskva_i_moskovskaya_oblast"; minLength: 1)
• price_min integer nullable — Minimum price (min: 0)
• price_max integer nullable — Maximum price (min: 0)
• area_min number nullable — Minimum total area in square meters (min: 0)
• area_max number nullable — Maximum total area in square meters (min: 0)
• building_class string nullable — Building class of the new building (one of: "ECONOM", "COMFORT", "COMFORT_PLUS", "BUSINESS", "ELITE")
• built_year_max integer nullable — Maximum (latest) commissioning year of the building (min: 0)
• metro_id integer nullable — Metro station geo id to search near (min: 0)
• developer_id integer nullable — Filter by developer id (min: 0)
• has_finished_apartments boolean nullable — Only buildings with finished (move-in ready) apartments
• sort string — Result sort order (default: "RELEVANCE"; one of: "RELEVANCE", "PRICE", "PRICE_DESC", "COMMISSIONING_DATE")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "YandexrealtySiteSearchResult")
• id string required
• url string nullable
• name string nullable
• full_name string nullable
• description string nullable
• building_class string nullable
• state string nullable
• has_virtual_tour boolean nullable
• price_from integer nullable
• price_to integer nullable
• developer_id string nullable
• developer_name string nullable
• address string nullable
• rgid integer nullable
• metro object nullable
  • @type string (default: "YandexrealtySiteSearchMetro")
  • name string required
  • transport string nullable
  • time_to_metro integer nullable
• review_count integer nullable
• review_rating number nullable
• image string nullable
• images array (default: [])

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 — Region not found or no new buildings match the given region/filters 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.