Базовый адрес /api/v1. Все методы — GET. Машиночитаемое описание: /openapi.yaml.
Каждый ответ по сделкам содержит период, размер выборки и источник. Выборка — представление v_ad_sales_clean: пригодные к анализу сделки без повтора полного дубля. Относительный период считается от последней сделки в базе, 23.09.2026.
| Параметр | Значения | Смысл |
|---|---|---|
| intent | explore, invest, buy, rent, sell | Сценарий с экрана выбора. На расчёт сделок не влияет, попадает в filters |
| property_type | apartment, villa, townhouse, duplex, penthouse или точное имя из базы | Тип. townhouse читается как townhouse / attached villa |
| property_category | residential, commercial и другие из базы | Категория |
| layout или bedrooms | studio, 1, 2, 3, 4, 5, 6+ | Планировка, число спален |
| district или location | имя района | Локация. Короткие имена экрана: Yas Island, Saadiyat, Al Reem, Al Raha, Khalifa City, Zayed City |
| zone | имя зоны | Более мелкий разрез, если он известен клиенту |
| period | 3m, 6m, 12m, 24m, 36m, all | Окно. По умолчанию 12m |
| date_from, date_to | YYYY-MM-DD | Своё окно. Если задано, period становится custom |
| budget | lt_1m, 1_3m, 3_5m, 5_10m, 10m_plus | Диапазоны с экрана бюджета. Верхняя граница не входит в диапазон |
| budget_min, budget_max | число AED | Свой диапазон цены сделки. Если задан, budget не используется |
| completion_status | ready, off-plan, court-mandated | Статус готовности |
| market_segment | primary, secondary | Первичный или вторичный рынок |
| Метод | Блок отчёта |
|---|---|
| GET /api/v1/catalog | Справочники для экранов: сценарий, тип, спальни, районы, бюджет, покрытие таблиц |
| GET /api/v1/reports | Весь отчёт одной выдачей |
| GET /api/v1/reports/snapshot | Market Snapshot: число сделок, объём, средняя и медианная цена, площадь, цена за кв. м, изменение к предыдущему периоду той же длины |
| GET /api/v1/reports/transactions | Transaction Analysis: тип, подтип, спальни, район, проект, Ready / Off-plan, Primary / Secondary |
| GET /api/v1/reports/prices | Price Analysis: помесячная медиана цены и цены за кв. м, число сделок по месяцам для графика Activity, распределение по диапазонам, типичный диапазон p25–p75 |
| GET /api/v1/reports/mix | Property Mix: доля сделок по типу, планировке и статусу готовности |
| GET /api/v1/reports/comparison | Market & Area Comparison: районы при тех же фильтрах, кроме самого района. Отдельно шесть районов с экрана отчёта |
| GET /api/v1/reports/rental | Rental Analysis для жилья: средняя сумма договора, единицы, разрезы, индекс аренды, доходность только если срез совместим с Yas Island, apartment, 1 bed |
| GET /api/v1/reports/indices | Market Indices: официальный индекс продажи и аренды. Территория индекса — Abu Dhabi City, не выбранный район. Retail — Al Ain City |
| GET /api/v1/reports/insight | VIA Insight: короткие выводы по этой выборке и оговорка, что это не оценка объекта |
GET /api/v1/reports?intent=buy&property_type=apartment&bedrooms=2&location=Yas%20Island&period=12m&budget=1_3m
Ошибочный параметр из списка значений возвращает 422 и список полей. Неизвестный район не ошибка: выборка просто пустая, sample_size равен 0.