Перейти к содержанию

Получение значений справочника

Получение значений справочника по его названию. Поддерживает пагинацию и поиск.

URL

Метод: GET

  • Production: https://registry.wallet.kvell.group/reg2/dictionary/{name}

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

Название Тип данных Обязательно Описание
name string Да Название справочника (banks, regions, currencies, countries, okved)

Query параметры

Название Тип данных Обязательно Описание
search string Нет Строка поиска по значениям справочника
limit integer Нет Количество записей на странице (по умолчанию 20)
offset integer Нет Смещение для пагинации

Пример запроса

GET https://registry.wallet.kvell.group/reg2/dictionary/{name}?search=%D1%81%D0%B1%D0%B5%D1%80%D0%B1%D0%B0%D0%BD%D0%BA&limit=20&offset=0

Заголовки запроса

Название Тип данных Обязательно Описание
X-Api-Key string Да Уникальный идентификатор (UUID)

Ответ запроса

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

{
  "success": true,
  "data": {
    "name": "banks",
    "total": 342,
    "limit": 20,
    "offset": 0,
    "items": [
      {
        "bik": "044525225",
        "name": "ПАО Сбербанк",
        "corrAccount": "30101810400000000225",
        "city": "Москва",
        "address": "117997, г. Москва, ул. Вавилова, д. 19"
      },
      {
        "bik": "044525593",
        "name": "АО Альфа-Банк",
        "corrAccount": "30101810200000000593",
        "city": "Москва",
        "address": "107078, г. Москва, ул. Каланчевская, д. 27"
      }
    ]
  }
}