Текстовый поиск региона

Описание

GET /{version}/geo/suggest

Возвращает список регионов, подходящих под заданные условия поиска.

Можно задать поиск по полному или частичному названию региона. В случае указания частичного названия в выходных данных возвращается список регионов, название которых начинается с этого частичного названия.

Ресурс является списочным.

URL ресурса:

https://api.content.market.yandex.ru/{version}/geo/suggest

Входные данные

Параметр Положе­ние Тип Обяза­тельность Описание
version PATH Enum Да

Версия API.

name_part QUERY String Да

Полное или частичное название региона

fields QUERY Enum list Нет

Параметры региона, которые необходимо включить в выдачу

Возможные значения:
  • DECLENSIONS — Название региона в разных падежах
  • PARENT — Родительский регион.
Псевдонимы значений:
  • ALL = Все значения
    Примечание. Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS.
format QUERY Enum Нет

Формат выходных данных.

Возможные значения:
  • JSON — выходные данные будут сформированы в формате JSON.
  • XML — выходные данные будут сформированы в формате XML.
Значение по умолчанию: JSON .
types QUERY Enum list Нет

Тип региона.

Возможные значения:
  • AIRPORT — аэропорт.
  • CITY — город.
  • CITY_DISTRICT — район города.
  • CONTINENT — континент.
  • COUNTRY — страна.
  • COUNTRY_DISTRICT — федеральный округ.
  • METRO_STATION — станиция метро.
  • MONORAIL_STATION — станция монорельса.
  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).
  • REGION — регион.
  • RURAL_SETTLEMENT — сельское поселение.
  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).
  • SUBJECT_FEDERATION — субъект федерации.
  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.
  • VILLAGE — село.
Псевдонимы значений:
  • ALL = Все значения
Значение по умолчанию: CITY, CITY_DISTRICT, REGION, RURAL_SETTLEMENT, SECONDARY_DISTRICT, VILLAGE.
Параметры страницы
count QUERY Int32 Нет

Размер страницы (количество элементов на странице).

Ограничения:
  • Минимальное значение: 1, максимальное значение: 30

Значение по умолчанию: 10.
page QUERY Int32 Нет

Номер страницы.

Ограничения:
  • Минимальное значение: 1

Значение по умолчанию: 1.

Выходные данные

Структура выходных данных приведена ниже. Порядок следования параметров не гарантируется.

{
  "context" : {
    "region" : {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        Содержимое объекта
      }
    },
    "currency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "alternateCurrency" : {
      "id" : "{string}",
      "name" : "{string}"
    },
    "page" : {
      "number" : {int32},
      "count" : {int32},
      "total" : {int32},
      "last" : {boolean}
    },
    "warnings" : [
      {
        "type" : "{string}",
        "code" : "{string}",
        "message" : "{string}"
      },
      ...
    ],
    "id" : "{string}",
    "time" : "{date}",
    "link" : "{string}",
    "marketUrl" : "{string}"
  },
  "suggests" : [
    {
      "id" : {int32},
      "name" : "{string}",
      "type" : "{enum}",
      "childCount" : {int32},
      "country" : {
        "id" : {int32},
        "name" : "{string}",
        "type" : "{enum}",
        "childCount" : {int32},
        "country" : {
          Содержимое объекта
        },
        "parent" : {
          Содержимое объекта
        },
        "nameAccusative" : "{string}",
        "nameGenitive" : "{string}"
      },
      "parent" : {
        "id" : {int32},
        "name" : "{string}",
        "type" : "{enum}",
        "childCount" : {int32},
        "country" : {
          Содержимое объекта
        },
        "parent" : {
          Содержимое объекта
        },
        "nameAccusative" : "{string}",
        "nameGenitive" : "{string}"
      },
      "fullName" : "{string}",
      "nameAccusative" : "{string}",
      "nameGenitive" : "{string}"
    },
    ...
  ],
  "status" : "{enum}"
}

Описание параметров:

Параметр для формата JSON Параметр для формата XML Тип Описание
status status

Enum

Статус обработки запроса.

Возможные значения:
  • OK — операция выполнена успешно.

  • ERROR — произошла ошибка.

context context

Object

Контекст обработки запроса.

suggests suggests

Object list

Список регионов в результате поиска по частичному или полному наименованию

result-context-v2 Параметры, вложенные в context
id id

String

Уникальный идентификатор запроса.

time time

Date

Дата и время выполнения запроса в формате ISO 8601.

link link

String

Ссылка на текущий запрос.

marketUrl marketUrl

String

Ссылка на Яндекс.Маркет.

region region

Object

Информация о регионе запроса.

currency currency

Object

Валюта запроса.

alternateCurrency alternateCurrency

Object

Альтернативная валюта запроса.

page page

Object

Информация о параметрах страницы запроса.

warnings warnings

Object list

Список предупреждений, возникших при обработке запроса.

Предупреждение может быть связано с некритичной ошибкой, позволяющей продолжить обработку запроса. При этом результат может частично не соответствовать параметрам запроса.

region-v2 Параметры, вложенные в context/region
id id

Int32

Идентификатор региона.

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

country country

Object

Страна, к которой относится регион.

Регион

currency-v2 Параметры, вложенные в context/currency, context/alternateCurrency
id id

String

Код валюты.

name name

String

Название валюты.

page-info Параметры, вложенные в context/page
number number

Int32

Номер страницы.

count count

Int32

Размер страницы.

total total

Int32

Количество страниц в результате.

last last

Boolean

Признак последней страницы.

warning Параметры, вложенные в context/warnings
type type

String

Тип предупрежедния.

code code

String

Код предупреждения.

message message

String

Сообщение с описанием предупреждения.

geo-suggest Параметры, вложенные в suggests
id id

Int32

Идентификатор региона.

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

fullName fullName

String

Полное наименование региона

nameAccusative nameAccusative

String

Наименование региона в винительном падеже.

nameGenitive nameGenitive

String

Наименование региона в родительном падеже.

country country

Object

Страна, к которой относится регион.

parent parent

Object

Родительский регион

region-v2 Параметры, вложенные в suggests/country, suggests/parent
id id

Int32

Идентификатор региона.

name name

String

Наименование региона.

type type

Enum

Тип региона.

Возможные значения:
  • CONTINENT — континент.

  • REGION — регион.

  • COUNTRY — страна.

  • COUNTRY_DISTRICT — федеральный округ.

  • SUBJECT_FEDERATION — субъект федерации.

  • CITY — город.

  • VILLAGE — село.

  • CITY_DISTRICT — район города.

  • METRO_STATION — станиция метро.

  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.

  • AIRPORT — аэропорт.

  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).

  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).

  • MONORAIL_STATION — станция монорельса.

  • RURAL_SETTLEMENT — сельское поселение.

  • OTHER — другой тип населенного пункта.

childCount childCount

Int32

Количество дочерних регионов.

nameAccusative nameAccusative

String

Наименование региона в винительном падеже.

nameGenitive nameGenitive

String

Наименование региона в родительном падеже.

country country

Object

Страна, к которой относится регион.

Регион

parent parent

Object

Родительский регион

Регион

Возможные ошибки

В случае возникновения ошибочной ситуации сервер возвращает HTTP-статус ответа и сообщение об ошибке. Описание ошибок приведено в разделе Сообщения об ошибках.