Документация по API 3.0 сервиса APIEGRN.RU
для работы с Росреестром
Что такое API?
АPI - это интерфейс, который позволяет с помощью специального набора команд (функций) удаленно управлять каким-либо программным обеспечением (сервисом). Иначе говоря, API - это интерфейс прикладного программирования для интеграции одного программного обеспечения с другим (более подробно можно прочитать о том, что такое API здесь).
Для чего используют API?
API обычно используют для интеграции одной системы с другой, чтобы они взаимодействовали синхронно и обменивались данными.
Какие типы документов и реестров можно запросить?
Отчет об основных параметрах объекта недвижимости
Отчет об изменениях прав на объект недвижимости
Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости
Отчет об объектах недвижимости в пределах кадастрового плана территории
Реестр правообладателей многоквартирного дома
Реестр правообладателей земельного участка
О руководстве по использованию API.
Руководство содержит описание API сервиса APIEGRN.RU, а также информацию о том, как подключить и использовать сервис.
Руководство предназначено для веб-разработчиков, которые хотят добавить на страницы своих сайтов возможность получения сведений из Росреестра , а так же для разработчиков которые хотят встроить сервис в свои системы (CRM, CMS, и т.д.) .
Демо доступ, Демо аккаунт, Тестовые запросы.
Поскольку само API является бесплатным, то при интеграции API разработчику нет необходимости использовать какие либо демо или тестовые доступы, а так же тестовые запросы. При интеграции, разработчик в реальном времени может производить запросы и получать от Росреестра ответы с реальными данными. Оплата производится только при использовании методов Cadaster/Save_order и Reestr/Rightholders. В случае возникновения ошибок в процессе интеграции, в описании API имеется перечень возможных ошибок, их описание и методы устранения.
Принципы взаимодействия с сервисом ApiEGRN.
Для обработки данных через API вашему приложению или веб-сайту необходимо отсылать нашему сервису соответствующие HTTP-запросы. В ответ на эти запросы сервис возвращает HTTP-сообщения, в теле которых содержится сам результат обработки. Запросы нужно отсылать методом POST.
Наш сервис работает с использованием SSL сертификата, что дает возможность быть уверенным в целостности полученных от нас данных.
Авторизация запросов.
Процесс авторизации запросов возможен при наличии персонального ключа (токена), которым в дальнейшем должен быть подписан каждый запрос к API.
Что считается запросом
Запрос к API - это факт обращения к тем или иным методом API, что являются бесплатными.
Запрос на поиск объектов - это платная услуга для поиска обектов недвижимости в базе ЕГРН методами API Cadaster/Search и Cadaster/GeoSearch, взимается плата только в случае успешного результата этих запросов.
Запрос характеристик объекта - это бесплатный метод API для получения общедоступных сведений об объектах недвижимости по кадастровому номеру с помощью метода Cadaster/ObjectInfoFull. (Есть ограничение по количеству запросов)
Внимание!
Доступ ко всем методам API осуществляется по ключу (токену). Ваш бесплатный API-Ключ (токен) можно узнать в личном кабинете после прохождения процедуры регистрации. Вы можете в любой момент заменить токен на новый, но при этом необходимо помнить, что старый токен перестает действовать .
Cadaster/Search — Поиск объектов
Возвращает список найденных объектов по ключевому запросу.Примечание:
• Максимальное количество возвращаемых Росреестром объектов 200, но в некоторых случаях может быть и больше (это не ошибка).
HTTP запрос
POST https://apiegrn.ru/api/cadaster/search требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
mode | lite — Кадастровый номер, Адрес auto — Режим будет выбран автоматически, в зависимости от загруженности Росреестра (по умолчанию) |
Возвращаемые данные. ------------------ В режиме lite, параметр grouped будет игнорироваться. |
query |
Кадастровый номер 46:29:101001:10 Адрес в произвольной форме , Косухина 38, кв 19 Адрес в разбитом виде
{
"region_code": "46", // номер региона, обязательно "raion": "", // название города или района "settlement": "", // населенный пункт, без типа "street": "Косухина", // улица, без указания типа "house": "38", // номер дома "building": "", // строение "block": "", // корпус "flat": "19" // квартира или помещение } |
Kадастровый номер или адрес |
limit | 0 — без ограничении (по умолчанию) | Максимальное количество записей в списке. |
grouped | 0 — нет 1 — да |
Группировать найденные объекты по типу. По умолчанию - 0 |
Ответ сервера
// В режиме normal
{
"objects": [
{
"CADNOMER": "46:29:101001:10",
"ADDRESS": "ая область, г , ул Ильича, д 48",
"TYPE": "Земельный участок",
"AREA": "1427.0 (квадратный метр)",
"CATEGORY": "Земли населенных пунктов"
}
],
"found": 1,
"found_all": true,
"mode": "normal",
"grouped": false,
"region": "ая область",
"error": []
}
// В режиме lite
{
"objects": [
{
"CADNOMER": "46:29:101001:10",
"ADDRESS": "ая область, г , ул Ильича, д 48",
"TYPE": null,
"AREA": null,
"CATEGORY": null
}
],
"found": 1,
"found_all": true,
"mode": "lite",
"grouped": false,
"region": "ая область",
"error": []
}
Название | Тип | Описание |
---|---|---|
objects | array | Список найденных объектов |
objects[n].CADNOMER | string | Кадастровый номер |
objects[n].ADDRESS | string | Адрес |
objects[n].TYPE | string | Тип объекта |
objects[n].AREA | string | Площадь |
objects[n].CATEGORY | string | Категория ЗУ |
found | int | Количество найденных объектов |
found_all | bool | true — Из Росреестра получен полный список объектов по указанному адресу. false — Из Росреестра получен не полный список объектов по указанному адресу. Чтобы получить полный список объектов, попробуйте повторить запрос. При повторном запросе список может дополниться недостающими объектами. |
mode | string | Режим поиска |
region | string | Регион где находится объект |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
SEARCH_OVERLIMIT | Exceeded the limit on the search for objects | Превышен лимит на поиск объектов методом Cadastre/Search, увеличить лимит можете в личном кабинете. |
TIMEOUT | Rosreestr is not responding | Сервера Росреестра не отвечают в течении 60 секунд. Попробуйте позже. |
Cadaster/GeoSearch — Поиск объектов по координатам
Возвращает список найденных объектов по заданным координатам. Поиск осуществляется в радиусе 8 метров.HTTP запрос
POST https://apiegrn.ru/api/cadaster/geosearch требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
query | Координаты 49.223128, 143.097678 |
Координаты в формате WGS84 широта, долгота |
Ответ сервера
{
"objects": [
{
"CADNOMER": "65:17:0000009:5464",
"ADDRESS": "Сахалинская область, Поронайский район, г Поронайск, ул Сахалинская, д 4",
"TYPE": "Земельный участок"
},
{
"CADNOMER": "65:17:0000009:5519",
"ADDRESS": "Сахалинская область, р-н Поронайский, г Поронайск, ул Сахалинская, д 4",
"TYPE": "ОКС"
},
{
"CADNOMER": "65:17:0000009",
"ADDRESS": null,
"TYPE": "Квартал"
}
],
"objects_around": [
{
"CADNOMER": "65:17:0000009:5525",
"ADDRESS": "Сахалинская область, р-н Поронайский, г Поронайск, ул Молодежная",
"TYPE": "Земельный участок"
}
],
"found": 4,
"region": "Сахалинская область",
"error": []
}
Название | Тип | Описание |
---|---|---|
objects | array | Список объектов в границах которых находятся координаты указанной точки |
objects_around | array | Иные объекты в радиусе 8м (относительно заданной координаты) |
objects[n].CADNOMER | string | Кадастровый номер |
objects[n].ADDRESS | string | Адрес |
objects[n].TYPE | string | Тип объекта (Земельный участок, ОКС, Квартал) |
found | int | Количество найденных объектов |
region | string | Регион где находится объект |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
SEARCH_OVERLIMIT | Exceeded the limit on the search for objects | Превышен лимит на поиск объектов методами Cadastre/Search и/или Cadastre/GeoSearch, увеличить лимит можете в личном кабинете. |
TIMEOUT | Rosreestr is not responding | Сервера Росреестра не отвечают в течении 60 секунд. Попробуйте позже. |
COORDINATES_NOT_PARSED | Invalid coordinates format | Координаты должны быть в формате WGS84, например: "49.223128, 143.097678". |
Cadaster/ObjectInfoFull — Информация об объекте
Возвращает сведения об объекте из ЕГРН, также список доступных документов для заказаHTTP запрос
POST https://apiegrn.ru/api/cadaster/objectInfoFull требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
query | Например: 46:29:101001:10 |
Только кадастровый номер |
deep | 0 — нет (по умолчанию) 1 — да |
Глубокий поиск сведений. Используйте для получения "Права и ограничения" |
Ответ сервера
{
"EGRN": {
"object": {
"CADNOMER": "46:29:101001:10",
"ADDRESS": "ая область, г , ул Ильича, д 48",
"TYPE": "Земельный участок",
"AREA": "1427.0 (квадратный метр)",
"CATEGORY": "Земли населенных пунктов"
},
"details": {
"Тип объекта": "Земельный участок",
"Кадастровый номер": "46:29:101001:10",
"Статус объекта": "Ранее учтенный",
"Дата постановки на кадастровый учет": "20.12.2001",
"Категория земель": "Земли населенных пунктов",
"Разрешенное использование": "Для индивидуальной жилой застройки",
"Площадь": "1427",
"Единица измерения (код)": "Квадратный метр",
"Кадастровая стоимость": "1167214,65",
"Дата определения стоимости": "19.02.2016",
"Дата внесения стоимости": "10.12.2016",
"Дата утверждения стоимости": "10.12.2016",
"Адрес (местоположение)": "обл. ая, г. , ул. Ильича, дом 48",
"Дата обновления информации": "10.12.2016",
"Форма собственности": "Частная",
"Количество правообладателей": "2",
"Кадастровый инженер": "Краснобородько Кирилл Александрович (аттестат 46-14-207)"
},
"rights": [
{
"number": "46:29:101001:10-46/001/2017-2",
"date": "2017-01-25",
"type": "собственность",
"limits": [
{
"number": "46-46-11/002/2017-555",
"date": "2017-07-12",
"type": "аренда"
},
{
"number": "46:29:101001:10-46/001/2017-122",
"date": "2017-07-12",
"type": "запрещение"
}
]
}
]
},
"coordinates": [
51.760713,
36.241856
],
"region": "ая область",
"documents": {
"XZP": {
"label": "Отчет об основных параметрах объекта недвижимости",
"available": true,
"price": 0
},
"SOPP": {
"label": "Отчет об изменениях прав на объект недвижимости",
"available": true,
"price": 0
},
"SKS": {
"label": "Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости",
"available": true,
"price": 0
},
"KPT": {
"label": "Отчет об объектах недвижимости в пределах кадастрового плана территории",
"available": false,
"price": 200
}
},
"encoded_object": "f9JiNxAjMuITMuATMiojI4CNuQbY0wCNvQDY0+CNhR3L04CNIPGNuQ3L01C9uQLL0+C...",
"error": []
}
Название | Тип | Описание |
---|---|---|
EGRN | object | Информация из ЕГРН |
EGRN.object | object | Результат поиска |
EGRN.object.CADNOMER | string | Кадастровый номер |
EGRN.object.ADDRESS | string | Адрес |
EGRN.object.TYPE | string | Тип объекта |
EGRN.object.AREA | string | Площадь |
EGRN.object.CATEGORY | string | Категория ЗУ |
EGRN.details | object | Характеристика объекта из ЕГРН, (произволное количество полей!) |
EGRN.rights | array | Права и ограничения. (если deep = 1) |
EGRN.rights.number | string | Номер регистрации права |
EGRN.rights.date | string | Дата регистрации права |
EGRN.rights.type | string | Тип права |
EGRN.rights.limits | array | Ограничения |
EGRN.rights.limits.number | string | Номер регистрации |
EGRN.rights.limits.date | string | Дата регистрации ограничения |
EGRN.rights.limits.type | string | Тип ограничения |
EGRN.found | int | Найдена ли информация в ЕГРН 0 — нет 1 — да |
documents | object | Виды документов XZP — Отчет об основных параметрах объекта недвижимости SOPP — Отчет об изменениях прав на объект недвижимости SKS — Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости KPT — Отчет об объектах недвижимости в пределах кадастрового плана территории |
documents.вид.available | bool | Доступен ли данный документ для заказа на этот объект |
documents.вид.price | float | Стоимость документа для данного объекта (в рублях) |
coordinates | array | Географические координаты объекта в виде массива: [Широта, Долгота] |
region | string | Регион где находится объект |
encoded_object | string | Это пригодится при оформление заказа |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Bad parameter `query`, not a cadastral number | Переданное значение для "query" не соответствует формату кадастрового номера. |
OBJECT_NOT_FOUND | Cadastral object not found | Объект по указанному кадастровому номеру не найден. 1. Проверьте кадастровый номер. 2. Возможно в ЕГРН отсутствуют сведения по этому объекту. |
TIMEOUT | Rosreestr is not responding | Сервера Росреестра не отвечают в течении 60 секунд. Попробуйте позже. |
Cadaster/Reestr — Реестр объектов недвижимости
Возвращает реестр объектов невижимости относящиеся к дому по кадастровому номеру этого домаДанный метод создания реестров не гарантирует, что в реестр войдут все помещения имеющиеся в доме. Это связано с тем, что Росреестр не всегда корректно предоставляет сведения о количестве помещений в том или ином доме. Как правило ошибки в количестве помещений в доме могут возникать в том случае, если общее количество помещений в доме более 200.
Метод создания гарантированно полного реестра будет запущен через некоторое время после окончания проведения тестовых испытаний.
HTTP запрос
POST https://apiegrn.ru/api/cadaster/reestr требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
query | Например: 46:29:101001:80 |
Кадастровый номер многоквартирного дома |
Ответ сервера
{
"reestr": {
"apartments_residential": {
"objects": [
{
"CADNOMER": "46:29:102219:407",
"ADDRESS": "г , ул Косухина, д. 38, 1",
"APARTMENT": "1",
"TYPE": "Помещение",
"AREA": "60.8 кв.м"
},
{
"CADNOMER": "46:29:102219:406",
"ADDRESS": "г , ул Косухина, д. 38, 2",
"APARTMENT": "2",
"TYPE": "Помещение",
"AREA": "46.4 кв.м"
},
//............. и т.д. ............
],
"found": 107
},
"apartments_nonresidential": {
"objects": [
{
"CADNOMER": "46:29:102219:399",
"ADDRESS": "г , ул Косухина, д. 38, I",
"APARTMENT": "I",
"TYPE": "Помещение",
"AREA": "42.5 кв.м"
}
],
"found": 1
},
"lands": {
"objects": [
{
"CADNOMER": "46:29:102219:41",
"ADDRESS": "обл. ая, г. , ул. Косухина, дом 38",
"APARTMENT": null,
"TYPE": "Земельный участок",
"AREA": "25 кв.м"
},
{
"CADNOMER": "46:29:102219:58",
"ADDRESS": "обл. ая, г. , ул. Косухина, дом 38",
"APARTMENT": null,
"TYPE": "Земельный участок",
"AREA": "4578 кв.м"
},
{
"CADNOMER": "46:29:102219:30",
"ADDRESS": "обл. ая, г. , ул. Косухина, дом 38",
"APARTMENT": null,
"TYPE": "Земельный участок",
"AREA": "11 кв.м"
},
{
"CADNOMER": "46:29:102219:39",
"ADDRESS": "обл. ая, г. , ул. Косухина, дом 38",
"APARTMENT": null,
"TYPE": "Земельный участок",
"AREA": "9 кв.м"
}
],
"found": 4
},
"buildings": {
"objects": [
{
"CADNOMER": "46:29:102219:80",
"ADDRESS": "г , ул Косухина, д. 38",
"APARTMENT": null,
"TYPE": "Здание",
"AREA": "5634.3 кв.м"
}
],
"found": 1
},
"constructions": {
"objects": [],
"found": 0
},
"others": {
"objects": [],
"found": 0
}
},
"found": 113,
"rsn_price_conds": {
"<=10": 90,
"<=50": 70,
"<=100": 50,
"<=300": 30,
">300": 20
},
"error": []
}
Название | Тип | Описание |
---|---|---|
reestr | object | Реестр объектов невижимости |
reestr.apartments_residential | object | Жилые помещения |
reestr.apartments_nonresidential | object | Нежилые помещения |
reestr.lands | object | Земельные участки |
reestr.buildings | object | Здания |
reestr.constructions | object | Сооружения |
reestr.others | object | Прочее |
reestr.категория.objects | array | Список объектов данной категории, содержат: --- CADNOMER — Кадастровый номер ADDRESS — Адрес объекта APARTMENT — Номер помещения TYPE — Тип объекта AREA — Площадь объекта |
reestr.категория.found | int | Количество объектов в данной категории |
reestr.found | int | Общее количество объектов в реестре |
rsn_price_conds | object |
Услувия расчета стоимости для составления (Реестр собственников дома) --- Например: если (n <=10) то цена (n * 90) руб. если (n <=50) то цена (n * 70) руб. если (n <=100) то цена (n * 50) руб. если (n <=300) то цена (n * 30) руб. если (n > 300) то цена (n * 20) руб. где (n) это количество обектов которые будут учитыватся при составление реестра собственников n может ровнятся как reestr.found также (reestr.apartments_residential.found + reestr.apartments_nonresidential.found) для составления реестра собственников смотрите ObjectInfoFull и Save_order |
Коды ошибок | Описание | Причины и решения |
---|
Cadaster/Save_order — Оформление заказа
Оформляет заказ для указанных документов со статусом "Ожидает оплаты", возвращает номер заказа/транзакцииHTTP запрос
POST https://apiegrn.ru/api/cadaster/save_order требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
mode |
verified — Объект проверен методом ObjectInfoFull blind — Оформление заказа по кадастровому номеру без проверки объекта о его наличии в Росреестре и без получения характеристик. |
(По умолчанию - verified) Режим blind стоит использовать при нестабильной работе Росреестра, когда нет возможности проверить наличие объекта и его характеристики для последующего заказа отчета. Этот параметр так же будет полезен тем, кто уже обладает сведениями по объектам недвижимости и имеет в своем распоряжении кадастровые номера объектов. Тогда используя этот параметр сокращается время запроса на формирование заказа, а при больших объемах это существенная экономия и времени и ресурсов. Если после оформления заказа с параметром blind окажется, что объект в Росреестре не найден, заказ будет отменен автоматически и средства будут возвращены на используемый тариф. Уведомление об этом будет Webhook. |
encoded_object (только в режиме verified) |
Значение берём из запроса ObjectInfoFull | Необходим для оформления заказа в режиме verified |
cadnomer (только в режиме blind) |
Кадастровый номер объекта или квартала | Необходим для оформления заказа в режиме blind |
documents[] (array) | Например: documents[]=XZP documents[]=SOPP documents[]=SKS documents[]=KPT |
Перечень заказываемых документов --------------- Внимание! Типы документов в массиве не должны повторяться. |
sks_date | Не обязательно |
При заказе SKS (Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости), можно запросить сведения на раннюю дату, в формате гггг-мм-дд |
comment | Не обязательно | Комментарий к заказу |
Допольнительные параметры для партнерской праграммы "АпиКасса" ► Показать |
Ответ сервера
// Без использования параметра `apikassa`
{
"transaction_id": 80140,
"documents_id": {
"XZP": 540
},
"paid": false,
"error": []
}
// С использованием параметра `apikassa`
{
"client_redirect": "https://apiegrn.ru/market/?item=13_WgtLRzH",
"error": []
}
Название | Тип | Описание |
---|---|---|
transaction_id | int | Номер заказа/транзакции сейчас он нужен для выполнения оплаты |
documents_id | object | Номер каждого оформленного документа в заказе |
documents_id.вид_документа | int | Номер документа |
paid | bool | Оплачен ли заказ true — Да false — Нет |
client_redirect | string | Ссылка на временную страницу оформления заказа, на которую Вам необходимо перенаправить клиента (ссылка действительна в течении 20 минут) --------------- Только при использовании параметра `apikassa` в запросе. |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Invalid encoding object | "encoded_object" имеет некорректное значение. Рекомендуем экранировать значение, используя аналогичную функцию (urlencode для PHP). |
BAD_DOC_TYPE | Unsupported type of document | Передан неподдерживаемый тип документа. |
BAD_SKS_DATE | Invalid date format for SKS or not in range | Неверный формат даты, или дата вне диапазона (2004-01-01 — сегодняшнее число). |
INVALID_CADNOMER | Invalid cadnomer given | Убедитесь, что передаете корректный кадастровый номер объекта недвижимости или квартала. |
DUPLICATES_FOUND | Duplicates are found in the list of documents. | Удалите дублирующие типы документов из массива `documents`. |
TARIFFS_NOT_MATCH | Tariffs do not match | Значение "encoded_object" было взято из запроса Cadaster/ObjectInfoFull который был сделан при другом тарифе. |
INSUFFICIENT_FUNDS | Insufficient funds on the account | Исчерпан лимит запросов по тарифу. Продлите тариф или перейдите на другой. |
Возможные ошибки при использовании параметра "apikassa" |
||
APIKASSA_MODE | Parameter `apikassa` not supported in mode `blind` | Для работы с Apikassa режим blind не поддерживается, используйте verified |
NO_REQUISITES | Requisites in the user account are not filled | Необходимо в личном кабинете заполнять реквизиты |
ZERO_PRICE | Document `тип` price could not be equal to zero | Цена документа в заказе не может быть 0 руб. |
OVERPRICE_MISSING | Missing parameter `overprice` for requested document | Цена запрашиваемого документа не указана |
TPL_NOT_MODERATED | Template by id `xx` is not moderated | Указан шаблон, который не прошел модерацию |
TPL_BAD_EVENT | Template by id `xx` not belong to event `xx` | Указанный шаблон не принадлежит к указанному событию |
TPL_BAD_CHANNEL | Template by id `xx` not belong to channel `xx` | Указанный шаблон не принадлежит к указанному каналу |
TPL_NOT_FOUND | Template by id `xx` not found | Шаблон по указанному номеру не найден. Проверьте принадлежность шаблона вашему аккаунту |
Cadaster/Cancel_order — Отмена заказа
Данный метод позволяет отменять оформленный и оплаченный заказ и автоматически возвращает денежные средства согласно тарифу по которому была произведена оплата. Т.е. если оплата была произведена с лицевого счета, то на лицевой счет автоматически вернуться средства после отмены такого заказа. Если заказ был оформлен с предоплаченного тарифа, то к нему автоматически прибавляется количество списанных единиц при оформлении заказа.Примечание! Отменить можно только те заказы, которые были оплачены и спустя 3-е суток не были исполнены.
HTTP запрос
POST https://apiegrn.ru/api/cadaster/cancel_order требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
document_id | Номер документа в заказе |
Ответ сервера
{
"note": "The document has been canceled",
"error": []
}
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
403 | Forbidden. Not own order | Заказ принадлежит другому пользователю. |
DOCUMENT_NOT_FOUND | The document not found | Неверный номер документа в заказе. |
OPERATION_NOT_APPLICABLE | This operation can not be applied to this order | Заказ не может быть отменен, возможные причины: - заказ был сформирован но не оплачен; - заказ исполнен; - не прошло 3-е суток с момента оплаты; - заказ уже был отменен; |
Transaction/info — Информация о транзакции
Возвращает полную информацию о транзакции, в том числе способы оплаты для данного заказаHTTP запрос
GET | POST https://apiegrn.ru/api/transaction/info требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
id | Номер заказа "транзакции" |
Ответ сервера
{
"id": 80140,
"service": "API_ROSREESTR",
"caption": "API ЕГРН",
"description": "Кадастровый номер: 46:29:101001:10",
"cost": 0,
"paid": false,
"paid_from": "",
"date_create": "2017-03-05 20:34:26",
"date_paid": "0000-00-00 00:00:00",
"pay_methods": {
"free": {
"name": "Бесплатно",
"allowed": true,
"confirm_code": "c4600d6b40038ce66bcc4fd90fff63704600216e2bcc50160883ac229b0572aa",
"confirm_link": "https:\/\/apiegrn.ru\/api\/transaction\/pay\/80140\/?confirm=c4600d6b40038ce66bcc4fd90fff63704600216e2bcc50160883ac229b0572aa"
},
"PA": {
"name": "Лицевой счет",
"allowed": false,
"balance": 0,
"sufficient_funds": false,
"confirm_code": null,
"confirm_link": null
},
"apikassa": {
"name": "Оплата через АпиКасса",
"allowed": false,
"link": null
},
"other": {
"name": "Другие способы оплаты",
"allowed": false,
"methods": []
}
},
"error": []
}
Название | Тип | Описание |
---|---|---|
id | int | Номер заказа/транзакции |
cost | float | Стоимость заказа |
paid | bool | Оплачен ли заказ true — Да false — Нет |
paid_from | string | Оплачен через: PA — Лицевой счет FREE — Бесплатно ROBOKASSA — Платёжный агрегатор "Робокасса" |
date_create | string | Дата время оформления заказа, в формате гггг.мм.дд ч:м:с |
date_paid | string | Дата время оплаты заказа, в формате гггг.мм.дд ч:м:с |
pay_methods | object | Способы оплаты |
pay_methods.free | object | Бесплатно |
pay_methods.PA | object | Лицевой счет |
pay_methods.apikassa | object | Оплата через АпиКасса (для партнерской программы "АпиКасса") |
pay_methods.other | object | Другие способы оплаты |
pay_methods.PA.balance | int | Баланс лицевого счета |
pay_methods.PA.sufficient_funds | bool | Достаточно ли средств на счете чтобы выполнить оплату true — Да false — Нет |
pay_methods.free.allowed pay_methods.PA.allowed pay_methods.apikassa.allowed pay_methods.other.allowed |
bool | Разрешен ли данный способ оплаты true — Да false — Нет |
pay_methods.free.confirm_code pay_methods.PA.confirm_code |
string | Код для подтверждения оплаты по данному способу, см. Transaction/pay |
pay_methods.free.confirm_link pay_methods.PA.confirm_link |
string |
Ссылка с кодом для подтверждения оплаты по данному способу, вызывается Transaction/pay |
pay_methods.apikassa.link | string | Ссылка на страницу оплаты (только если заказ оформлен через партнерскую программу "АпиКасса") |
pay_methods.other.methods | object | Способы оплаты через Веб-интерфейс платёжного агрегатора, произвольное количество вариантов! |
pay_methods.other.methods.вариант.name | string | Название способа оплаты |
pay_methods.other.methods.вариант.img | string | Ссылка на значок способа оплаты, форматы файлов могут быть разные |
pay_methods.other.methods.вариант.link | string | Ссылка на Веб-интерфейс платёжного агрегатора, для совершения оплаты |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
404 | Transaction Not Found | Транзакция/заявка по данному номеру не найдена. |
403 | Not own transaction | Запрошенная транзакция принадлежит другому пользователю. |
Transaction/pay — Подтверждения оплаты
Подтверждения оплаты для способов "Лицевой счет" и "Бесплатно". Передает заказ в обработку, возвращает состояние заказаHTTP запрос
GET | POST https://apiegrn.ru/api/transaction/pay требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
id | Номер заказа/транзакции | |
confirm | Сгенерированный код |
Данный код берётся из запроса Transaction/info pay_methods.free.confirm_code или pay_methods.PA.confirm_code |
Ответ сервера
{
"paid": true,
"cost": 0,
"error": []
}
Название | Тип | Описание |
---|---|---|
paid | bool | Оплата прошла успешно true — Да false — Нет |
cost | float | Сумма которая была оплачена |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
ALREADY_PAID | Transaction paid already | Данная транзакция уже была оплачена. |
INVALID_CONFIRM_CODE | Invalid confirmation code | Неверный код подтверждения. |
NOT_ALLOWED | Payment from the Personal Account is not allowed for this transaction | Оплата с ЛС невозможно для данной транзакции. |
Transaction/history — История транзакций
Возвращает информацию о транзакциях.HTTP запрос
POST https://apiegrn.ru/api/transaction/history требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
filters (array) | (Не обязателно) Ниже приведен пример. |
Вы можете запрашивать историю по заданным критериям. ------------------------------------------ filters[n].column — Название поля filters[n].condition — Оператор сравнения filters[n].value — Значение filters[n].after — Логический оператор по отношению к след. фильтру Поля Операторы сравнения id | = | != | < | > | <= | >= | service | = | != | description | = | != | LIKE | cost | = | != | < | > | <= | >= | date_create | = | != | < | > | <= | >= | date_paid | = | != | < | > | <= | >= | paid_from | = | != | isPaid | = | != | P.S. При LIKE, в значение можете использовать знак % |
ascending | 1 — Да 0 — Нет (по умолчанию) |
Сортировка по возрастанию. Производится по дате создания. |
offest | минимум — 0, максимум — ∞ | Смещение относительно начала получаемого списка. (По умолчанию - 0) |
limit | минимум — 1, максимум — 500 | Количество записей в списке, которые должны получить. (По умолчанию - 500) |
Ответ сервера
{
"transactions": [
{
"id": 129830,
"service": "API_ROSREESTR",
"caption": "API ЕГРН",
"description": "Кадастровый номер: 46:29:101001:25",
"cost": 0,
"date_create": "2017-10-24 16:10:11",
"date_paid": "2017-10-24 16:10:11",
"isPaid": 1,
"paid_from": "PREPAID"
},
{
"id": 129826,
"service": "TARIFF",
"caption": "API ЕГРН",
"description": "Покупка тарифа: 1",
"cost": 5000,
"date_create": "2017-10-24 15:55:08",
"date_paid": "2017-10-24 15:55:08",
"isPaid": 1,
"paid_from": "PA"
},
{
"id": 128950,
"service": "API_ROSREESTR",
"caption": "API ЕГРН",
"description": "Кадастровый номер: 46:29:101001:10",
"cost": 90,
"date_create": "2017-10-23 17:48:50",
"date_paid": "2017-10-23 17:52:58",
"isPaid": 1,
"paid_from": "ROBOKASSA"
}
],
"shown": 3,
"total": 3,
"error": []
}
Название | Тип | Описание |
---|---|---|
transactions | array | Список транзакций по заданному фильтру |
transactions.id | int | Номер заказа/транзакции |
transactions.service | string | Транзакция для: BALANCE — Пополнение баланса TARIFF — Покупка тарифа API_ROSREESTR — Получение отчета API_RIGHTHOLDERS — Формирование реестра правообладателей |
transactions.description | string | Описание транзакции |
transactions.cost | float | Стоимость |
transactions.date_create | string | Дата время заказа/транзакции, в формате гггг.мм.дд ч:м:с |
transactions.date_paid | string | Дата время оплаты, в формате гггг.мм.дд ч:м:с |
transactions.isPaid | bool | Оплачен ли заказ 1 — Да 0 — Нет |
transactions.paid_from | string | Оплачен через: PA — Лицевой счет FREE — Бесплатно ROBOKASSA — Платёжный агрегатор "Робокасса" PREPAID — Предоплата |
shown | int | Количество показанных записей |
total | int | Количество записей, найденных указанным фильтром |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Invalid parameter value/structure for `filters` | Некорректный фильтр. Возможно, что в указанных фильтрах отсутствует обязательный параметр или указано недопустимое значение для "column", "condition" или "after" |
Cadaster/Orders — Информация о заказе
Возвращает характеристика объекта, документы, цены и состояние заказаHTTP запрос
POST https://apiegrn.ru/api/cadaster/orders требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
id | (Не обязателно) Номер заказа/транзакции |
Используйте данный параметр для получения подробной информации о конкретном заказе |
filters (array) | (Не обязателно) Ниже приведен пример. |
При ипользовании данного параметра, предедущый параметр `id` будет игнорироваться! ------------------------------------------ Используйте данный параметр для получения подробной информации по определенным критериям сразу о нескольких заказах. ------------------------------------------ filters[n].column — Название поля filters[n].condition — Оператор сравнения filters[n].value — Значение filters[n].after — Логический оператор по отношению к след. фильтру Поля Операторы сравнения transaction_id | = | != | < | > | <= | >= | cadnomer | = | != date_create | = | != | < | > | <= | >= | date_complete | = | != | < | > | <= | >= | document_id | = | != | < | > | <= | >= | type | = | != status | = | != | < | > | <= | >= | price | = | != | < | > | <= | >= | rr_order_number | = | != comment | = | != |
ascending (к параметру filters) |
1 — Да 0 — Нет (по умолчанию) |
Сортировка по возрастанию. Производится по дате создания. |
offest (к параметру filters) |
минимум — 0, максимум — ∞ | Смещение относительно начала получаемого списка. (По умолчанию - 0) |
limit (к параметру filters) |
минимум — 1, максимум — 10 000 | Количество записей в списке, которые должны получить. (По умолчанию - 500) |
Ответ сервера
// С использованием параметра `filter`
{
"documents": [
{
"transaction_id": 1024396,
"cadnomer": "46:29:101001:10",
"date_create": "2018-11-07 13:18:55",
"document_id": 1287209,
"type": "SOPP",
"date_complete": "2018-11-08 00:15:38",
"price": 0,
"status": 4,
"note": "",
"rr_order_number": "80-87634862",
"comment": "Мой первый заказ"
},
{
"transaction_id": 1024395,
"cadnomer": "46:29:101001:22",
"date_create": "2018-11-07 13:18:54",
"document_id": 1287208,
"type": "XZP",
"date_complete": "2018-11-07 13:59:32",
"price": 0,
"status": 4,
"note": "",
"rr_order_number": "80-87491595",
"comment": ""
},
{
"transaction_id": 1024394,
"cadnomer": "46:29:000013:880",
"date_create": "2018-11-07 13:18:50",
"document_id": 1287207,
"type": "XZP",
"date_complete": "2018-11-07 14:01:20",
"price": 0,
"status": 4,
"note": "",
"rr_order_number": "80-87490888",
"comment": ""
}
],
"shown": 3,
"total": 57,
"limit": 500,
"offset": 0,
"error": []
}
// С использованием параметра `id`
{
"id": 80140,
"cadnomer": "46:29:101001:10",
"details": {
"Тип объекта": "Земельный участок",
"Кадастровый номер": "46:29:101001:10",
"Статус объекта": "Ранее учтенный",
"Дата постановки на кадастровый учет": "20.12.2001",
"Категория земель": "Земли населенных пунктов",
"Разрешенное использование": "Для индивидуальной жилой застройки",
"Площадь": "1427",
"Единица измерения (код)": "Квадратный метр",
"Кадастровая стоимость": "1167214,65",
"Дата определения стоимости": "19.02.2016",
"Дата внесения стоимости": "10.12.2016",
"Дата утверждения стоимости": "10.12.2016",
"Адрес (местоположение)": "обл. ая, г. , ул. Ильича, дом 48",
"Дата обновления информации": "10.12.2016",
"Форма собственности": "Частная",
"Количество правообладателей": "2"
},
"comment": "",
"date_create": "2017-03-05 20:34:26",
"price": 0,
"documents": [
{
"id": 540,
"type": "XZP",
"status": 4,
"date_complete": "2017-03-05 20:35:07",
"price": 0,
"rr_order_number": "80-874987445",
"note": ""
}
],
"error": []
}
Название | Тип | Описание |
---|---|---|
id, documents[n].transaction_id |
int | Номер заказа/транзакции |
cadnomer, documents[n].cadnomer |
string | Кадастровый номер объекта |
details | object | Характеристика объекта из ЕГРН, (произволное количество полей!) |
comment | string | Комментарий к заказу |
date_create, documents[n].date_create |
string | Дата время оформления заказа, в формате гггг.мм.дд ч:м:с |
price | float | Стоимость заказа |
documents | array | Заказанные документы |
documents[n].id, documents[n].document_id |
int | Номер документа |
documents[n].type | string | Вид документа XZP — Отчет об основных параметрах объекта недвижимости SOPP — Отчет об изменениях прав на объект недвижимости SKS — Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости KPT — Отчет об объектах недвижимости в пределах кадастрового плана территории |
documents[n].status | int | Статус документа в заказе 2 — Ожидает оплаты 3 — В работе 4 — Выполнен 5 — Ошибка при обработке 6 — Отменен |
documents[n].date_complete | string | Дата время выполнения заказа, в формате гггг.мм.дд ч:м:с |
documents[n].price | float | Стоимость данного документа в данном заказе |
documents[n].rr_order_number | string | Номер данного документа в базе ФГИС ЕГРН Росреестра |
documents[n].note | string | Примечания: fgis_not_found — Объект отсутствует в базе ФГИС ЕГРН (заказ не возможен) fgis_zero — Недостаточно средств по ключу ФГИС ЕГРН (когда используется ключ пользователя) Аннулированный — Объект аннулирован (заказ не возможен) |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Invalid parameter value/structure for `filters` | Некорректный фильтр. Возможно, что в указанных фильтрах отсутствует обязательный параметр или указано недопустимое значение для "column", "condition" или "after" |
400 | Maximum count of filter rules is 5000 | Допустимое максимальное количество фильтров 5 000 |
Cadaster/Download — Скачать документ
Возвращает скачиваемый файл в указанном форматеHTTP запрос
GET | POST https://apiegrn.ru/api/cadaster/download требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
document_id | Номер документа в заказе | |
format | Скачать документ в формате Для документов XZP, SOPP, SKS, KPT: PDF — Человеко-читаемый формат HTML — Как веб страница XML — Технический формат |
|
pdf_orientation (не обязательно) |
portrait — Книжная landscape — Альбомная (по умолчанию) |
Ориентация страницы PDF файла |
Ответ сервера
Бинарный файл
Название | Тип | Описание |
---|---|---|
нет параметров |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Unsupported file format | Некорректное значение для параметра "format". |
403 | Forbidden. Not own order | Заказ принадлежит другому пользователю. |
204 | Order not completed | Заказ находится в обработке, Попробуйте позже. |
Account/info — Информация об аккаунте
Возвращает общую информацию об аккаунте, балансе и тарифеHTTP запрос
GET | POST https://apiegrn.ru/api/account/info требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
нет |
Ответ сервера
{
"id": 720,
"balance": 15000,
"token": "JHSD-ZXBN-UBSD-MVDE",
"egrn_key": null,
"tariff": {
"user_id": 720,
"tariff": "1",
"date_install": "2018-01-16 12:28",
"date_burn": "2018-02-15 12:28",
"period_queries_max": 100,
"key_required": false,
"tariff_queries_max": 100,
"tariff_queries_done": 5,
"tariff_queries_available": 95,
"tariff_days": 30,
"tariff_days_available": 16,
"tariff_days_gone": 14,
"period_count": 1,
"period_current": 1,
"period_date_start": "2018-01-16 12:28",
"period_date_end": "2018-02-15 12:28",
"period_days": 30,
"period_days_available": 16,
"period_days_gone": 14,
"period_queries_done": 5,
"period_queries_available": 95,
"tariff_ended": false,
"effective": true
},
"error": []
}
Название | Тип | Описание |
---|---|---|
id | int | ID аккаунта |
balance | float | Баланс лицевого счета |
token | string | Токен |
tariff | object | Детали установленного тарифа |
tariff.tariff | string | Название тарифа |
tariff.date_install | string | Дата время начала действия тарифа |
tariff.date_burn | string | Дата время окончания действия тарифа |
tariff.period_queries_max | int | Количество запросов за текущий период |
tariff.tariff_queries_max | int | Количество запросов в период действия тарифа |
tariff.tariff_queries_done | int | Количество сделанных запросов в период действия тарифа |
tariff.tariff_queries_available | int | Остаток запросов до окончания действия тарифа |
tariff.tariff_days | int | Количество дней по тарифу |
tariff.tariff_days_available | int | Количество дней до окончания тарифа |
tariff.tariff_days_gone | int | Количество дней, прошедших с момента начала действия тарифа |
tariff.period_count | int | Количество период в тарифе |
tariff.period_current | int | Текущий период |
tariff.period_date_start | string | Дата время начала периода |
tariff.period_date_end | string | Дата время окончания периода |
tariff.period_days | int | Период в днях |
tariff.period_days_available | int | Количество дней до окончания периода |
tariff.period_days_gone | int | Количество дней, прошедших с момента начала периода |
tariff.period_queries_done | int | Количество сделанных запросов за текущий период |
tariff.period_queries_available | int | Остаток запросов до окончания периода |
tariff.tariff_ended | bool | Закончился ли срок действия тарифа |
tariff.effective | bool | Действует ли тариф и возможно ли сделать запрос |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки |
Reestr/Scan — Сканирование МКД
Сканирует и возвращает количество помещений входящих в состав многоквартирного дома.HTTP запрос
POST https://apiegrn.ru/api/reestr/scan требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
query | Например: 46:29:102219:80 |
Кадастровый номер МКД (указывается кадастровый номер самого дома, а не помещения в этом доме) |
scan_if_no_cache | 1 — Да (по умолчанию) 0 — Нет |
Начать сканирование при отсутствии в кэш данных об указанном МКД. Информация в кэш хранится 10 дня. |
Ответ сервера
// Сканируется...
{
"scan": "processing",
"note": "The scan began on 25.10.2017 15:42",
"reestr": null,
"error": []
}
// Сканирование завершено.
{
"scan": "completed",
"note": "The information is current as of 25.10.2017",
"reestr": {
"id": 89203,
"categories": {
"apartments_residential": {
"count": 107
},
"apartments_nonresidential": {
"count": 1
},
"others": {
"count": 0
}
},
"count": 108
},
"error": []
}
Название | Тип | Описание |
---|---|---|
scan | string | Состояние processing — Идет сканирование completed — Сканирование завершено impossible — Сканирование невозможно ----------------- no_result — В кэш отсутствуют данные об МКД (только при параметре "scan_if_no_cache = 0") |
note | string | Примечание зависит от состояния сканирования |
reestr | object | Информация о реестре |
reestr.id | int | ID отсканированного реестра |
reestr.categories | object | Категория объектов apartments_residential — Жилые помещения apartments_nonresidential — Нежилые помещения others — Прочее |
reestr.categories.категория.count | int | Количество объектов недвижимости данного типа |
reestr.count | int | Общее количество помещений в МКД |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
UNSUPPORTED_OBJECT_TYPE | Unsupported type of cadastral object | Неподдерживаемый тип объекта недвижимости. Укажите кадастровый номер МКД. |
Reestr/Rightholders — Составление реестра правообладателей
Оформляет заказ со статусом "Ожидает оплаты", возвращает номер заказа/транзакцииРеестр правообладателей многоквартирного дома
Реестр правообладателей земельного участка
HTTP запрос
POST https://apiegrn.ru/api/reestr/rightholders требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
of | LAND — Земельный участок MKD — Многоквартирный дом |
Составить (Реестр правообладателей) для объекта недвижимости указанного типа |
cadnomer (в случае земельного участка) |
Например: 46:29:101001:10 |
Кадастровый номер только земельного участка |
reestr_id (в случае МКД) |
Значение берём из запроса Reestr/Scan | Идентификатор сканированного реестра |
categories (в случае МКД) |
Например: categories[]=apartments_residential categories[]=apartments_nonresidential categories[]=others |
Составить (Реестр собственников) учитывая только указанные категория объектов. |
comment | Не обязательно | Комментарий к заказу |
Ответ сервера
{
"transaction_id": 179649,
"paid": true,
"error": []
}
Название | Тип | Описание |
---|---|---|
transaction_id | int | Номер заказа/транзакции |
paid | bool |
Оплачен ли заказ true — Да (если у вас предоплаченный тариф) false — Нет (если у вас тариф "Базовый", для оплаты см. Transaction/info) |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Bad parameter `cadnomer`, not a cadastral number | Переданное значение для "cadnomer" не соответствует формату кадастрового номера. Может возникнуть, если of = LAND |
OBJECT_NOT_FOUND | Cadastral object not found | Объект по указанному кадастровому номеру не найден. Может возникнуть, если of = LAND. 1. Проверьте кадастровый номер. 2. Возможно в ЕГРН отсутствуют сведения по этому объекту. |
BAD_CATEGORY_TYPE | Bad category type given | Переданный массив "categories" содержит неподдерживаемое значение. Может возникнуть, если of = MKD |
NULL_REESTR | Requested reestr does not contain a cadastral object | Запрошенный реестр по указанным категориям не содержит ни одного объекта недвижимости. Может возникнуть, если of = MKD |
IS_NOT_LAND | Cadastral object is not land | Кадастровый объект по указанному кадастровому номеру не является земельным участком. Может возникнуть, если of = LAND |
NO_RIGHTS | Cadastral object has no right holders | Кадастровый объект не имеет правообладателей. Может возникнуть, если of = LAND |
INSUFFICIENT_FUNDS | Insufficient funds on the account | Недостаточно количество запросов на остатке по тарифу. Продлите тариф или перейдите на другой. |
Reestr/FromFiles — Реестр из загруженных выписок
Формирует реестр в виде таблицы из загруженных пользователем оригинальных выписок (об объектах недвижимости) из ЕГРН Росреестра, возвращает номер сформированного реестра. Для скачивания используется метод Reestr/GetResulthttps://apiegrn.ru/public/xml_vizualization.php
HTTP запрос
POST https://apiegrn.ru/api/reestr/fromfiles требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
orders[] ↑ (один из параметров) ↓ |
Номера документов в заказах. |
Принимаются номера исполненных документов с типом XZP Максимальное количество загружаемых файлов: 1 000 шт. |
files[] | Оригинальные выписки из Росреестра в формате ZIP, содержащий .sig файл. |
Принимаются выписки с версий схемы: KPOKS 4.0 KVOKS 3.0 KVZU 7.0 Максимальное количество загружаемых файлов: 1 000 шт. |
Ответ сервера
{
"reestr_id": 158211423783217,
"ignored_files": [
"неверный_файл.rar": {
"code": "INVALID_INPUT_FILE"
}
],
"error": []
}
Название | Тип | Описание |
---|---|---|
reestr_id | int | Номер сформированного реестра. Используйте Reestr/GetResult для скачивания результата. |
ignored_files | array | Список файлов, которые не были включены в реестр (по какой либо причине). |
ignored_files[файл].code | string | INVALID_INPUT_FILE — Загруженный файл не в формате zip. XML_NOT_FOUND — В архиве не найден XML файл. SIG_NOT_FOUND — В архиве не найден SIG файл. INCORRECT_XML — XML файл не является выпиской об объекте ндвижимости. UNSUPPORTED_VERSION — Неподдерживаемая версия XML схемы выписки. INVALID_SIGNATURE — Подпись не верна. NO_CERTIFICATE_FOUND — Файл подписи (.sig) поврежден. UNTRUSTED_SIGNER — Выписка подписана не Росреестром. Все иные коды являются неизвестными ошибками. |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | No uploaded files | Файлы не передавались на сервер. Провертье корректность запроса. |
ALL_FILES_IGNORED | Аll uploaded files were ignored | Ни один загруженный файл не подходил под требования. Проверьте формат файлов и версий выписок. |
Reestr/Orders — Информация о заказе
Возвращает информацию о заказе и состояние заказа.HTTP запрос
POST https://apiegrn.ru/api/reestr/orders требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
id (не обязательно) |
Номер заказа/транзакции |
Ответ сервера
{
"id": 179649,
"comment": "",
"date_create": "2017-10-25 16:10:58",
"date_complete": "2017-10-25 18:32:47",
"price": 0,
"status": 4,
"completed": "108/108",
"categories": [
"apartments_residential",
"apartments_nonresidential"
],
"error": []
}
Название | Тип | Описание |
---|---|---|
id | int | Номер заказа/транзакции |
comment | string | Комментарий к заказу |
date_create | string | Дата время оформления заказа, в формате гггг.мм.дд ч:м:с |
date_complete | string | Дата время выполнения заказа, в формате гггг.мм.дд ч:м:с |
price | float | Стоимость заказа |
status | int | Статус заказа 2 — Ожидает оплаты 3 — В работе 4 — Выполнен 5 — Ошибка при обработке 6 — Отменен |
completed | string | Объектов в реестре "обработано/из_всего" |
categories | string | В реестр собственников учтены только указанные категория объектов |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
403 | Forbidden. Not own order | Заказ принадлежит другому пользователю. |
Reestr/GetResult — Получить реестр правообладателей
Возвращает скачиваемый файл в указанном формате.В скачиваемом файле Реестра правообладателей имеются ссылки для просмотра и скачивания выписок/отчетов включенным в Реестр.
HTTP запрос
POST https://apiegrn.ru/api/reestr/getresult требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
format | Получить результат в формате: XLSX — Файл (Excel) HTML — Как веб страница PDF — Человеко-читаемый формат |
|
Параметры для скачивания реестра сформированного методом Reestr/FromFiles | ||
reestr_id | Номер реестра из Reestr/FromFiles | |
columns (array) | Например: columns[]=n columns[]=CadastralNumber columns[]=FullAddress columns[]=Right.owners.name columns[]=DocumentLink |
Поля, которые можно включить в реестр: (При пустом значении columns, будут включены все поля) n — № п/п RequeryNumber — Номер документа в ФГИС RequeryDate — Дата запроса в ФГИС ExtractDate — Дата выписки CadastralNumber — Кадастровый номер ObjectType — Тип объекта ParcelCategory — Категория земель ParcelUtilization — Вид разрешенного использования State — Статус объекта AssignationCode — Назначение помещения AssignationType — Вид жилого помещения Area — Общая площадь (кв.м) Levels — Этаж CadastralCost — Кадастровая стоимость (руб.) FullAddress — Адрес Address.Region — Регион Address.District.Name — Район Address.City.Name — Муниципальное образование Address.UrbanDistrict.Name — Городской район Address.SovietVillage.Name — Сельсовет Address.Locality.Name — Населённый пункт Address.Street.Name — Улица Address.Level1.Value — Дом Address.Level2.Value — Корпус Address.Level3.Value — Строение Address.Apartment.Value — Помещение OwnersCount — Кол-во зарегистрированных правообладателей Right.owners.type — Тип правообладателя Right.owners.name — ФИО правообладателей Right.registration.type — Вид права Right.registration.share — Разме рдоли Right.registration.name — Дата и номер записи государственной регистрации права Right.registration.number — Номер записи государственной регистрации права Right.registration.regDate — Дата записи государственной регистрации права Right.registration.endDate — Дата прекращения права Right.hasEncumbrance — Наличие обременений Right.encumbrances.name — Вид обременения Right.encumbrances.number — Номер государствеенной регистрации обременения Right.encumbrances.shareText — Предмет ограничения Right.encumbrances.started — Дата начала действия ограничения Right.encumbrances.stopped — Дата прекращения действия ограничения Right.encumbrances.term — Продолжительность ограничения Notes — Особые отметки ReceivName — Получатель выписки DocumentLink — Выписка из ЕГРН (ссылки) |
sort_objects (object) | sort_objects[поле] = направление Например: { "CadastralNumber": "ASC", "ExtractDate": "DESC" } |
Поля по которым можно сортировать объекты в списке: RequeryNumber — Номер документа в ФГИС RequeryDate — Дата запроса в ФГИС ExtractDate — Дата выписки CadastralNumber — Кадастровый номер ObjectType — Тип объекта ParcelCategory — Категория земель ParcelUtilization — Вид разрешенного использования State — Статус объекта AssignationCode — Назначение помещения AssignationType — Вид жилого помещения Area — Общая площадь (кв.м) Levels — Этаж CadastralCost — Кадастровая стоимость (руб.) FullAddress — Адрес Address.Region — Регион Address.District.Name — Район Address.City.Name — Муниципальное образование Address.UrbanDistrict.Name — Городской район Address.SovietVillage.Name — Сельсовет Address.Locality.Name — Населённый пункт Address.Street.Name — Улица Address.Level1.Value — Дом Address.Level2.Value — Корпус Address.Level3.Value — Строение Address.Apartment.Value — Помещение OwnersCount — Кол-во зарегистрированных правообладателей Notes — Особые отметки ReceivName — Получатель выписки |
Параметры для скачивания реестра сформированного методом Reestr/Rightholders | ||
transaction_id | Номер заказа/транзакции | |
custom_header (не обязательно) |
Например:
<center>
<h1>Заголовок реестра</h1> </center> |
HTML-код для заголовка реестра. По умолчанию:
<center>
<h1> Реестр<br> правообладателей объекта недвижимости </h1> </center> |
sort_objects (object) | sort_objects[поле] = направление Например: { "apartment": "ASC", "cadcost": "DESC" } |
Поля по которым можно сортировать объекты в списке: apartment — Номер помещения floor — Этаж cadnomer — Кадастровый номер area — Площадь cadcost — Кадастровый стоимость Направления сортировки: ASC — По возрастанию DESC — По убыванию |
sort_rights (object) | sort_rights[поле] = направление Например: { "hasEncumbrance": "DESC" } |
Поля по которым можно сортировать правообладателей объекта недвижимости: name — ФИО собственника hasEncumbrance — Наличие обременений Направления сортировки: ASC — По возрастанию DESC — По убыванию |
Ответ сервера
// Файл
Название | Тип | Описание |
---|---|---|
нет параметров |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
204 | Order not paid or canceled | Заказ ожидает оплаты или был отменен. Проверьте состояние заказа с помощью метода Reestr/Orders |
400 | Unsupported file format | Некорректное значение для параметра "format". |
403 | Forbidden. Not own order | Заказ принадлежит другому пользователю. |
Monitoring/Calc — Калькулятор стоимости мониторинга
Возвращает стоимость мониторинга исходя из указанного типа подписки, количество объектов, продолжительности и частоты проверки.HTTP запрос
POST https://apiegrn.ru/api/monitoring/calc требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
type | simple — «Простая» Без указания изменений произошедших в объектах недвижимости, без изменения списка объектов мониторинга. detailed — «Расширенная» С указанием изменений произошедших в объектах недвижимости, без изменения списка объектов мониторинга. detailed_editable — «Расширенная +» С указанием изменений произошедших в объектах недвижимости, с возможностью изменения списка объектов мониторинга. |
Тип подписки (тип контейнера). |
count | минимум — 1, максимум — 500 000 | Количество объектов мониторинга. |
period | 30, 60, 90, 120, 150, 180, 210, 240, 270, 300, 330, 360 | Продолжительность мониторинга (в днях). |
frequency | 1, 3, 5, 10, 15, 30 | Частота проверки сведений в ЕГРН. Проверять каждые (дней). |
Ответ сервера
{
"price": 4185,
"error": []
}
Название | Тип | Описание |
---|---|---|
price | int | Итоговая стоимость мониторинга (к оплате в рублях) |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки |
Monitoring/Container — Оформление нового контейнера для отслеживания изменений в объектах недвижимости
Оформляет заказ со статусом "Ожидает оплаты", возвращает номер заказа/транзакции и номер контейнера.HTTP запрос
POST https://apiegrn.ru/api/monitoring/container требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
type | simple — Без указания изменений произошедших в объектах недвижимости, без изменения списка объектов мониторинга. detailed — С указанием изменений произошедших в объектах недвижимости, без изменения списка объектов мониторинга. detailed_editable — С указанием изменений произошедших в объектах недвижимости, с возможностью изменения списка объектов мониторинга. |
Тип подписки (тип контейнера). |
size | минимум — 1, максимум — 500 000 | Размер контейнера. Укажите исходя из количество объектов мониторинга. |
period | 30, 60, 90, 120, 150, 180, 210, 240, 270, 300, 330, 360 | продолжительность мониторинга (в днях). |
frequency | 1, 3, 5, 10, 15, 30 | Частота проверки сведений в ЕГРН. Проверять каждые (дней). |
start_date | Не обязательно | Дата начала мониторинга (от текущей даты, но не более года), в формате гггг-мм-дд ----------------- По умолчанию — дата оплаты заказа. |
comment | Не обязательно | Комментарий к заказу/контейнеру |
Ответ сервера
{
"transaction_id": 2060868,
"container_id": 9,
"paid": false,
"error": []
}
Название | Тип | Описание |
---|---|---|
transaction_id | int | Номер заказа/транзакции |
container_id | int | Номер контейнера |
paid | bool |
Оплачен ли заказ true — Да false — Нет (для оплаты см. Transaction/info) |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
INVALID_START_DATE | Invalid start date format | Некорректный формат даты для параметра `start_date`. |
BAD_START_DATE | Start date is not in range | Укажите дату начала мониторинга в правильном диапазоне (от текущей даты, но не более года) |
Monitoring/Orders — Информация о заказе
Возвращает характеристика контейнера, цена, состояние, (по номеру заказа или по фильтру).HTTP запрос
POST https://apiegrn.ru/api/monitoring/orders требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
id | (Не обязателно) Номер заказа/транзакции |
Используйте данный параметр для получения подробной информации о конкретном оформленном контейнере. |
filters (array) | (Не обязателно) Ниже приведен пример. |
При ипользовании данного параметра, предедущый параметр `id` будет игнорироваться! ------------------------------------------ Используйте данный параметр для получения подробной информации по определенным критериям сразу о нескольких заказах. ------------------------------------------ filters[n].column — Название поля filters[n].condition — Оператор сравнения filters[n].value — Значение filters[n].after — Логический оператор по отношению к след. фильтру Поля Операторы сравнения transaction_id | = | != | < | > | <= | >= | container_id | = | != | < | > | <= | >= | size | = | != | < | > | <= | >= | period | = | != | < | > | <= | >= | frequency | = | != | < | > | <= | >= | type | = | != date_create | = | != | < | > | <= | >= | start_date | = | != | < | > | <= | >= | end_date | = | != | < | > | <= | >= | price | = | != | < | > | <= | >= | status | = | != | < | > | <= | >= | |
ascending (к параметру filters) |
1 — Да 0 — Нет (по умолчанию) |
Сортировка по возрастанию. Производится по дате создания. |
offest (к параметру filters) |
минимум — 0, максимум — ∞ | Смещение относительно начала получаемого списка. (По умолчанию - 0) |
limit (к параметру filters) |
минимум — 1, максимум — 10 000 | Количество записей в списке, которые должны получить. (По умолчанию - 500) |
Ответ сервера
// С использованием параметра `filters`
{
"list": [
{
"transaction_id": 2060868,
"container_id": 9,
"size": 100,
"period": 90,
"frequency": 10,
"type": "detailed_editable",
"date_create": "2019-08-23 12:52:11",
"start_date": "2019-08-24",
"end_date": "2019-11-22",
"price": 4500,
"comment": "",
"status": 2,
"objects_count": {
"active": 95,
"deleted": 0
}
},
{
"transaction_id": 2060867,
"container_id": 8,
"size": 1,
"period": 60,
"frequency": 3,
"type": "simple",
"date_create": "2019-08-23 11:15:53",
"start_date": "2019-08-23",
"end_date": "2019-09-22",
"price": 99,
"comment": "",
"status": 3,
"objects_count": {
"active": 1,
"deleted": 0
}
}
],
"shown": 2,
"total": 2,
"limit": 500,
"offset": 0,
"error": []
}
// С использованием параметра `id`
{
"transaction_id": 2060868,
"container_id": 9,
"size": 100,
"period": 90,
"frequency": 10,
"type": "detailed_editable",
"date_create": "2019-08-23 12:52:11",
"start_date": "2019-08-24",
"end_date": "2019-11-22",
"price": 4500,
"comment": "",
"status": 2,
"objects_count": {
"active": 95,
"deleted": 0
},
"error": []
}
Название | Тип | Описание |
---|---|---|
transaction_id | int | Номер заказа/транзакции |
container_id | int | Номер оформленного контейнера |
size | int | Размер контейнера |
period | int | продолжительность мониторинга (в днях). |
frequency | int | Частота проверки сведений в ЕГРН (в днях). |
type | int | Тип подписки (тип контейнера) simple — Без указания изменений произошедших в объектах недвижимости, без изменения списка объектов мониторинга. detailed — С указанием изменений произошедших в объектах недвижимости, без изменения списка объектов мониторинга. detailed_editable — С указанием изменений произошедших в объектах недвижимости, с возможностью изменения списка объектов мониторинга. |
date_create | string | Дата время оформления заказа/контейнера, в формате гггг-мм-дд ч:м:с |
start_date | string | Дата начала мониторинга. |
end_date | string | Дата завершения мониторинга. |
price | int | Стоимость заказа/контейнера. |
comment | string | Комментарий к заказу/контейнеру. |
status | int | Статус заказа/контейнера 2 — Ожидает оплаты 3 — В работе 4 — Выполнен 5 — Ошибка при обработке 6 — Отменен |
objects_count | object | Информация о количестве объектов в контейнере. |
objects_count.active | int | Количество активных объектов. |
objects_count.deleted | int | Количество когда либо удаленных объектов. |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Invalid parameter value/structure for `filters` | Некорректный фильтр. Возможно, что в указанных фильтрах отсутствует обязательный параметр или указано недопустимое значение для "column", "condition" или "after" |
400 | Maximum count of filter rules is 5000 | Допустимое максимальное количество фильтров 5 000 |
403 | Forbidden. Not own order | Заказ принадлежит другому пользователю. |
Monitoring/GetReport — Отчёт по мониторингу контейнера
Возвращает список объектов в контейнере с исторями изменений.HTTP запрос
POST https://apiegrn.ru/api/monitoring/getreport требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
container_id | Номер контейнера | |
show_changes | 1 — Да (по умолчанию) 0 — Нет |
Показать историю изменений по объектам недвижимости. |
with_previous (к параметру show_changes) |
1 — Да (по умолчанию) 0 — Нет |
К каждому изменению показать информацию о предыдущем состоянии. |
filters (array) | (Не обязателно) Ниже приведен пример. |
Используйте данный параметр для получения информации по объектам по определенным критериям. ------------------------------------------ filters[n].column — Название поля filters[n].condition — Оператор сравнения filters[n].value — Значение filters[n].after — Логический оператор по отношению к след. фильтру Поля Операторы сравнения id | = | != | < | > | <= | >= | cadnomer | = | != date_create | = | != | < | > | <= | >= | date_delete | = | != | < | > | <= | >= | delete_reason | = | != deleted | = | != |
only_changed_objects | 1 — Да 0 — Нет (по умолчанию) |
Получить список только измененных объектов (параметр идет в качестве дополнительного фильтра). |
ascending (к параметру filters) |
1 — Да 0 — Нет (по умолчанию) |
Сортировка по возрастанию. Производится по дате создания. |
offest (к параметру filters) |
минимум — 0, максимум — ∞ | Смещение относительно начала получаемого списка. (По умолчанию - 0) |
limit (к параметру filters) |
минимум — 1, максимум — 1 000 | Количество записей в списке, которые должны получить. (По умолчанию - 100) |
Ответ сервера
{
"objects": [
{
"id": 26,
"cadnomer": "46:29:101001:200",
"date_create": "2019-08-28 16:47:53",
"date_delete": "",
"delete_reason": "",
"deleted": false,
"changes": [
{
"detection_date": "2019-09-18 11:36:47",
"actual_date": "2019-09-18",
"document": {
"html": "https://apiegrn.ru/api/cadaster/getFile/811...htmlview",
"pdf": "https://apiegrn.ru/api/cadaster/getFile/811...pdf",
"xml": "https://apiegrn.ru/api/cadaster/getFile/811...xml"
},
"changed_regions": ["Rights", "Other"],
"previous": {
"detection_date": "2019-09-14 02:56:55",
"actual_date": "2019-09-14",
"document": {
"html": "https://apiegrn.ru/api/cadaster/getFile/953...htmlview",
"pdf": "https://apiegrn.ru/api/cadaster/getFile/953...pdf",
"xml": "https://apiegrn.ru/api/cadaster/getFile/953...xml"
}
}
},
{
"detection_date": "2019-09-14 02:56:55",
"actual_date": "2019-09-14",
"document": {
"html": "https://apiegrn.ru/api/cadaster/getFile/953...htmlview",
"pdf": "https://apiegrn.ru/api/cadaster/getFile/953...pdf",
"xml": "https://apiegrn.ru/api/cadaster/getFile/953...xml"
},
"changed_regions": ["CadastralCost"],
"previous": {
"detection_date": "2019-08-29 16:32:18",
"actual_date": "2019-08-28",
"document": {
"html": "https://apiegrn.ru/api/cadaster/getFile/902...htmlview",
"pdf": "https://apiegrn.ru/api/cadaster/getFile/902...pdf",
"xml": "https://apiegrn.ru/api/cadaster/getFile/902...xml"
}
}
}
]
},
{
"id": 27,
"cadnomer": "46:29:101001:300",
"date_create": "2019-08-28 10:20:53",
"date_delete": "2019-09-10 05:48:15",
"delete_reason": "user",
"deleted": true,
"changes": []
}
],
"shown": 2,
"total": 2,
"limit": 100,
"offset": 0,
"error": []
}
Название | Тип | Описание |
---|---|---|
objects | array | Список объектов в контейнере. |
objects.id | int | Номер объекта в контейнере. |
objects.cadnomer | string | Кадастровый номер объекта. |
objects.date_create | string | Дата время добавления объекта в контейнер, в формате гггг-мм-дд чч:мм:сс |
objects.date_delete | string | Дата время удаления объекта из контейнера, в формате гггг-мм-дд чч:мм:сс |
objects.delete_reason | string | Причина удаления объекта из контейнера: user — Удален по запросу пользователя. fgis_not_found — Объект отсутствует в базе ФГИС ЕГРН. Аннулированный — Объект аннулирован. |
objects.changed_regions | array | Список обнаруженых изменений: Area — Площадь Rights — Права, правообладатели, аресты, запреты и иные обременения (раздел 2 в выписке из ЕГРН) Address — Адрес объекта CadastralCost — Кадастровой стоимость Other — Другие изменения |
objects.deleted | bool | Удален ли объект из контейнера true — Да false — Нет |
objects.changes | array | Список/история изменений в результате мониторинга (сортировка: сначала свежие). |
objects.changes[n].detection_date | string | Дата время обнаружения изменения, в формате гггг-мм-дд чч:мм:сс ------------- Датой обнаружения изменений считается дата и время получения нашим сервисом сведений из ЕГРН Росреестра. Данная дата может отличаться от даты внесения Росреестром сведений в ЕГРН, так как между периодом внесения Росреестром сведений в ЕГРН и их отражением в ФГИС ЕГРН и/или получением выписки, проходит некоторое время, которое может достигать нескольких дней. Данные временные интервалы возникают из за специфики работы ЕГРН, ФГИС ЕГРН и некоторых других сервисов Росреестра. |
objects.changes[n].actual_date | string | Актуальная дата сведений в ЕГРН, в формате гггг-мм-дд |
objects.changes[n].document | object | Ссылки на полученную выписку из ЕГРН Росреестра в разных форматах. |
objects.changes[n].document.html | string | Ссылкa на отчет в формате HTML. |
objects.changes[n].document.pdf | string | Ссылкa на отчет в формате PDF. |
objects.changes[n].document.xml | string | Ссылкa на отчет в формате XML. |
objects.changes[n].previous | object | Информация о предедущем изменении. Данный параметр схож с changes[n] |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | Invalid parameter value/structure for `filters` | Некорректный фильтр. Возможно, что в указанных фильтрах отсутствует обязательный параметр или указано недопустимое значение для "column", "condition" или "after" |
400 | Maximum count of filter rules is 5000 | Допустимое максимальное количество фильтров 5 000 |
403 | Forbidden. Not own order | Контейнер принадлежит другому пользователю. |
404 | Container by id not found | Контейнер по такому номеру не найден. |
Monitoring/Add — Добавление объектов в контейнер для отслеживания
Добавляет в контейнер объекты по кадастровым номерам для мониторинга.HTTP запрос
POST https://apiegrn.ru/api/monitoring/add требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
container_id | Номер контейнера | |
cadnomers (array) | Например: cadnomers[]=46:29:101001:10 cadnomers[]=46:29:101001:15 cadnomers[]=46:29:101001:100 |
Список кадастровых номеров для добавления в контейнер. Список может содержать до 1000 кадастровых номеров в каждом запросе на добавление. -------------- Кадастровые номера в списке не должны повторяться. |
Ответ сервера
// При успешном добавлении
{
"error": []
}
// Если некоторые объекты уже существуют в этом контейнере
{
"existing_cadnomers": [
"46:29:101001:10",
"46:29:101001:15"
],
"error": {
"code": "ALREADY_EXISTS",
"mess": "One or more cadastral numbers already exists in container"
}
}
// Если некоторые записи в списке не сответствуют формату кадастрового номера объекта недвижимости
{
"invalid_cadnomers": [
"46-29-101001-10"
"46:29:101001"
],
"error": {
"code": "INVALID_CADNOMERS",
"mess": "In given list exists one or more invalid cadastral numbers of objects"
}
}
Название | Тип | Описание |
---|---|---|
existing_cadnomers | array | Список кадастровых номеров, которые уже существуют в контейнере. |
invalid_cadnomers | array | Список записей не соответствующих формату кадастрового номера объекта недвижимости. |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
404 | Container by id not found | Контейнер по данному номеру не найден. |
403 | Forbidden. Not own order | Контейнер принадлежит другому пользователю. |
INVALID_CADNOMERS | In given list exists one or more invalid cadastral numbers of objects | Не все записи в списке соответствуют формату кадастрового номера объекта недвижимости. |
DUPLICATES_FOUND | In given list are duplicate cadastral numbers | Удалите дубликаты кадастровых номеров из списка. |
CONTAINER_EXPIRED | Container was expired | Срок действия контейнера истек (подписка закончилась). |
ALREADY_EXISTS | One or more cadastral numbers already exists in container | Некоторые объекты уже существуют в контейнере. |
OVERSIZE | Not enough free space in the container | Недостаточно свободного места в контейнере. |
Monitoring/Delete — Удаление объектов из контейнера
Удаляет из контейнера объекты по кадастровым номерам.Внимание! При удалении объектов из контейнера типа simple или detailed, удаленные объекты не освобождают место в контейнере для новых объектов, так как эти два типа контейнеры не редактируемые.
HTTP запрос
POST https://apiegrn.ru/api/monitoring/delete требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
container_id | Номер контейнера | |
cadnomers (array) | Например: cadnomers[]=46:29:101001:10 cadnomers[]=46:29:101001:15 |
Список кадастровых номеров для удалиения из контейнера. -------------- Список может содержать до 1000 кадастровых номеров в каждом запросе на удаления. |
Ответ сервера
{
"error": []
}
Название | Тип | Описание |
---|---|---|
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
404 | Container by id not found | Контейнер по данному номеру не найден. |
403 | Forbidden. Not own order | Контейнер принадлежит другому пользователю. |
CONTAINER_EXPIRED | Container was expired | Срок действия контейнера истек (подписка закончилась). |
Tools/XMLConverter — Конвертирование выписок в PDF и HTML
Возвращает скачиваемый файл в указанном форматеHTTP запрос
POST https://apiegrn.ru/api/tools/xmlconverter требуется авторизация по токену
Параметры запроса | Значение | Описание |
---|---|---|
input | XML или ZIP файл | Выписка из ЕГРН Росреестра |
output | Конвертировать документ в: PDF — Человеко-читаемый формат HTML — Как веб страница |
|
pdf_orientation (не обязательно) |
portrait — Книжная landscape — Альбомная (по умолчанию) |
Ориентация страницы PDF файла |
Ответ сервера
Бинарный файл
Название | Тип | Описание |
---|---|---|
нет параметров |
Коды ошибок | Описание | Причины и решения |
---|---|---|
Универсальные ошибки | ||
400 | No uploaded file | Файл не передавался на сервер. Провертье корректность запроса. |
400 | Unsupported input format | Некорректный формат загруженнего файла. |
400 | Unsupported output format | Некорректное значение для параметра "output". |
INCORRECT_XML | Incorrect input file | Загруженный файл не является выпиской из ЕГРН. |
Web Hooks
Механизм оповещения системы о событиях
Вы можете настроить HTTP адреса ваших приложений в настройках своего аккаунта, в разделе «Техническая информация»
События: status_change — когда меняется статус заказанного документа
POST Отправляется уведомление в стандартном формате urlencoded по URL адресу указанным вами в личном кабинетеПараметры запроса
Параметр | Значение | Описание |
---|---|---|
event | status_change | Тип события |
data[transaction_id] | 80140 | Номер заказа/транзакции |
data[document_id] | 540 | Номер документа в заказе |
data[document_type] | XZP | Вид документа XZP — Отчет об основных параметрах объекта недвижимости SOPP — Выписка о переходе прав SKS — Выписка о кадастровой стоимости KPT — Отчет об объектах недвижимости в пределах кадастрового плана территории |
data[document_status] | 4 | Статус документа 2 — Заявка сохранена 3 — В работе 4 — Выполнен 5 — Ошибка при обработке 6 — Отменен |
События: reestr_status_change — когда меняется статус заказанного реестра
POST Отправляется уведомление в стандартном формате urlencoded по URL адресу указанным вами в личном кабинетеПараметры запроса
Параметр | Значение | Описание |
---|---|---|
event | reestr_status_change | Тип события |
data[transaction_id] | 212309 | Номер заказа/транзакции |
data[status] | 4 | Статус документа 2 — Заявка сохранена 3 — В работе 4 — Выполнен 5 — Ошибка при обработке 6 — Отменен |
События: monitoring_change_detected — когда обнаруживаются изменения в ЕГРН при мониторинге объектов
POST Отправляется уведомление в стандартном формате urlencoded по URL адресу указанным вами в личном кабинетеПараметры запроса
Параметр | Значение | Описание |
---|---|---|
event | monitoring_change_detected | Тип события |
data[transaction_id] | 232852 | Номер заказа/транзакции |
data[container_id] | 9 | Номер контейнера |
data[object_id] | 24 | Номер объекта в контейнере |
data[cadnomer] | 46:29:101001:100 | Кадастровый номер объекта |
data[changed_regions] | ["Rights", "CadastralCost"] | Список обнаруженых изменений: Area — Площадь Rights — Права, правообладатели, аресты, запреты и иные обременения (раздел 2 в выписке из ЕГРН) Address — Адрес объекта CadastralCost — Кадастровой стоимость Other — Другие изменения |
События: monitoring_object_deleted — когда удаляется объект из контейнера
POST Отправляется уведомление в стандартном формате urlencoded по URL адресу указанным вами в личном кабинетеПараметры запроса
Параметр | Значение | Описание |
---|---|---|
event | monitoring_object_deleted | Тип события |
data[transaction_id] | 232852 | Номер заказа/транзакции |
data[container_id] | 9 | Номер контейнера |
data[object_id] | 24 | Номер объекта в контейнере |
data[cadnomer] | 46:29:101001:100 | Кадастровый номер объекта |
data[delete_reason] | user | Причина удаления объекта из контейнера: user — Удален по запросу пользователя. fgis_not_found — Объект отсутствует в базе ФГИС ЕГРН. Аннулированный — Объект аннулирован. |
Коды универсальных ошибок
Коды ошибок | Описание | Причины и решения |
---|---|---|
400 | Missing required parameter | Отсутствует обязательный параметр. |
400 | Invalid parameter value | Передано некорректное значение для какого-либо параметра. |
401 | Unauthorized | В запросе не указан HTTP заголовок - Token, либо токен неверный. Свой токен можете посмотреть в своем личном кабинете. |
429 | Too Many Parallel Requests | Делается много параллельных запросов с одного IP |
500 | Internal Server Error | Произошла непредвиденная ошибка. Пожалуйста, обратитесь в службу поддержки! |
503 | Service is temporarily unavailable | Сервис временно недоступен. Попробуйте позже. |
Пример ответа API при возникновении ошибки:
{
"error": {
"code": 401,
"mess": "Unauthorized"
}
}
Ответ API при отсутствии ошибки:
{
"error": []
}
Инструкция и примеры
Образцы документов:
Отчет об изменениях прав на объект недвижимости
Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости
Реестр правообладателей многоквартирного дома
Реестр правообладателей земельного участка
Отчет об объектах недвижимости в пределах кадастрового плана территории
Полезные материалы:
Как авторизоваться по токену
Для авторизации, необходимо в запросах указать HTTP заголовок - Token: ВАШ_ТОКЕН, например Token: OIMG-PPSH-XYMX-G9WG Свой Токен-ключ, который является уникальным и секретним, можете найти в своем личном кабинете. |
Требования
В целях повышения производительности, настоятельно рекомендуем, при формировании запросов к API, в ваших Http-клиентах включить опцию "следить за перенаправленями", например для cURL в PHP (CURLOPT_FOLLOWLOCATION задать true). |
Формирование заявки на получение отчета (состоит из 5 шагов)
Чтобы сформировать заявку на получение отчета, вам необходимо указать кадастровый номер объекта недвижимости. Если вам не известен кадастровый номер объекта, то узнать его можно по адресу объекта, используя метод Cadaster/Search. | |
1. | Передаем кадастровый номер в Cadaster/ObjectInfoFull, получаем характеристики объекта, цены на документы и параметр "encoded_object", который понадобится на следующем шаге. |
2. | Для оформления заказа, вызываем Cadaster/Save_order передаем значение "encoded_object", которое мы получили на предыдущем шаге, a также передаем список необходимых для заказа документов. В ответ мы получаем номер заказа/транзакции и номера документов в заказе, которые сохраняем для следующих шагов. |
3. | Если вы не используете тариф "Базовый" то пропустите этот шаг, в противном случае, совершите оплату используя метод Transaction/info для получения всех возможных способов оплаты. |
4. | Заказ передан в обработку, ожидаем исполнения заказа. |
5. | Скачиваем документ с помощью Cadaster/Download передаем номер документа в заказе и один из следующих форматов (PDF, HTML или XML). |
Сушествуют два способа:
1. Вы можете периодически проверить статус заказа, используя метод Cadaster/Orders.
2. В своем личном кабинете вы можете настроить Web Hook (для события "status_change"), указав URL вашего сервера,
на который будут отправляться HTTP-уведомления, если у заказа или у документа в заказе изменится статус.
Пример PHP кода:
<?php
/*
Пример простого PHP скрипта для оформления заявок на получение выписок из ЕГРН Росреестра.
Работает с сервисом (ApiEGRN.ru)
Тестирован на PHP v5.6
Источник - https://apiegrn.ru/api/#examples
Автор - Hayk Marukyan (Haikson)
*/
# Кадастровый номер нашего объекта недвижимости.
$cadnomer = '46:29:101001:10';
# Заказываемый документ
# XZP - Отчет об основных параметрах объекта недвижимости
# SOPP - Отчет об изменениях прав на объект недвижимости
# SKS - Отчет об установлении и/или изменении кадастровой стоимости объекта недвижимости
# KPT - Отчет об объектах недвижимости в пределах кадастрового плана территории
$mydoc = 'XZP';
# Функция для вызова методов ApiEGRN
function api($class, $params = [], $token = 'XXXX-XXXX-XXXX-XXXX') {
$class = strtolower($class);
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_POST => 1,
CURLOPT_HTTPHEADER => ["Token: $token"],
CURLOPT_RETURNTRANSFER => 1,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_FORBID_REUSE => 1,
CURLOPT_VERBOSE => 1,
CURLOPT_SSL_VERIFYPEER => 0,
]);
curl_setopt($ch, CURLOPT_URL, "https://apiegrn.ru/api/$class");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
$exec = curl_exec($ch);
$data = json_decode($exec, 1);
if ($data && $data['error']) {
die("Произошла ошибка - [<a href='/api/#$class'>$class</a>] {$data['error']['code']}, {$data['error']['mess']}");
}
curl_close($ch);
return $data ?: $exec;
}
# Шаг 1/3 - Получаем характеристики объекта, цены на документы...
$info = api('Cadaster/ObjectInfoFull', ['query' => $cadnomer]);
# Проверяем доступность документа для заказа
if ($info['documents'][$mydoc]['available'] == false) {
die('На данный объект недвижимости невозможно заказать документ - '.$mydoc);
}
# Шаг 2/3 - Оформляем заказ
$save = api('Cadaster/Save_order', ['encoded_object' => $info['encoded_object'], 'documents' => [$mydoc], 'comment' => 'тестовый заказ']);
// Если заказ оплачен, т.е. у нас тариф не "Базовый"
if ($save['paid'] == true) {
die("Заказ оформлен и передан в обработку. Номер заказа ".$save['transaction_id'].", номер документа в заказе ".$save['documents_id'][$mydoc]);
}
// Если заказ ожидает оплаты, т.е. если тариф у нас "Базовый"
else {
# Пытаемся оплатить с лицевого счета
# Шаг 3/3 - Получаем перечень всех возможных способов оплаты
$trans = api('Transaction/info', ['id' => $save['transaction_id']]);
// Если оплата с лицевого счета разрешена
if ($trans['pay_methods']['PA']['allowed'] == true) {
// Если достаточно средств на счете
if ($trans['pay_methods']['PA']['sufficient_funds'] == true) {
# Подтверждаем оплату
$pay = api('Transaction/pay', ['id' => $save['transaction_id'], 'confirm' => $trans['pay_methods']['PA']['confirm_code']]);
// Если оплата прошла успешно
if ($pay['paid'] == true) {
die("Заказ оплачен и передан в обработку. Номер заказа ".$save['transaction_id'].", номер документа в заказе ".$save['documents_id'][$mydoc]);
} else {
die('Не удалось оплатить заказ.');
}
} else {
die('Недостаточно средств на лицевом счете. Воспользуйтесь другими способами оплаты.');
}
} else {
die('Оплата с лицевого счета не допускается для этого заказа.');
}
}
?>
Ограничения
При работе с API действуют следующие ограничения:
1. | Не более 10 параллельных запросов с одного IP адреса. При большей потребности, обращайтесь в техподдержку. |
2. | Максимальное количество возвращаемых Росреестром объектов 200, но в некоторых случаях может быть и больше, это не ошибка (это отностися к методу Cadaster/Search). |