Поиск рубрик

Осуществляет поиск рубрик по ключевым словам

URL: http://catalog.api.2gis.ru/2.0/catalog/rubric/search

Параметры запроса

Параметр Обязательное Тип Описание
key Да Строка

Уникальный ключ пользователя API.

Пример: 1234567890.

region_id Да Строка

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

Пример: 1

q Да. Не менее 2-х символов и не более 400 Строка Произвольная поисковая строка.
is_commercial Нет Булев

Отображать или нет рекламные рубрики.

Принимает значения - true или false

page_size Нет Число

Максимальное количество результатов на запрашиваемой странице. По умолчанию 10. Ограничение: от 1 до 10.

format Нет Строка Формат ответа. Может принимать значения:
  • xml
  • json
  • jsonp
По умолчанию используется json.
callback Нет Строка

Название callback функции для jsonp-запроса. Ограничение: последовательность латинских букв, цифр и знака подчеркивания. Максимальная длина названия callback функции — 128 символов. В случае неправильного задания отобразится ошибка в формате json.

Пример: myCallback

locale Нет Строка Локаль на которой отдавать результат. Возможные значения:
  • cs_CZ
  • en_CY
  • es_CL
  • it_IT
  • ru_RU
  • ru_KZ
  • ru_UA
  • en_AE
  • ar_AE
  • ru_KG
  • uk_UA
По умолчанию используется ru_RU.

Параметры ответа

Параметр Тип Описание
meta* Структура

Общая информация об ответе

result* Структура

Основной результат

Общая информация об ответе (meta)
Параметр Тип Описание
code* Целое число

Код ответа API. Подробнее см. Коды ответов

Основной результат (result)
Параметр Тип Описание
total* Целое число

Количество найденных объектов

items* Массив структур

Массив найденных объектов

Массив найденных объектов (items)
Параметр Тип Описание
keyword* Строка

Ключевое слово, по которому была найдена рубрика

Примеры:

  • Молочный шоколад

id* Строка

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

Примеры:

  • 4503719886454906

type* Строка

Допустимые значения:

  • rubric — рубрика
  • general_rubric — объединяющая рубрика

name* Строка

Название рубрики.

Примеры:

  • Аварийные службы

alias* Строка

Транслитерированное название рубрики.

Примеры:

  • avarijjnye_sluzhby

parent_id* Строка

Идентификатор родительской рубрики.

Примеры:

  • 4503719886460203

org_count* Целое число

Количество организаций в данной рубрике.

Примеры:

  • 10

branch_count* Целое число

Количество филиалов организаций в данной рубрике.

Примеры:

  • 25

Примеры

  • Выбрать все рубрики для региона по ключевому слову "авто"

    Запрос:

    http://catalog.api.2gis.ru/2.0/catalog/rubric/search?region_id=1&q=авто&key=1234567890

    Ответ: