Общие положения

Префикс URL для всех запросов: https://opendata.mkrf.ru/v2

HTTP метод всех запросов: GET, формат ответов: JSON

Для успешного выполнения необходимо в HTTP headers запросов передавать заголовок X-API-KEY содержащий выданный ключ. Ключ можно получить, пройдя бесплатную регистрацию на этой странице

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

Получить список наборов
Показать результаты запросаСкрыть результаты запроса
Curl
curl -X GET -H 'Accept: application/json' -H 'X-API-KEY: YOUR_API_KEY_HERE' '%prefix%%url%'
Request URL
%prefix%%url%
Response Body
%result%
%name%
%title%
Версия может быть указана следующими способами
  • числовым номером из поля version метаданных версии
  • идентификатором c префиксом @, например @583363b3cfd69c6b301b455f
  • $, $last - wildcard для последней доступной версии
  • $first - первая версия в указанной схеме
Получить список версий
Показать результаты запросаСкрыть результаты запроса
Версия %version%
ОписаниеОператорЗначениеПараметрТип записи
%description%%name%%type%
Response Class (Status %answer_code%)
%answer_text%
Пример данныхЗапрос возвращает 1 произвольный документ из выбранной версии набора данных
СхемаСодержит метаданные и JsonSchema документ, описывающий документы выбранной версии.
ИндексыЗапрос возвращает список полей в схеме, по которым возможен поиск и сортировка.
ТаблицаЗапрос возвращает информацию полях, отображаемых в колонках таблицы “человеко-ориентированного” представления
СвязиОбщие по семантике поля различных наборов данных объединяются в общий индекс. Таким образом, становится возможным сквозной поиск по семантике по всем наборам данных, где это поле присутствует. Данный запрос возвращает список связанных полей в выбранной схеме.
%parameters_table%
Сортировка
По возрастаниюПо убыванию
Ограничения выдачи
Показать возможные коды ответаСкрыть возможные коды ответа
HTTP Status CodeПричинаОписаниеТип параметраТип записи
200Операция успешна
400Некорректный запрос
401Некорректный ключ авторизации
404Объект не найден на сервере
500Ошибка сервера
501Сервис не реализован
502Ошибка обработчика API
503Превышен лимит на частоту запросов
Выполнить запрос
Показать результаты запросаСкрыть результаты запроса