Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Чтобы искать адреса только в определенном регионе или городе, укажите их в параметре locations.Можно  Можно указать массив ограничений. Каждый объект-ограничение в параметре locations может содержать поля  kladr_idfias_idpostal_code, countryregion area citysettlement или street .несколько ограничений.

Table of Contents

Ограничение по КЛАДР-коду

...

Сахалинская область:

Code Block
{
    "query": "Ватутина",
    "locations": [{
        "kladr_id": "65"
    }]
}

Ограничение по коду ФИАС

Возможные ограничения:

  • region_fias_id – ограничение по ФИАС коду региона
  • area_fias_id – ограничение по ФИАС коду области
  • city_fias_id – ограничение по ФИАС коду города
  • settlement_fias_id – ограничение по ФИАС коду населенного пункта
  • street_fias_id – ограничение по ФИАС коду улицы

г Пушкин:

Code Block
{
    "query": "московское шоссе",
    "locations": [{
        "city_fias_id": "110d6ad9-0b64-47cf-a2ee-7e935228799c"
    }]
}

Ограничение по названию адресного объекта

Москва:

Code Block
{
    "query": "Ботаническая",
    "locations": [{
        "region": "москва"
    }]
}

...

Code Block
{
    "query": "ростов рассветная",
    "locations": [{
        "region": "адыгея"
    }, {
        "region": "астраханская"
    }, {
        "region": "волгоградская"
    }, {
        "region": "калмыкия"
    }, {
        "region": "краснодарский"
    }, {
        "region": "ростовская"
    }]
}

...

Code Block
{
    "query": "Абрикосовая",
    "locations": [{
        "region": "Самарская",
        "city": "Тольятти"
    }]
}

...

Чтобы адрес одной строкой в ответе (поле value) не содержал регион / город, заданный в ограничении, добавьте параметр restrict_value = true:

Code Block
{
  "query": "Турчанинов",
  "locations": [
    {
      "region": "Москва"      
    }
  ],
  "restrict_value": true
}

Ответ:

Code Block
{
    "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   типу региона.
Code Block
titleЗапрос
{
	"query":"башко", 
	"locations": [
		{
			"region_type_full": "республика"
		}
	]
}

Ограничение по стране

По умолчанию подсказываются только адреса в России. Для поиска по другим странам, в запросе следует указывать ограничения:

  • country – название страны;
  • country_iso_code – код страны в стандарте ISO 3166 (начиная с версии 19.7).
Code Block
{
    "query": "брест", 
    "locations": [
        {
            "country": "Беларусь"
        },
        {
            "country": "Франция"
        }
    ]
}
Code Block
titleНачиная с версии 19.7
{
	"query": "брест", 
	"locations": [
		{
			"country_iso_code": "BY"
		},
		{
            "country_iso_code": "FR"
        }

	]
}

Для поиска по всем странам следует указать спецсимвол — звёздочку:

Code Block
{
    "query": "берлин", 
    "locations": [
        {
            "country": "*"
        }
    ]
}
Code Block
titleНачиная с версии 19.7
{
    "query": "париж", 
    "locations": [
        {
            "country_iso_code": "*"
        }
    ]
}

Ограничение по ISO-коду

Если подключены подсказки по всем странам мира, а не только по России, то удобно использовать ISO-коды, чтобы сузить область поиска.

Например, ISO-код страны:

Code Block
{
    "query": "бр", 
    "locations": [
        {
            "country_iso_code": "BY"
        }
    ]
}

Или страны и региона:

Code Block
{
    "query": "бр", 
    "locations": [
        {
            "country_iso_code": "BY",
            "region_iso_code": "BY-BR"
        }
    ]
}

Include Page
Ограничение по КЛАДР-коду
Ограничение по КЛАДР-коду

Ограничение по ФИАС-коду

Include Page
Ограничение по ФИАС-коду
Ограничение по ФИАС-коду

Ограничение по названию адресного объекта

Include Page
Ограничение по названию адресного объекта
Ограничение по названию адресного объекта

Ограничение по типу объекта

Include Page
Ограничение по типу объекта
Ограничение по типу объекта

Ограничение по стране

Include Page
Ограничение по стране
Ограничение по стране

Ограничение по ISO-коду

Include Page
Ограничение по ISO-коду
Ограничение по ISO-коду

Ограничение по радиусу окружности

Include Page
Ограничение по радиусу окружности (API)
Ограничение по радиусу окружности (API)