Перейти к основному содержимому

Поиск категорий по ключевым словам

Спецификация OpenAPI
API docs by Redocly

Справочник категорий (2.0)

2GIS API Support: api@2gis.ru URL: https://docs.2gis.com/

Категории

Поиск категорий

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

query Parameters
key
required
string

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

region_id
required
string

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

q
required
string [ 1 .. 400 ] characters

Произвольная поисковая строка.

page
integer
Default: 1

Номер запрашиваемой страницы.

page_size
integer [ 1 .. 50 ]
Default: 20

Количество результатов поиска, выводимых на одной странице.

fields
Array of strings

Дополнительные поля, которые необходимо отобразить в ответе, перечисляются через запятую.
Список доступных полей:

  • items.region_id — уникальный идентификатор проекта;
  • items.is_reviewable_on_flamp — разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru;
  • items.rubrics — массив дочерних категорий;
  • items.rubrics.region_id — идентификатор региона;
  • items.rubrics.is_reviewable_on_flamp — разрешены ли отзывы к организациям этой категории непосредственно на flamp.ru.

locale
string
Examples:
  • locale=ar_AE - Арабский язык для ОАЭ
  • locale=ru_RU - Русский язык для России

Локаль, с которой производится поиск и отдаются результаты.
Список доступных локалей:

  • az_AZ — азербайджанский (Азербайджан);
  • ru_AZ — русский (Азербайджан);
  • hy_AM — армянский (Армения);
  • ru_AM — русский (Армения);
  • en_AM — английский (Армения);
  • ar_BH — арабский (Бахрейн);
  • en_BH — английский (Бахрейн);
  • ru_BY — русский (Беларусь);
  • ka_GE — грузинский (Грузия);
  • ru_GE — русский (Грузия);
  • en_EG — английский (Египет);
  • ar_EG — арабский (Египет);
  • it_IT — итальянский (Италия);
  • en_IQ — английский (Ирак);
  • ar_IQ — арабский (Ирак);
  • kk_KZ — казахский (Казахстан);
  • ru_KZ — русский (Казахстан);
  • en_QA — английский (Катар);
  • ar_QA — арабский (Катар);
  • en_CY — английский (Кипр);
  • es_CL — испанский (Кипр);
  • ky_KG — кыргызский (Кыргызстан);
  • ru_KG — русский (Кыргызстан);
  • en_CN — английский (Китай);
  • zh_CN — китайский (Китай);
  • ru_CN — русский (Китай);
  • en_KW — английский (Кувейт);
  • ar_KW — арабский (Кувейт);
  • en_MA — английский (Марокко);
  • ar_MA — арабский (Марокко);
  • mn_MN — монгольский (Монголия);
  • en_MN — английский (Монголия);
  • en_AE — английский (ОАЭ);
  • ar_AE — арабский (ОАЭ);
  • en_OM — английский (Оман);
  • ar_OM — арабский (Оман);
  • en_RU — английский (Россия);
  • ar_RU — арабский (Россия);
  • es_RU — испанский (Россия);
  • it_RU — итальянский (Россия);
  • ru_RU — русский (Россия);
  • cs_RU — чешский (Россия);
  • en_SA — английский (Саудовская Аравия);
  • ar_SA — арабский (Саудовская Аравия);
  • ru_TJ — русский (Таджикистан);
  • tg_TJ — таджикский (Таджикистан);
  • en_TH — английский (Таиланд);
  • ru_UZ — русский (Узбекистан);
  • uz_UZ — узбекский (Узбекистан);
  • cs_CZ — чешский (Чехия).

Responses

Response Schema:
required
object (ObjMeta)

Метаданные ответа

required
object

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

Response samples

Content type
{
  • "meta": {
    • "code": 200,
    • "api_version": "dev",
    • "issue_date": "string"
    },
  • "result": {
    • "items": [
      ],
    • "total": 1
    }
}