## Документация API получения выписки из ЕГРН

Сервис поддерживает два типа запросов:

1. **Поиск объектов недвижимости по адресу**
2. **Получение информации об объекте недвижимости по кадастровому номеру**

Все запросы требуют указания ключа доступа (`key`).

---

### 1. Поиск объектов недвижимости по адресу

Если кадастровый номер объекта неизвестен, можно получить список объектов недвижимости по адресу:

```
https://service.api-assist.com/parser/egrn_api/search_by_address
```

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

- **key** — ключ доступа к сервису (обязательный).
- **address** — адрес объекта недвижимости для поиска (обязательный).

**Пример запроса по адресу:**

```
https://service.api-assist.com/parser/egrn_api/search_by_address?key=ВАШ_КЛЮЧ_ДОСТУПА&address=Москва,%20ул.%20Маршала%20Тухачевского,%20д.%2033,%20кв.%20136
```

**Пример ответа на запрос:**

```json
{
  "success": 1, // Флаг успешности выполнения запроса. При получении 0 сделайте повторный запрос сразу же или через несколько минут.
  "records": [
    {
      "cad_number": "77:08:0010008:6713", // Кадастровый номер найденного объекта
      "address": "Москва, Хорошево-Мневники, ул. Маршала Тухачевского, д. 33, кв. 136" // Адрес объекта (необходимо сравнить с запрашиваемым)
    }
  ]
}
```

**Рекомендуемый процесс работы:**
1. Выполните запрос по адресу для получения списка кадастровых номеров.
2. Сравните полученные адреса с искомым адресом.
3. Используйте нужный кадастровый номер для получения детальной информации об объекте.

---

### 2. Получение информации об объекте недвижимости по кадастровому номеру

Для получения детальной информации об объекте недвижимости используйте следующий запрос:

```
https://service.api-assist.com/parser/egrn_api/details_by_number
```

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

- **key** — ключ доступа к сервису (обязательный).
- **cadNumber** — кадастровый номер объекта недвижимости (обязательный).

**Пример запроса по кадастровому номеру:**

```
https://service.api-assist.com/parser/egrn_api/details_by_number?key=ВАШ_КЛЮЧ_ДОСТУПА&cadNumber=77:08:0010008:6713
```

**Пример ответа на запрос:**

Ответ на запрос возвращается в формате JSON. Пример ответа:

```json
{
  "success": 1, // Флаг успешности выполнения запроса. При получении 0 сделайте повторный запрос сразу же или через несколько минут.
  "records": [
    {
      "type": "Помещение", // Вид объекта недвижимости
      "status": "Актуально", // Статус объекта (Актуально или Погашено)
      "ownership": "Частная", // Форма собственности
      "cad_number": "77:08:0010008:6713", // Кадастровый номер
      "cad_quarter": "77:08:0010008", // Кадастровый квартал
      "area": "74.00", // Площадь, кв. м
      "floor": "1", // Этаж
      "address": "Москва, Хорошево-Мневники, ул. Маршала Тухачевского, д. 33, кв. 136", // Адрес
      "reg_date": "2012-05-23", // Дата присвоения кадастрового номера
      "cad_cost": "13368780.06", // Кадастровая стоимость
      "cad_cost_det_date": "2021-01-01", // Дата определения кадастровой стоимости
      "cad_cost_reg_date": "2022-01-01", // Дата внесения кадастровой стоимости в ЕГРН
      "purpose": "Жилое", // Назначение
      "encumbrances": [ // Ограничения (обременения)
        {
          "number": "77:08:0010008:6713-77/055/2022-6", // Номер записи об ограничении
          "type": "Запрещение регистрации" // Тип ограничения
        }
      ],
      "rights": [ // Права на объект
        {
          "number": "77-77-08/221/2014-498", // Номер записи о праве
          "date": "2014-04-23", // Дата регистрации права
          "type": "Общая долевая собственность" // Тип права
        }
      ]
    }
  ]
}
```

---

### Интерпретация ответа и обработка ошибок

**Общие рекомендации:**
- Если поле `success` заполнено и `success = 1` — перед вами успешный ответ, с которым можно работать. Только такие запросы учитываются в статистике и расходуют оплаченный лимит.
- Иначе, если поле `error` заполнено — запрос требует вашего внимания. Текст ошибки рекомендуется сохранить или отправить для дальнейшего анализа.
- Иначе, если поле `error` не заполнено — это ошибка, связанная со стабильностью источника. В таком случае мы рекомендуем игнорировать ответ и повторить запрос.

В данном разделе описаны возможные коды ответов сервиса и их значения. Каждый код ответа сопровождается пояснением и примером JSON-ответа.

#### 1. Код ответа - 200

- Поле `success = 1` - удалось получить информацию от источника. Такие и только такие запросы можно запускать в дальнейшую обработку.
- Поле `success = 0` - не удалось получить информацию от источника. Запрос не будет учтен в статистике. Необходимо повторить запрос.

#### 2. Код ответа - 403

Выдается сервисом в случае невозможности обработки запроса из-за ограничения доступа: закончилась подписка, превышен лимит и так далее. Причины ошибок отражены в поле `error` ответа. Ниже приведен список возможных ошибок с их описанием и кодами:

- **Invalid access key**
  `error_code = 40301`
  Указанный ключ доступа недействителен или отсутствует.

- **The subscription period has expired**
  `error_code = 40302`
  Доступ к сервису истек, требуется продление.

- **Invalid IP**
  `error_code = 40303`
  Запрос выполнен с IP-адреса, который не разрешён для доступа.

- **Day limit of requests exceeded**
  `error_code = 40304`
  Достигнут оплаченный лимит запросов на день.

- **Month limit of requests exceeded**
  `error_code = 40305`
  Достигнут оплаченный лимит запросов на месяц.

**Пример ответа:**
```json
{
  "error": "Invalid access key",
  "error_code": 40301
}
```

#### 3. Код ответа - 400

Выдается сервисом в случае невозможности обработки запроса из-за ошибки валидации запроса, неверного или отсутствующего значения какого-либо поля. Поле `error_code` всегда равно `40001`, подробности доступны в поле `error`.

**Пример ответа:**
```json
{
  "error": "cadNumber or address is required",
  "error_code": 40001
}
```