Чтобы искать адреса только в определенном регионе или городе, укажите их в параметре locations. Можно указать несколько ограничений.
Ограничение по КЛАДР-коду
...
Сахалинская область:
| Блок кода |
|---|
{
"query": "Ватутина",
"locations": [{
"kladr_id": "65"
}]
} |
Ограничение по коду ФИАС
Возможные ограничения:
- region_fias_id – ограничение по ФИАС коду региона
- area_fias_id – ограничение по ФИАС коду области
- city_fias_id – ограничение по ФИАС коду города
- settlement_fias_id – ограничение по ФИАС коду населенного пункта
- street_fias_id – ограничение по ФИАС коду улицы
г Пушкин:
| Блок кода |
|---|
{
"query": "московское шоссе",
"locations": [{
"city_fias_id": "110d6ad9-0b64-47cf-a2ee-7e935228799c"
}]
} |
Ограничение по названию адресного объекта
Москва:
| Блок кода |
|---|
{
"query": "Ботаническая",
"locations": [{
"region": "москва"
}]
} |
...
| Блок кода |
|---|
{
"query": "ростов рассветная",
"locations": [{
"region": "адыгея"
}, {
"region": "астраханская"
}, {
"region": "волгоградская"
}, {
"region": "калмыкия"
}, {
"region": "краснодарский"
}, {
"region": "ростовская"
}]
} |
...
| Блок кода |
|---|
{
"query": "Абрикосовая",
"locations": [{
"region": "Самарская",
"city": "Тольятти"
}]
} |
...
| Включить страницу |
|---|
| Ограничение по КЛАДР-коду |
|---|
| Ограничение по КЛАДР-коду |
|---|
|
Ограничение по ФИАС-коду
| Включить страницу |
|---|
| Ограничение по ФИАС-коду |
|---|
| Ограничение по ФИАС-коду |
|---|
|
Ограничение по названию адресного объекта
| Включить страницу |
|---|
| Ограничение по названию адресного объекта |
|---|
| Ограничение по названию адресного объекта |
|---|
|
Ограничение по типу объекта
| Включить страницу |
|---|
| Ограничение по типу объекта |
|---|
| Ограничение по типу объекта |
|---|
|
Ограничение по стране
| Включить страницу |
|---|
| Ограничение по стране |
|---|
| Ограничение по стране |
|---|
|
Ограничение по ISO-коду
| Включить страницу |
|---|
| Ограничение по ISO-коду |
|---|
| Ограничение по ISO-коду |
|---|
|
...
Чтобы адрес одной строкой в ответе (поле value) не содержал регион / город, заданный в ограничении, добавьте параметр restrict_value = true:
| Блок кода |
|---|
{
"query": "Турчанинов",
"locations": [
{
"region": "Москва"
}
],
"restrict_value": true
} |
Ответ:
| Блок кода |
|---|
{
"suggestions": [
{
"value": "Турчанинов пер",
"unrestricted_value": "г Москва, Турчанинов пер",
"data": {
...
}
},
{
"value": "Турчанинов пер, д 2",
"unrestricted_value": "г Москва, Турчанинов пер, д 2",
"data": {
...
}
},
{
"value": "Турчанинов пер, д 2А",
"unrestricted_value": "г Москва, Турчанинов пер, д 2А",
"data": {
...
}
},
{
"value": "Турчанинов пер, д 3 стр 1",
"unrestricted_value": "г Москва, Турчанинов пер, д 3 стр 1",
"data": {
...
}
}
]
} |
При этом полный адрес тоже возвращается, в поле unrestricted_value.
Ограничение по типу объекта
Возможные ограничения:
- street_type_full — ограничение по полному типу улицы;
- settlement_type_full — типу населенного пункта;
- city_district_type_full — типу района города;
- city_type_full — типу города;
- area_type_full — типу района в регионе;
- region_type_full — типу региона.
| Блок кода |
|---|
|
{
"query":"башко",
"locations": [
{
"region_type_full": "республика"
}
]
} |
Ограничение по стране
По умолчанию подсказываются только адреса в России. Для поиска по другим странам, в запросе следует указывать ограничения:
- country – название страны;
- country_iso_code – код страны в стандарте ISO 3166 (начиная с версии 19.7).
| Блок кода |
|---|
{
"query": "брест",
"locations": [
{
"country": "Беларусь"
},
{
"country": "Франция"
}
]
} |
| Блок кода |
|---|
| title | Начиная с версии 19.7 |
|---|
|
{
"query": "брест",
"locations": [
{
"country_iso_code": "BY"
},
{
"country_iso_code": "FR"
}
]
} |
Для поиска по всем странам следует указать спецсимвол — звёздочку:
| Блок кода |
|---|
{
"query": "берлин",
"locations": [
{
"country": "*"
}
]
} |
| Блок кода |
|---|
| title | Начиная с версии 19.7 |
|---|
|
{
"query": "париж",
"locations": [
{
"country_iso_code": "*"
}
]
} |
Ограничение по ISO-коду
Если подключены подсказки по всем странам мира, а не только по России, то удобно использовать ISO-коды, чтобы сузить область поиска.
Например, ISO-код страны:
| Блок кода |
|---|
{
"query": "бр",
"locations": [
{
"country_iso_code": "BY"
}
]
} |
Или страны и региона:
...
Ограничение по радиусу окружности
| Включить страницу |
|---|
| Ограничение по радиусу окружности (API) |
|---|
| Ограничение по радиусу окружности (API) |
|---|
|