Skip to main content
POST
/
api
/
yandexrealty
/
sites
/
search
/yandexrealty/sites/search
curl --request POST \
  --url https://api.anysite.io/api/yandexrealty/sites/search \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "region": "<string>",
  "count": 2,
  "timeout": 300,
  "price_min": 1,
  "price_max": 1,
  "area_min": 1,
  "area_max": 1,
  "built_year_max": 1,
  "metro_id": 1,
  "developer_id": 1,
  "has_finished_apartments": true,
  "sort": "RELEVANCE"
}
'
[
  {
    "id": "<string>",
    "@type": "@yandexrealty_site_search_result",
    "url": "<string>",
    "name": "<string>",
    "full_name": "<string>",
    "description": "<string>",
    "building_class": "<string>",
    "state": "<string>",
    "has_virtual_tour": true,
    "price_from": 123,
    "price_to": 123,
    "developer_id": "<string>",
    "developer_name": "<string>",
    "address": "<string>",
    "rgid": 123,
    "metro": {
      "name": "<string>",
      "@type": "@yandexrealty_site_search_metro",
      "transport": "<string>",
      "time_to_metro": 123
    },
    "review_count": 123,
    "review_rating": 123,
    "image": "<string>",
    "images": []
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
region
string
required

Region path slug as used on the site, e.g. 'moskva', 'sankt-peterburg', 'moskva_i_moskovskaya_oblast'

Minimum string length: 1
Examples:

"moskva"

"sankt-peterburg"

"moskva_i_moskovskaya_oblast"

​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
price_min
integer | null

Minimum price

Required range: x >= 0
​
price_max
integer | null

Maximum price

Required range: x >= 0
​
area_min
number | null

Minimum total area in square meters

Required range: x >= 0
​
area_max
number | null

Maximum total area in square meters

Required range: x >= 0
​
building_class
enum<string> | null

Building class of the new building

Available options:
ECONOM,
COMFORT,
COMFORT_PLUS,
BUSINESS,
ELITE
​
built_year_max
integer | null

Maximum (latest) commissioning year of the building

Required range: x >= 0
​
metro_id
integer | null

Metro station geo id to search near

Required range: x >= 0
​
developer_id
integer | null

Filter by developer id

Required range: x >= 0
​
has_finished_apartments
boolean | null

Only buildings with finished (move-in ready) apartments

​
sort
enum<string>
default:RELEVANCE

Result sort order

Available options:
RELEVANCE,
PRICE,
PRICE_DESC,
COMMISSIONING_DATE

Response

Successful Response

​
id
string
required
​
@type
string
default:@yandexrealty_site_search_result
​
url
string | null
​
name
string | null
​
full_name
string | null
​
description
string | null
​
building_class
string | null
​
state
string | null
​
has_virtual_tour
boolean | null
​
price_from
integer | null
​
price_to
integer | null
​
developer_id
string | null
​
developer_name
string | null
​
address
string | null
​
rgid
integer | null
​
metro
YandexrealtySiteSearchMetro · object
​
review_count
integer | null
​
review_rating
number | null
​
image
string | null
​
images
string[]