Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

Запрос

Для пользователей подсказок DaData.ru:

Без форматирования
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Token ${API_KEY}" \
  -d '{ "query": "москва серпуховская" }' \
  https://dadata.ru/api/v2/suggest/address

Для пользователей standalone-подсказок:

Без форматирования
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{ "query": "москва серпуховская" }' \
  http://ВАШ_СЕРВЕР:ПОРТ/suggestions/api/4_1/rs/suggest/address

Заголовки

ЗаголовокОписание
Content-Type

Тип данных в запроосе: application/json или application/xml

Accept
Тип данных в ответе: application/json или application/xml
Authorization

API-ключ в формате: Token ${API_KEY}

Только для пользователей подсказок DaData.ru

Параметры

ПараметрОбязательный?Описание
queryдаЗапрос, для которого нужно получить подсказки
count
нетКоличество возвращаемых подсказок (если не указано, используется значение по умолчанию).
locations
нетОграничение области поиска.

Ответ

Возвращается список объектов адреса:

Раскрыть
titleПоказать

Включить страницу
Объект адреса
Объект адреса

Примеры

Запрос

Блок кода
languagejavascript
{
  "query": "москва серпуховская" 
}

Ответ:

Раскрыть
titleПоказать
Блок кода
languagejs
{
    "suggestions": [
        {
            "value": "г Москва, Серпуховская пл",
            "unrestricted_value": "г Москва, Серпуховская пл",
            "data": {
                "qc_complete": null,
                "qc_house": null,
                "postal_code": "115184",
                "postal_box": null,
                "country": "Россия",
                "region_type": "г",
                "region_type_full": "город",
                "region": "Москва",
                "area_type": null,
                "area_type_full": null,
                "area": null,
                "city_type": null,
                "city_type_full": null,
                "city": null,
                "settlement_type": null,
                "settlement_type_full": null,
                "settlement": null,
                "street_type": "пл",
                "street_type_full": "площадь",
                "street": "Серпуховская",
                "house_type": null,
                "house_type_full": null,
                "house": null,
                "block_type": null,
                "block": null,
                "flat_area": null,
                "flat_type": null,
                "flat": null,
                "tax_office": "7705",
                "kladr_id": "77000000000702000",
                "okato": "45286560000",
                "oktmo": null,
                "unparsed_parts": null,
                "qc": null
            }
        },
        {
            "value": "г Москва, ул Серпуховская Б.",
            "unrestricted_value": "г Москва, ул Серпуховская Б.",
            "data": {
                "qc_complete": null,
                "qc_house": null,
                "postal_code": "115093",
                "postal_box": null,
                "country": "Россия",
                "region_type": "г",
                "region_type_full": "город",
                "region": "Москва",
                "area_type": null,
                "area_type_full": null,
                "area": null,
                "city_type": null,
                "city_type_full": null,
                "city": null,
                "settlement_type": null,
                "settlement_type_full": null,
                "settlement": null,
                "street_type": "ул",
                "street_type_full": "улица",
                "street": "Серпуховская Б.",
                "house_type": null,
                "house_type_full": null,
                "house": null,
                "block_type": null,
                "block": null,
                "flat_area": null,
                "flat_type": null,
                "flat": null,
                "tax_office": "",
                "kladr_id": "77000000000262500",
                "okato": "",
                "oktmo": null,
                "unparsed_parts": null,
                "qc": null
            }
        },
        {
            "value": "г Москва, пл Серпуховская Застава",
            "unrestricted_value": "г Москва, пл Серпуховская Застава",
            "data": {
                "qc_complete": null,
                "qc_house": null,
                "postal_code": "115191",
                "postal_box": null,
                "country": "Россия",
                "region_type": "г",
                "region_type_full": "город",
                "region": "Москва",
                "area_type": null,
                "area_type_full": null,
                "area": null,
                "city_type": null,
                "city_type_full": null,
                "city": null,
                "settlement_type": null,
                "settlement_type_full": null,
                "settlement": null,
                "street_type": "пл",
                "street_type_full": "площадь",
                "street": "Серпуховская Застава",
                "house_type": null,
                "house_type_full": null,
                "house": null,
                "block_type": null,
                "block": null,
                "flat_area": null,
                "flat_type": null,
                "flat": null,
                "tax_office": "7725",
                "kladr_id": "77000000000262600",
                "okato": "45296559000",
                "oktmo": null,
                "unparsed_parts": null,
                "qc": null
            }
        }
  ]
}

 

Запрос:

Блок кода
languagehtml/xml
<req>
  <query>москва серпуховская</query>
</req>

Ответ:

Раскрыть
titleПоказать
Блок кода
languagehtml/xml
<SuggestAddressResponse>
    <suggestions>
        <value>г Москва, Серпуховская пл</value>
        <unrestricted_value>г Москва, Серпуховская пл</unrestricted_value>
        <data>
            <qc_complete/>
            <qc_house/>
            <postal_code>115184</postal_code>
            <postal_box/>
            <country>Россия</country>
            <region_type>г</region_type>
            <region_type_full>город</region_type_full>
            <region>Москва</region>
            <area_type/>
            <area_type_full/>
            <area/>
            <city_type/>
            <city_type_full/>
            <city/>
            <settlement_type/>
            <settlement_type_full/>
            <settlement/>
            <street_type>пл</street_type>
            <street_type_full>площадь</street_type_full>

Подсказки по адресу (REST)

URL: {base_path}/suggest/address

Метод: POST

Параметры

ПараметрОбязательный?Описание
queryдаСтрока, для которой нужно получить подсказки
count
нетКоличество возвращаемых подсказок (если не указано, используется значение по умолчанию).
locations
нетОграничение области поиска.

