Доступ к API
Для успешного вызова методов API необходимы:
Корректные заголовки Accept и Content-Type. API поддерживает только один
MIME-тип: application/json. Любое другое значение приведет к ошибке формата
данных.
URL, составленный согласно требованиям к нужному запросу.
OAuth-токен, выданный вам для доступа к API. Полученный токен следует
передавать в заголовке Authorization при каждом вызове API, указывая тип токена
Bearer перед его значением. Пример получения такого заголовка:
1. Вы запрашиваете токен у обслуживающей организации, в ответ на email придет токен,
представляющий собой строку:
U1QtOTkwMTAyLWNud3FpdWhmbzg3M
2. Токен добавляется в заголовок
Authorization: Bearer
3. Итоговый заголовок, добавляемый в каждый запрос к API:
Authorization: Bearer U1QtOTkwMTAyLWNud3FpdWhmbzg3M
Методы API
даны для Интернет версии.
Все методы API полность доступны в Интернет версии в рамках своих
ограничений(ниже).
Замечания для версии Проксима
1. Для Проксимы базовый адрес совпадает с адресом вашего сервера с добавлением
методов будет http://proxima.local/api
2. Для вызова методов API не используется аутентификация, но что бы ими
воспользоваться необходимо завести в Проксиме юзера с логином api и пустым паролем.
3. Для Проксимы header Authorization не является обязательным.
4. В версии Проксима доступен только поиск, а в версии Проксима с базой внутренних
документов (БВД) дополнительно доступны экспорт и информация о документе.
Ограничения
1. Для Интернет версии на вызовы методов накладываются следующие ограничения:
количество запросов по методам Простановка ссылок, Документы на контроле и
Фрагменты на контроле не может суммарно превышать 1000 за календарный месяц
нельзя экспортировать более 30 документов и/или фрагментов за календарный
месяц
поставить на контроль можно не более 100 документов за один вызов
размер текста для простановки ссылок не может превышать 20Мб
в методе Лента ПРАЙМ нельзя запросить новости старше одного года
количество запросов по методу Информация о документе не может превышать 300
за календарный месяц
Поиск
Позволяет провести поиск по документам в комплекте, с которым связан токен
аутентификации.
Запрос
POST
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры обязательны,
кроме isQuery и page. Строковые значения передаются в кодировке UTF-8.
Параметр
Тип
Описание
text
String
Поисковая фраза, не более 16Кб
Необязательный параметр. Если указан со
значением true, то текст введенный в поле text
рассматривается как запрос оформленный на
специальной языке запросов (см. примеры
ниже)
isQuery
Boolean
Номер страницы с результатами поиска,
начинается с единицы. Если отсутствует, то
возвращается первая страница. Размер
страницы постоянен и равен 50 элементам.
page
env
Integer
String
Комплект, на котором необходимо выполнить
поиск, может принимать значения:
internet - Основной комплект системы
ГАРАНТ
arbitr - Банк судебной практики
sort
Integer
Integer
Значение для сортировки:
0 - по степени соответствия
1 - по дате документа
2 - по дате последнего изменения
3 - по юридической силе
sortOrder
Направление сортировки:
0 - по убыванию (для даты это означает
от свежей к более старой)
1 - по возрастанию
Пример:
{
}
"text": "44-фз о контрактной системе",
"page": 1,
"env": "internet",
"sort": 0,
"sortOrder": 0
Ответ
Успешный JSON-ответ содержит список найденных документов. Или пустой список если
ничего не найдено.
Параметр
Тип
Описание
documents
Object Array
String
Массив найденных документов
Имя документа
documents[].name
documents[].url
String
Относительная ссылка на документ, чтобы
получить абсолютную ссылку нужно
свой адрес сервера, если вызов
выполняется через API ГАРАНТ
Интранет-версии
Внутренний номер документа, который
может быть использован в других
функциях API, например в Экспорт
документа
documents[].topic
totalPages
Integer
Integer
Общее количество страниц по 50
элементов в результатах поиска
Номер запрошенной страницы с
результатами поиска
page
Integer
Integer
totalDocs
Общее количество найденных документов
Пример:
{
"totalPages": 17183,
"documents": [
{
"url": "/#/document/70353464",
"topic": 70353464,
"name": "Федеральный закон от 5 апреля 2013 г. N 44-ФЗ О
контрактной системе в сфере закупок товаров, работ, услуг для обеспечения
государственных и муниципальных нужд (с изменениями и дополнениями)"
},
...
{
"url": "/#/document/77519493",
"topic": 77519493,
"name": "Обзор основных изменений в Федеральном законе от 5 апреля
2013 г. N 44-ФЗ О контрактной системе в сфере закупок товаров, работ, услуг
для обеспечения государственных и муниципальных нужд - 2024 (подготовлено
экспертами компании Гарант)"
}
],
"page": 1,
"totalDocs": 859105
}
Получение вхождений
Метод используется что бы получить номера блоков в конкретном документе,
соответствующие заданному запросу. В дальнейшем номера блоков можно будет
использовать для получения их текста методом Экспорт блока (html) или для того
чтобы контролировать их изменение методом Фрагменты на контроле.
Запрос
POST
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры обязательны, за
исключением text и correspondent (из них должно быть задано только что-то одно, если
задано несколько, то будет возвращения ошибка 400 (Bad Request)). Строковые значения
передаются в кодировке UTF-8.
Параметр
text
Тип
String
Описание
Поисковая фраза
Объект, содержащий атрибуты места в документа,
упоминания которого надо найти в документе,
заданным параметром topic
correspondent
Object
correspondent.topic
correspondent.entry
Number
Number
Номер документа
Номер блока в документе
Номер документа, из которого нужно получить
вхождения
topic
Number
Пример запроса для вхождений соответствующих запросу в документе с номером
57742222:
{
"text": "44-фз о контрактной системе",
"topic": 57742222
}
Пример запроса для вхождений из документа с номером 10900200, которые ссылаются на
документ с номером 12125267 и номером блока 150:
{
"correspondent": {
"topic": 12125267,
"entry": 150
},
"topic": 10900200
}
Ответ
Успешный JSON-ответ содержит список вхождений, соответствующих условиям запроса.
Параметр
snippets
snippets[].relevance String
Тип
Описание
Array
Массив вхождений по порядку следования в тексте.
Значение релевантности в диапазоне от 0 до 1,
означает насколько текст блока удовлетворяет
поисковому критерию, заданному текстом в параметре
text.
Номер блока, в котором находятся найденные
вхождения (одно или несколько)
snippets[].entry
Number
Список элементов оглавления, в которые входит текст
вхождения. Список отсортирован по уровню, т.е. В
начале Часть, потом Раздел, Глава и так далее
snippets[].ancestors
Object
Array
Номер структурного блока, соответствующего элементу
оглавления
ancestors[].entry
ancestors[].title
Number
String
Текст заголовка элемента оглавления. Может быть
пустым ("")
Ниже приведен пример ответа при запросе вхождений, удовлетворяющих поисковой
фразе. Ответ на запрос вхождений, ссылающихся на нужный документ, отличается от
приведенного только отсутствием поля snippets[].relevance - оно не имеет смысл при
таком запросе.
{
"snippets": [
{
"relevance": "0.99",
"entry": 1000,
"ancestors": [
{"entry": 1, "title": "Часть первая"},
{"entry": 10, "title": "Раздел I. Общие положения"},
{"entry": 100, "title": "Глава 1. Основные начала трудового
законодательства"},
{"entry": 1000, "title": "Статья 2. Основные принципы
правового регулирования трудовых отношений и иных непосредственно связанных
с ними отношений"}
]
},
{
"relevance": "0.5",
"entry": 1001,
"ancestors": [
{"entry": 1, "title": "Часть третья"},
{"entry": 10, "title": "Раздел V. Время отдыха"},
{"entry": 1000, "title": "Глава 18. Перерывы в работе.
Выходные и нерабочие праздничные дни"},
{"entry": 1001, "title": "Статья 111. Выходные дни"}
]
}
]
}
Простановка ссылок
Позволяет найти и расставить ссылки на нормативные документы в переданном
фрагменте текста.
Запрос
POST
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры, обязательны.
Строковые значения передаются в кодировке UTF-8.
Параметр Тип
Описание
Фрагмент текста в формате plain text или html. Не более
20Мб
text
String
Базовая часть url для создания ссылки. Например, можно
для свободного доступа к документам по ссылке
baseUrl
String
Пример:
{
"text": "Настоящий Закон в соответствии с Федеральным законом от 29
декабря 2017 года N 443-ФЗ регулирует отдельные отношения, возникающие в
процессе организации дорожного движения, а также при организации и
осуществлении парковочной деятельности на территории Орловской области.",
"baseUrl": "https://internet.garant.ru"
}
Ответ
Успешный JSON-ответ содержит фрагмент текст, переданного в запросе, в котором
проставлены ссылки на нормативные акты.
Параметр Тип
Описание
text
String Фрагмент текста в формате html, с расставленными ссылкам.
Проставленные ссылки бывают только двух форматов:
документ, где $topic - это внутренний номер документа,
который может быть использован в других функциях API,
например в Экспорте документа.
ссылка на внутренний элемент документа: на раздел,
пункт, статью и т.д.; $sub - это внутренний номер метки,
которая указывает на начало элемента документа.
Пример:
{
"text": "Настоящий Закон в соответствии с <a
href=\"https://internet.garant.ru/#/document/71848756\">Федеральным законом</a>
от 29 декабря 2017 года N 443-ФЗ регулирует отдельные отношения, возникающие в
процессе организации дорожного движения, а также при организации и
осуществлении парковочной деятельности на территории Орловской области."
}
Экспорт документа (rtf)
Позволяет получить текст документа в текстовом формате rtf.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Внутренний номер документа, может быть получен из
функции Поиска
$topic
Integer
Пример cURL:
user@server:~$ curl "https://api.garant.ru/v2/topic/10103000/download"
--header "Authorization: Bearer xxxxYYYYzzzzz"
--output 10103000.rtf
Ответ
В случае успешного ответа файл сохранится на диск.
Экспорт документа (html)
Позволяет получить текст документа формате html (может включать комментарии
юристов Гаранта). В тексте могут содержаться ссылки на картинки или формулы, для
того чтобы дополнительно скачать эти объекты, необходимо распарсить документ,
определить ссылки и воспользоваться методами Экспорт картинки или Экспорт формул.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Внутренний номер документа, может быть получен из
функции Поиска
$topic
Integer
Ответ
Успешный JSON-ответ содержит массив страниц документа.
Параметр
items
Тип
Описание
Object Array Массив страниц документа
items[].number
items[].text
Integer
String
Номер страницы
Текст страницы в формате html
Пример:
{
"items": [{
"number:": 1,
"text": "<p id=\"p_521837163\" class=\"s_3\">Гражданский
кодекс Российской Федерации<br/>..."
},
{
"number:": 2,
"text": "<div class=\"block\"
data-relativeBlockId=\"10000\"><div class=\"block\"..."
}
]
}
Экспорт блока (html)
Метод позволяет получить не весь текст документа, а только интересующего фрагмента,
заданного номером блока, где он расположен. Ответ в формате html может включать
комментарии юристов Гаранта. В тексте могут содержаться ссылки на картинки или
формулы, для того чтобы дополнительно скачать эти объекты, необходимо распарсить
html, определить ссылки и воспользоваться методами Экспорт картинки или Экспорт
формул.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
$topic
Тип
Описание
Number
Number
Номер документа
Номер блока
$entry
Ответ
Успешный ответ содержит текст блока в формате html.
Параметр
Тип
Описание
entry
Number
Номер блока
Массив респондентов из запрашиваемого
блока. Сортировка по номеру документа.
Содержит не более 100 элементов
respondents
Object Array
respondents[].topic
respondents[].entry
Integer
Number
Номер документа
Номер структурного блока, соответствующего
элементу оглавления
Список элементов оглавления, в которые
входит текст блока. Список отсортирован по
уровню, то есть вначале Часть, потом Раздел,
Глава и так далее
ancestors
Object Array
Номер структурного блока, соответствующего
элементу оглавления
ancestors[].entry
Number
Текст заголовка элемента оглавления. Может
быть пустым ("")
ancestors[].title
String
title
text
String
String
Название документа
Текст блока в формате html
Пример:
{
"entry": 1000,
"respondents": [
{"topic": 12345678, "entry": 1000}
],
"ancestors": [
{"entry": 1, "title": "Часть первая"},
{"entry": 10, "title": "Раздел I. Общие положения"},
{"entry": 100, "title": "Глава 1. Основные начала трудового
законодательства"},
{"entry": 1000, "title": "Статья 2. Основные принципы правового
регулирования трудовых отношений и иных непосредственно связанных с ними
отношений"}
],
"title": "Трудовой кодекс Российской Федерации от 30 декабря 2001 г. N
197-ФЗ (ТК РФ)",
"text": "текст_блока"
}
Экспорт картинок
Позволяет получить картинки, содержащиеся в тексте документа в системе ГАРАНТ.
Например, после Экспорта документа в формате html вы видите ссылку вида:
<img class="resized"
src="/document/image?revision=176202554&document_id=409276126&object_id=3657688
6" loading="lazy" data-width="1069" data-height="933" width="580" height="506"
title="" alt="">
Во-первых, по началу ссылки (поле src) можно определить, что это картинка (ссылка
начинает с /document/image), во-вторых, уникальным идентификатором для этой
картинки будет значение параметра object_id в ссылке, то есть 36576886.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Уникальный идентификатор картинки, значение
параметра object_id из ссылке в поле src
$object_id
Number
Пример cURL для ссылки в тексте, приведенной выше:
user@server:~$ curl "https://api.garant.ru/v1/image/36576886"
--header "Authorization: Bearer xxxxYYYYzzzzz"
Ответ
В случае успешного ответа картинка сохраняется на диск.
Экспорт формул
Позволяет получить формулы, содержащиеся в тексте документа в системе ГАРАНТ, в
виде картинки (на данный момент только в формате png). Формула определяется
уникальным кодом, который можно получить только из ссылки на картинку в тексте,
полученному в методе Экспорт документа (html). Например, в тексте расположена ссылка
вида:
<img
src="/document/formula?revision=622024530&text=c3RyaW5nKCkrLXN0cmluZygp&fmt=png
" loading="lazy" title="" alt="" width="18" height="21">
Во-первых, по началу ссылки (поле src) можно определить, что это формула (ссылка
начинается с /document/formula), во-вторых, уникальным кодом для этой формулы будет
значение параметра text в ссылке, то есть “c3RyaW5nKCkrLXN0cmluZygp”.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
String
Описание
Уникальный код формулы, содержится в поле text в
ссылке на формулу
$text
Формат, в котором вы хотите получить картинку. На
$fmt
String
данный момент поддерживается только значение png.
Пример cURL для ссылки в тексте, приведенной выше:
user@server:~$ curl
"https://api.garant.ru/v2/formula?text=c3RyaW5nKCkrLXN0cmluZygp&fmt=png"
--header "Authorization: Bearer xxxxYYYYzzzzz"
Ответ
В случае успешного ответа картинка для формулы сохраняется на диск.
Экспорт документа (odt)
Позволяет получить текст документа в текстовом формате odt.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Внутренний номер документа, может быть получен из
функции Поиска
$topic
Integer
Пример cURL:
user@server:~$ curl "https://api.garant.ru/v2/topic/10103000/download-odt"
--header "Authorization: Bearer xxxxYYYYzzzzz"
Ответ
В случае успешного ответа файл сохранится на диск.
Экспорт документа (pdf)
Позволяет получить текст документа в текстовом формате pdf.
Запрос
GET
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Внутренний номер документа, может быть получен из
функции Поиска
$topic
Integer
Пример cURL:
user@server:~$ curl "https://api.garant.ru/v2/topic/10103000/download-pdf"
--header "Authorization: Bearer xxxxYYYYzzzzz"
Ответ
В случае успешного ответа файл сохранится на диск.
Документы на контроле
Позволяет определить наличие изменений в тексте нормативного документа, начиная с
указанной даты. Также, может вернуть ленту событий в документе, которые происходили
с документом в системе ГАРАНТ с заданной даты.
Запрос
POST
HEADERS:
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры обязательны,
кроме needEvents. Строковые значения передаются в кодировке UTF-8.
Параметр
Тип
Описание
Массив номеров документов, для которых
надо проверить наличие изменений. Не
больше 100 номеров в одном запросе. Если
больше 100, вернется код ошибки 400
topics
Number Array
modDate
String Date
Дата, начиная с которой будут проверяться
переданные документов на наличие
изменений.
Формат даты ГГГГ-ММ-ДД.
Не может быть ранее 01.01.2018.
true - выводить события, false - не выводить.
Если не задан, то используется значение
false.
needEvents Boolean
Пример:
{
"topics": [77682742, 45069704, 49054494],
"modDate": "2019-07-01",
"needEvents": true
}
Ответ
Успешный JSON-ответ содержит массив документов из запроса, но только те, в которых
произошли изменения.
Параметр
topics
Тип
Описание
Array
Number
Массив документов из запроса
Номер документа
topics[].topic
topics[].modStatus
Number
Статус изменения:
1 - изменился
2 - не найден
events
Object Array
String
Список событий документа
events[].date
Дата события в формате ГГГГ-ММ-ДД
events[].type
Number
Тип события:
1 - Документ утратил силу
2 - Документ изменен
3 - Документ вступил в силу
4 - У документа появилась новая,
но еще не вступившая в силу
редакция, и она доступна для
просмотра в системе ГАРАНТ
5 - Вступила в силу новая
редакция документа
Пример:
{
"topics": [
{
"topic:": 77682742,
"modStatus": 1,
"events": [
{"date": "2010-03-30", "type": 4},
{"date": "2013-06-15", "type": 5},
{"date": "2023-12-31", "type": 1}
]
}
]
}
Фрагменты на контроле
Позволяет определить наличие изменений во фрагменте текста нормативного документа
начиная с указанной даты. Фрагмент определяется ссылкой, которую можно получить
либо в методе Простановка ссылок, либо в Поиске, либо скопировать из браузера в
открытом документе.
При необходимости метод дополнительно возвращает список событий, произошедших с
документом целиком с указанной даты.
Запрос
POST
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры обязательны,
кроме needEvents.
Параметр
fromDate
Тип
Описание
String Date
Дата, начиная с которой будут проверяться
переданные фрагменты на изменения текста.
Формат даты ГГГГ-ММ-ДД
Не может быть ранее 01.01.2018
Массив ссылок на фрагменты, которые надо
проверить на изменения. Ссылки могут включать
только документы из комплекта Законодательство
России.
urlArray
String Array
Boolean
true - выводить события, false - не выводить. Если
не задан, то используется значение false.
needEvents
Пример:
{
"fromDate": "2019-06-01",
"urlArray": [
]
}
Ответ
Успешный JSON-ответ содержит список ссылок, в которых произошли изменения в
диапазоне с даты, заданной в fromDate, по сегодняшнюю дату.
Параметр
Тип
Описание
Массив ссылок, которые изменялись с
заданной даты
urlArray
Object Array
urlArray[].url
String
Ссылка из запроса
Статус изменения:
urlArray[].modStatus
Integer
1 - изменился
2 - не найден
Список событий, произошедших с
документом целиком с заданной даты
urlArray[].events
Object Array
events[].date
events[].type
String
Дата события в формате ГГГГ-ММ-ДД
Number
Тип события:
1 - Документ утратил силу
2 - Документ изменен
3 - Документ вступил в силу
4 - У документа появилась
новая, но еще не вступившая в
силу редакция, и она доступна
для просмотра в системе ГАРАНТ
5 - Вступила в силу новая
редакция документа
Пример:
{
"urlArray": [{
"modStatus": 1,
"events": [
{"date": "2010-03-30", "type": 4},
{"date": "2013-06-15", "type": 5},
{"date": "2023-12-31", "type": 1}
]
}]
}
Список категорий для Ленты ПРАЙМ
Вернет список тематических категорий, которые можно использовать для уточнения
запроса для формирования Ленты ПРАЙМ (см. функцию Лента ПРАЙМ).
Запрос
GET
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
Ответ
Успешный JSON-ответ содержит дерево тематических категорий.
Параметр
Тип
Описание
categories
Object array Список категорий первого уровня
categories[].text
String
Название категории
Список категорий второго уровня (может
отсутствовать).
categories[].children
Object array
Идентификатор категории, используется в
методе Лента ПРАЙМ. В категориях
первого уровня отсутствует.
categories[].id
Integer
Пример:
{
"categories": [{
"text": "Вид информации",
"children": [{
"text": "Федеральное законодательство и проекты федеральных
законов",
"id": 24
}, {
"text": "Региональное законодательство",
"children": [{
"text": "г.Москва",
"id": 142
}],
"id": 33
}],
"id": 1008
}, {
"text": "Ваша профессия",
"children": [{
"text": "Руководитель",
"id": 144
}],
"id": 1004
}]
}
Лента ПРАЙМ
Возвращает ленту новостей ПРАЙМ в формате JSON.
Запрос
POST
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры, кроме toDate и
sort являются обязательными. Строковые значения передаются в кодировке UTF-8.
Параметр
Тип
Описание
Список ID категорий, по которым будет
сформирована лента новостей. Не допускается
передача пустого списка - это приведет к
ошибке с кодом 400.
categories
Number Array
Дата, начиная с которой будет сформирован
список новостей. Формат даты ГГГГ-ММ-ДД.
fromDate
toDate
String Date
String Date
Дата, до которой формировать список новостей
(включительно). Формат даты: ГГГГ-ММ-ДД.
Если параметр не указан, то его значение
принимается равным текущей дате. Если
разница между toDate и fromDate превышает
10 дней, то такое поведение не
поддерживается, и метод вернут ошибку с
кодом 400.
sort
Number
Способ формирования и сортировки новостей в
результате. Значение:
1 (по умолчанию) - будет использована
дата документа, о котором написана
новость.
2 - будет использована дата создания
новости
Значение 2 необходимо использовать при
периодическом опросе ленты новостей со
сдвигом даты в fromDate
Обращаем Ваше внимание, что при указании в поле categories любого ID категории из
раздела Вид Информации вместе с одним или несколькими ID категорий из раздела
Сфера интересов поиск новостей будет выполняться пересечением. Если такое
поведение не подходит, рассмотрите возможность использования двух вызовов: один со
списком ID категорий из раздела Вид Информации, другой - с ID из раздела Сфера
Интересов.
Пример:
{
"fromDate": "2019-11-01",
"categories": [1, 2, 3, 4, 5]
}
Ответ
Успешный JSON-ответ содержит список новостей. Или пустой список если ничего не
найдено.
Параметр
Тип
Описание
news
Object array
Массив найденный новостей
news[].name
String
Object
String
Заголовок новости
news[].document
document.url
Документ, анонсированный в новости
Относительная ссылка на документ. Чтобы
получить абсолютную ссылку нужно
добавить в начале
коммерческих пользователей или
https://ivo.garant.ru для некоммерческих
Внутренний номер документа, который
может быть использован в других
функциях API, например, в Экспорт
документа
document.topic
Integer
document.name
String
Имя документа
Список текстов параграфов, из которых
состоит новость
news[].paragraphs
String array
Пример:
{
"news": [{
"name": "Городские округа с внутригородским делением",
"document": {
"url": "/#/document/72957500",
"topic": 72957500,
"name": "Городские округа с внутригородским делением в
муниципально-территориальном устройстве"
},
"paragraphs": ["Городские округа с внутригородским делением", "В
статье проводится правовой анализ изменений"]
}]
}
Информация о документе
Возвращает атрибуты документа
Запрос
GET
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Внутренний номер документа, может быть получен из
функции Поиска
$topic
Integer
Ответ
Успешный JSON-ответ содержит атрибуты документа. Список возможных значений для
необходимого атрибута можно посмотреть в карточке Расширенного поиска в системе
Гарант для поля с таким же названием, как в колонке Описание ниже.
Параметр
Тип
Описание
Внутренний номер документа, который
может быть использован в других
функциях API, например в Экспорт
документа
topic
Integer
name
type
String
Array
Array
Имя документа
Список типов документов (напр. Приказ)
Список органов государственной власти,
принявших документ
adopted
class
Array
Array
Array
String
Список тема документа
Список дат документа
Список номеров
date
number
rdate
Дата регистрации
rcode
String
String
String
Регистрационный номер
Статус регистрации
Значимость
rstatus
category
Статус (действующие/утратившие силу/не
вступившие в силу)
status
String
kind
Array
Array
String
Array
String
Вид информации
territory
active
Территория
Диапазон дат действия документа
Список дат изменений
chdate
Дата последнего технического изменения
документа
last_modified
Статусы могут быть следующие:
access
String
ACCESS_IS_FREE - документ
доступен
ACCESS_BY_MONEY - документ
доступен в коммерческом комплекте,
либо при платном оформлении
заказе на сайте ivo.garant.ru
ACCESS_BY_REQUEST - документ
доступен в коммерческом комплекте,
либо при бесплатном оформлении
заказа на сайте ivo.garant.ru
ACCESS_DENIED - документ
доступен только в коммерческом
комплекте
Пример:
{
"category": ["Общие"],
"status": "Действующие",
"kind": ["Акты органов власти\\Федеральные акты"],
"name": "Постановление ВС РФ от 30 марта 1993 г. N 4694-I \"О порядке
введения в действие Закона Российской Федерации \"О минимальном размере
оплаты труда\"",
"number": ["4694-1"],
"adopted": [
"Органы законодательной власти России и СССР\\Верховный Совет
России\\ВС РФ (Верховный Совет России)"
],
"topic": 102004,
"date": ["30.3.1993"],
"territory": ["Российская Федерация"],
"type": ["Постановление"],
"class": [
"Труд, трудоустройство, занятость населения\\Оплата труда\\Размер
заработной платы, минимальная заработная плата (МРОТ)"
],
"rstatus": "Иные"
}
Информация о редакциях документа
Возвращает список редакций документа с атрибутами, отсортированными по убыванию
даты начала действия редакции.
Запрос
GET
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в строке запроса и являются обязательными.
Параметр
Тип
Описание
Внутренний номер документа в системе ГАРАНТ,
может быть получен из функции Поиска
$topic
Integer
Ответ
Успешный JSON-ответ содержит список редакций со своими атрибутами, описание
которых приведено в следующей таблице.
Параметр
status
Тип
Описание
String
Статус редакции.
Виды статусов:
rs_New - будущая редакция
rs_NewPreactive - будущая
редакция, не вступившая в силу
rs_NewAbolished - будущая
редакция, утратившая силу
rs_Actual - актуальная редакция
rs_ActualPreactive - актуальная
редакция, не вступившая в силу
rs_ActualAbolished - актуальная
редакция, утратившая силу
rs_Old - устаревшая редакция
notSure[]
Object Array
Период правовой неопределенности
редакции - время, в течение которого
существует неопределенность, действует
ли нормативный правовой акт, или какая
именно его редакция считается
действующей.
Такая ситуация возникает, когда сложно
определить дату официальной
публикации документа.
Например, документ был официально
опубликован в разные даты в нескольких
изданиях или содержит
неопубликованные приложения
notSure[].from
notSure[].to
notSure[].text
activity[]
String
Дата начала
String
Дата конца
String
Краткая информация
Object Array
Интервал действия редакции. Может быть
пустым - что означает что редакция не
действовала
activity[].from
activity[].to
String
String
Дата начала действия
Дата конца действия
Изменяющие документы
changingDocuments[ Object Array
]
changingDocuments[ String
].text
Краткое название изменяющего
документа
changingDocuments[ Integer
].topic
Внутренний номер изменяющего
документа в системе ГАРАНТ
changingDocuments[ Number
].entry
Номер блока с текстом, который “вносит
изменения”
topic
Integer
Внутренний номер редакции в системе
ГАРАНТ. У актуальной редакции значение
в этом поле всегда совпадает со
значением внутреннего номера документа
Пример ответа для документа с внутренним номером 10103000:
[
{
"status": "rs_Actual",
"topic": 10103000,
"changingDocuments": [
{
"topic": 73742836,
"text": "N 1-ФК3 от 14.03.2020",
"entry": 1
}
],
"activity": [
{
"from": "04.07.2020"
}
]
},
...
{
"status": "rs_Old",
"topic": 5430766,
"changingDocuments": [],
"activity": [
{
"to": "30.12.2008",
"from": "25.12.1993"
}
]
}
]
Анализ текста в системе "Сутяжник"
Метод позволяет проанализировать и подобрать судебную практику на основе текста
Вашего документа, подробнее обратитесь к описанию Системы Сутяжник
Запрос
POST
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Параметры передаются в теле запроса в формате JSON. Все параметры обязательны.
Строковые значения передаются в кодировке UTF-8.
Параметр
Тип
Описание
text
String
Текст документа
Максимальное количество документов, которое
вернет сервис по каждому типу правовой
информации. Целое число от 1 до 1000.
count
Integer
kind
String Array
Массив строк, содержащий коды типов
правовой информации среди которых
выполняется поиск.
Коды:
301 - суды общей юрисдикции
302 - арбитражные суды
303 - суды по уголовным делам
Пример:
{
"text": "Ставка ндс",
"count": 50,
"kind": ["301", "302"]
}
Ответ
Успешный JSON-ответ содержит список найденных документов. Или пустой список если
ничего не найдено.
Параметр
Тип
Описание
Object
Array
documents
Массив найденных документов
Массив часто упоминаемых в
documents[].courts нормативно-правовых
актов
documents[].norms
Object
Array
documents[].norms[].topic
documents[].norms[].url
Integer
String
Внутренний номер документа
Относительная ссылка на документ. Чтобы
получить абсолютную ссылку, нужно
добавить в начале https://d.garant.ru
documents[].norms[].name
documents[].kind
String
String
Название документа
Код типа правовой информации, к
которому относится объект
Массив подходящей судебной практики по
коду kind. Документы отсортированы по
релевантности в порядке убывания
documents[].courts
Object
Array
documents[].courts[].topic
documents[].courts[].url
Integer
String
Внутренний номер документа
Относительная ссылка на документ, чтобы
получить абсолютную ссылку нужно
добавить вначале https://d.garant.ru
documents[].courts[].name
String
Название документа
Пример:
{
"documents": [
{
"norms": [
{
"topic": 70353464,
"url": "/#/document/70353464/entry/6",
"name": "Федеральный закон от 5 апреля 2013 г. N
44-ФЗ \"О контрактной системе в сфере закупок товаров, работ, услуг для
обеспечения государственных и муниципальных нужд\" (с изменениями и
дополнениями)"
}
],
"kind": "301",
"courts": [
{
"topic": 341911797,
"url": "/#/document/341911797/paragraph/18",
"name": "Решение Ленинского районного суда г.
Севастополя от 16 сентября 2024 г. по делу N 2а-3135/2024"
}
],
"kind": "302",
"courts": [
{
"topic": 582418996,
"url": "/#/document/582418996/paragraph/36",
"name": "Решение Арбитражного суда
г.Санкт-Петербурга и Ленинградской области от 12 марта 2025 г. по делу N
А56-93948/2024"
}
]
}
]
}
Лимиты
Метод позволяет узнать кол-во оставшихся вызовов по всем методам в текущем месяце
рамках заданных ограничений (см. раздел Ограничения настоящего руководства).
Запрос
GET
HEADERS:
Accept: application/json
Content-type: application/json
Authorization: Bearer ***
ПАРАМЕТРЫ
Отсутствуют
Ответ
Успешный JSON-ответ содержит список объектов, с информацией об оставшихся вызовах.
Атрибуты объектов приведены ниже.
Параметр
title
Тип
Описание
Название семейства методов, которые
входят в одно ограничение. То есть вызов
любого из методов, входящих в семейство,
уменьшает кол-во оставшихся вызовов на
единицу
String
Количество оставшихся вызовов в текущем
месяце
value
Integer
String
Array
Массив суффиксов url методов, входящих в
семейство
names
Пример:
[
{
"title": "Постановка ссылки",
"value": 32767,
"names": ["find-hyperlinks"]
},
{
"title": "Экспорт",
"value": 25000,
"names": ["topic/download","topic/html","entry/html",
"topic/download-odt","topic/download-pdf","image",
"formula"]
},
{
"title": "Документы на контроле",
"value": 32767,
"names": ["find-modified"]
},
{
"title": "Блоки документа на контроле",
"value": 1,
"names": ["block-on-control/changed"]
},
{
"title": "Информация о документе",
"value": 32767,
"names": ["topic"]
}
]
Коды ошибок
В случае ошибки API возвращается HTTP-код ошибки.
HTTP Код
400
Метод API
Описание
Ошибка синтаксиса запроса
(неправильный формат данных)
Все
В запросе передано больше 100
документов для проверки
400
400
Документы на контроле
Лента прайм
Переданная дата больше чем на один
год отличается от текущей или разница
между fromDate и toDate более 10 дней
Неверный токен авторизации или истек
срок действия токена
401
403
Все
Все
Нет прав на данный запрос
(недостаточно разрешений у токена).
Для Проксимы данную ошибку можно
получить при попытке получить
информацию или скачать документ не
из БВД
Экспорт документа,
Документы на контроле
404
404
423
Документ не найден
Не найдена категория, переданная в
запросе
Лента прайм
Суммарное количество запросов по
двум методам превысило 1000 с начала
календарного месяца
Простановка ссылок,
Документы на контроле
Количество запросов превысило 30 с
начала календарного месяца
423
423
429
Экспорт документа
Информация о документе
Все
Количество запросов превысило 300 с
начала календарного месяца
Слишком много запросов: более 20
запросов в секунду.
Язык запросов для поиска документов
В этом разделе приводится описание возможности поиска документов по значениям
разных реквизитов. Для этих целей разработан специальный язык запросов, на котором
необходимо описывать строку для поиска - поле text - в методе API Поиск.
Определения
Строка для поиска представляет собой последовательность команд соединенных
операторами. Поиск анализирует строку и ищет только те документы, которые
соответствуют запросу.
Команда - это указание для поиска что и в каком поле документа искать, например
команда MorphoText(льготы) - означает искать все документы, которые содержат слово
"льготы" в тексте, а команда Type(Решение) найдет все документы с типом "Решение", то
есть все документы, у которых в поле "тип" содержится термин "Решение". Только две
команды работаю со словами или фразами - это MorphoText и MorphoName, все остальные
- исключая команды с датами - работают с терминам: значениями из специальных
словарей, который предоставляются по запросу.
В командах, работающих с датами, можно указывать дату сверху, дату снизу и
промежуток дат. Например: Date(20.01.2022;) найдет все документы с датой от
20.01.20222 включительно и по текущее число; RDate(;01.01.1990) - найдет все
документы с датой регистрацией до 01.01.1990 (включительно);
Changed(07.09.2025;08.09.2025) - найдет все документы которые менялись 7 или 8
сентября 2025 года.
Операторы позволяют объединять команды с помощью логических операторов. Всего
поддерживаются два логических оператора: И (&) и ИЛИ (|). Например, для поиска
фразы "ставка НДС" только в постановлениях запрос будет таким: MorphoText(ставка
НДС) & Type(Постановление). А если надо найти документы с типами Решение или
Постановление, то запрос будет: Type(Решение) | Type(Постановление).
Так же в запросе можно использовать группировку, например чтобы найти документы с
типом "решение" или "постановление" и которые содержат фразу "ставка НДС", то надо
использовать вот такую конструкцию: MorphoText(ставка НДС) & BOOL(Type(Решение) |
Type(Постановление))
Примеры
Поиск по словам в тексте
{
"text":"MorphoText(налог)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск по дате
{
"text":"Date(20.01.2022;26.01.2022)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск по словам в названии
{
"text":"MorphoName(Конституция РФ)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск по типу
{
"text":"Type(Аттестат)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск по органу государственной власти
{
"text":"Adopted(Органы власти г. Москвы)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск по дате регистрации в Минюсте
{
"text":"RDate(20.01.2022;26.01.2022)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск по двум реквизитам: тип и номер
{
"text":"Type(Акт) & Number(44)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Поиск корреспондентов
Поиск документов, в которых есть ссылки на интересующий документ или фрагмент
документа (блок).
{
"text":"Correspondents(184755 91)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Здесь: 403127269 - номер интересующего документа, 35020 - номер блока.
Поиск респондентов
Поиск документов, на которые есть ссылки в интересующем документе или фрагменте.
{
"text":"Respondents(57589736 21)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}
Здесь: 57589736 - номер интересующего документа, 21 - номер блока. Такой запрос
позволит получить респондентов в разделе 2.1 документа “Энциклопедия судебной
практики. Федеральные налоги и сборы (Ст. 13 НК)” в Системе Гарант
Поиск только новых документов
Поиск документов, которые появились в системе Гарант за 10 сентября 2025 года.
{
"text":"SortDate(10.09.2025;10.09.2025)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 1,
"page": 1
}
Поиск только изменившихся документов
Поиск документов, которые появились в системе Гарант с указанной даты.
{
"text":"MorphoName(Курсы иностранных валют) & Changed(08.09.2025;)",
"isQuery": true,
"env": "internet",
"sort": 0,
"sortOrder": 0,
"page": 1
}