/yandexrealty/sites/plans

POST /api/yandexrealty/sites/plans

Price: 20 credits

Get apartment floor plans of a Yandex Realty new building (residential complex) by site id or new building URL: room type and count, whole and living area, price range and price per square meter, available offer count, floors, the plan image and the commissioning date.

How to use it

Fetch the apartment floor plans of a Yandex Realty new building by numeric site id or a new building URL. Each result has id, room_type (STUDIO/1/2/3/PLUS_4/OPEN_PLAN), room_count, whole_area, living_area, price_from, price_to, price_per_meter_from, price_per_meter_to, currency, offer_count, floors, image and commissioning (year, quarter, construction_state).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• site string required — Yandex Realty new building (site) id or a new building URL containing it (examples: "375274", "https://realty.yandex.ru/moskva/kupit/novostrojka/salarevo-park-375274/"; minLength: 1)
• count integer required — Max number of floor plans to return (min: 1)

Response

• @type string (default: "YandexrealtySitePlan")
• id string required
• room_type string nullable
• room_count integer nullable
• whole_area number nullable
• living_area number nullable
• price_from integer nullable
• price_to integer nullable
• price_per_meter_from integer nullable
• price_per_meter_to integer nullable
• currency string nullable
• offer_count integer nullable
• floors array (default: [])
• image string nullable
• commissioning object nullable
  • @type string (default: "YandexrealtySitePlanCommissioning")
  • year integer nullable
  • quarter integer nullable
  • construction_state string 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 — New building not found (well-formed but nonexistent site id) 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.