В качестве ответа возвращается список объектов адреса.

Дополнительные возможности

Примеры

JSON

Запрос

Блок кода
languagejavascript
{
  "query": "москв серпуховская" 
}

Ответ:

Блок кода
languagejavascript
titleПример ответа для query=москва%20серпуховская, кодировка UTF-8
{ "suggestions": [ {

            
"data": {
<street>Серпуховская</street>
            <house_type/>
      
"postal_code":
 
"115093",
     <house_type_full/>
           
"country": "Россия",
 <house/>
            <block_type/>
      
"region_type":
 
"г",
     <block/>
           
"region": "Москва",
 <flat_area/>
            <flat_type/>
    
"area_type":
 
null,
       <flat/>
         
"area":
 
null,
  <tax_office>7705</tax_office>
            <kladr_id>77000000000702000</kladr_id>
  
"city_type":
 
null,
         <okato>45286560000</okato>
       
"city":
 
null,
    <oktmo/>
            
"settlement_type": null,
<unparsed_parts/>
            <qc/>
    
"settlement":
 
null,
   </data>
    </suggestions>
    <suggestions>
     
"street_type":
 
"ул",
  <value>г Москва, ул Серпуховская Б.</value>
        <unrestricted_value>г 
"street": "
Москва, ул Серпуховская Б.
",
</unrestricted_value>
        <data>
        
"house_type":
 
null,
   <qc_complete/>
            
"house": null,
<qc_house/>
            
"kladr_id": "77000000000262500",
<postal_code>115093</postal_code>
            
"okato": null
<postal_box/>
            
},
<country>Россия</country>
            
"value": "Россия г Москва ул Серпуховская Б."
<region_type>г</region_type>
            
},
<region_type_full>город</region_type_full>
        
{
    <region>Москва</region>
        
"data":
 
{
   <area_type/>
            
"postal_code": "115184",
<area_type_full/>
            <area/>
       
"country":
 
"Россия",
    <city_type/>
            
"region
<city_type
": "г",
_full/>
            <city/>
      
"region": "Москва",
      <settlement_type/>
            
"area
<settlement_type
": null,
_full/>
            <settlement/>
       
"area":
 
null,
    <street_type>ул</street_type>
            
"city_type": null,
<street_type_full>улица</street_type_full>
            <street>Серпуховская Б.</street>
         
"city":
 
null,
  <house_type/>
            
"settlement
<house_type
": null,
_full/>
            <house/>
    
"settlement":
 
null,
       <block_type/>
         
"street_type":
 
"пл",
  <block/>
            
"street": "Серпуховская",
<flat_area/>
            <flat_type/>
      
"house_type":
 
null,
     <flat/>
           
"house": null,
 <tax_office></tax_office>
            <kladr_id>77000000000262500</kladr_id>
       
"kladr_id":
 
"77000000000702000",
    <okato></okato>
            
"okato": "45286560000"
<oktmo/>
            
},
<unparsed_parts/>
            
"value": "Россия г Москва пл Серпуховская"
<qc/>
        
}   ] }
XML

Запрос:

Блок кода
languagehtml/xml
<req>
  <query>москв серпуховская</query>
</req>

Ответ:

Блок кода
languagehtml/xml
<SuggestAddressResponse>
</data>
    </suggestions>
    <suggestions>
        
<data>
<value>г Москва, пл Серпуховская Застава</value>
        <unrestricted_value>г Москва, пл Серпуховская 
<postal_code>115093<
Застава</
postal_code>
unrestricted_value>
        <data>
            
<country>Россия<
<qc_complete/
country>
>
            
<region
<qc_
type>г<
house/
region_type>
>
            
<region>Москва</region>
<postal_code>115191</postal_code>
            
<area
<postal_
type
box/>
            
<area
<country>Россия</
>
country>
            
<city
<region_
type
type>г</
>
region_type>
            
<city/>
<region_type_full>город</region_type_full>
            
<settlement_type
<region>Москва</
>
region>
            
<settlement
<area_type/>
            
<street
<area_type_
type>ул<
full/
street_type>
>
            
<street>Серпуховская Б.</street>
<area/>
            
<house
<city_type/>
            
<house
<city_type_full/>
            
<kladr_id>77000000000262500</kladr_id>
<city/>
            
<okato
<settlement_type/>
        
</data>
    <settlement_type_full/>
    
<value>Россия
 
г
 
Москва
 
ул
 
Серпуховская
 
Б.</value>
   
<
<settlement/
suggestions>
>
    
<suggestions>
        
<data>
<street_type>пл</street_type>
            
<postal
<street_type_
code>115184<
full>площадь</
postal
street_type_
code>
full>
            
<country>Россия<
<street>Серпуховская Застава</
country>
street>
            
<region
<house_
type>г<
type/
region_type>
>
            
<region>Москва</region>
<house_type_full/>
            
<area_type
<house/>
            
<area
<block_type/>
            
<city_type
<block/>
            
<city
<flat_area/>
            
<settlement
<flat_type/>
            
<settlement
<flat/>
            
<street
<tax_
type>пл<
office>7725</
street
tax_
type>
office>
            
<street>Серпуховская</street>
<kladr_id>77000000000262600</kladr_id>
            
<house_type
<okato>45296559000</
>
okato>
            
<house
<oktmo/>
            
<kladr
<unparsed_
id>77000000000702000<
parts/
kladr_id>
>
            
<okato>45286560000<
<qc/
okato>
>
        </data>
<value>Россия г Москва пл Серпуховская</value>

    </suggestions>
</SuggestAddressResponse>