/yandexrealty/offers/search

POST /api/yandexrealty/offers/search

Price: 20 credits

Search Yandex Realty offers (listings) in a region by deal type (buy/rent/daily rent), property type (apartment/room/house/lot/garage/commercial), market (secondary/new building) and a full set of real estate filters: rooms, price, total/living/kitchen area, floor, building year, ceiling height, wall material, renovation, decoration, bathroom layout, building class, metro, balcony, parking, furniture, no agent fee / no commission (rentals), photos and virtual tour. Returns offer cards with price, area, rooms, floor, address, metro, photos, tags and the seller.

How to use it

Search Yandex Realty offers. region is the site region slug ('moskva', 'sankt-peterburg', 'moskva_i_moskovskaya_oblast'); deal_type selects buy/rent/daily rent; property_type selects the object kind; market (secondary/new building) applies to apartments; rooms, price_min/max, area_min/max, living_space_min/max, kitchen_space_min, floor_min/max, not_first_floor, not_last_floor, built_year_min/max, ceiling_height_min, building_type, renovation, decoration, bathroom_unit, building_class, metro_id, has_balcony, has_parking, has_furniture, no_agent_fee, no_commission, has_photo, has_virtual_tour and sort are optional filters. Each result has the same fields as the offer get-by-id endpoint (id, url, price, area, rooms_total, floor, address, metro, images, tags, author, etc).

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)
• deal_type string — Deal type (default: "kupit"; one of: "kupit", "snyat", "snyat/posutochno")
• property_type string — Property type (default: "kvartira"; one of: "kvartira", "komnata", "dom", "uchastok", "garazh", "kommercheskaya-nedvizhimost")
• market string nullable — Market type for apartments (secondary or new building) (one of: "vtorichniy-rynok", "novostroyki")
• rooms string nullable — Number of rooms (one of: "STUDIO", "1", "2", "3", "PLUS_4")
• 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)
• living_space_min number nullable — Minimum living area in square meters (min: 0)
• living_space_max number nullable — Maximum living area in square meters (min: 0)
• kitchen_space_min number nullable — Minimum kitchen area in square meters (min: 0)
• floor_min integer nullable — Minimum floor (min: 0)
• floor_max integer nullable — Maximum floor (min: 0)
• not_first_floor boolean nullable — Exclude first floor offers
• not_last_floor boolean nullable — Exclude last floor offers
• built_year_min integer nullable — Minimum building construction year (min: 0)
• built_year_max integer nullable — Maximum building construction year (min: 0)
• ceiling_height_min number nullable — Minimum ceiling height in meters (min: 0)
• building_type string nullable — Building wall material (one of: "BRICK", "MONOLIT", "PANEL", "BLOCK", "MONOLIT_BRICK", "WOOD", "FERROCONCRETE", "STALIN")
• renovation string nullable — Renovation / finishing state (one of: "COSMETIC_DONE", "DESIGNER_RENOVATION", "EURO", "NEEDS_RENOVATION", "NON_GRANDMOTHER", "GRANDMOTHER", "PRIMARY_FINISHING", "ROUGH")
• decoration string nullable — New building decoration / finishing level (one of: "ROUGH", "CLEAN", "TURNKEY", "NO_DECORATION", "PRE_CLEAN", "WHITE_BOX")
• bathroom_unit string nullable — Bathroom layout (one of: "MATCHED", "SEPARATED", "TWO_AND_MORE")
• building_class string nullable — Building class (for new buildings) (one of: "ECONOM", "COMFORT", "COMFORT_PLUS", "BUSINESS", "ELITE")
• metro_id integer nullable — Metro station geo id to search near (min: 0)
• has_balcony boolean nullable — Only offers with a balcony or loggia
• has_parking boolean nullable — Only offers with parking
• has_furniture boolean nullable — Only rentals with furniture
• no_agent_fee boolean nullable — Only rentals without an agent fee
• no_commission boolean nullable — Only rentals without a commission
• has_photo boolean nullable — Only offers with photos
• has_virtual_tour boolean nullable — Only offers with a 3D virtual tour
• sort string — Result sort order (default: "RELEVANCE"; one of: "RELEVANCE", "PRICE", "PRICE_DESC", "PRICE_PER_SQUARE", "AREA", "AREA_DESC", "DATE_DESC", "FLOOR", "FLOOR_DESC")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "YandexrealtyOffer")
• id string required
• url string nullable
• offer_type string nullable
• offer_category string nullable
• flat_type string nullable
• deal_status string nullable
• trust string nullable
• description string nullable
• created_at string nullable
• updated_at string nullable
• price integer nullable
• price_per_meter integer nullable
• currency string nullable
• price_trend string nullable
• rooms_total integer nullable
• area number nullable
• living_space number nullable
• kitchen_space number nullable
• room_spaces array (default: [])
• ceiling_height number nullable
• floor integer nullable
• floors_total integer nullable
• renovation string nullable
• bathroom_unit string nullable
• balcony_type string nullable
• window_view string nullable
• is_apartments boolean nullable
• is_open_plan boolean nullable
• is_new_building boolean nullable
• is_exclusive boolean nullable
• built_year integer nullable
• building_type string nullable
• building_series string nullable
• building_id string nullable
• flats_count integer nullable
• porches_count integer nullable
• parking_type string nullable
• address string nullable
• latitude number nullable
• longitude number nullable
• metro object nullable
  • @type string (default: "YandexrealtyMetro")
  • name string required
  • transport string nullable
  • time_to_metro integer nullable
  • line_color string nullable
• metro_list array (default: [])
  • @type string (default: "YandexrealtyMetro")
  • name string required
  • transport string nullable
  • time_to_metro integer nullable
  • line_color string nullable
• rgid integer nullable
• view_count integer nullable
• has_lift boolean nullable
• has_rubbish_chute boolean nullable
• is_guarded boolean nullable
• has_security boolean nullable
• has_internet boolean nullable
• image string nullable
• images array (default: [])
• image_count integer nullable
• tags array (default: [])
• author object nullable
  • @type string (default: "YandexrealtyOfferAuthor")
  • id string nullable
  • category string nullable
  • name string nullable
  • organization string nullable
  • agent_name string nullable
  • image string nullable
  • created_at string nullable
• price_history array (default: [])
  • @type string (default: "YandexrealtyPricePoint")
  • date string nullable
  • value 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 — Region not found or no offers 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.