Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 19 Next »

Чтобы искать адреса только в определенном регионе или городе, укажите их в параметре locations.

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

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

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

{
    "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": "Тольятти"
    }]
}


Адрес без региона и города

Чтобы адрес одной строкой в ответе (поле 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": "Франция"
        }
    ]
}
Начиная с версии 19.7
{
	"query": "брест", 
	"locations": [
		{
			"country_iso_code": "BY"
		},
		{
            "country_iso_code": "FR"
        }

	]
}


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

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