← Вернуться в HydroWatch
ДОКУМЕНТАЦИЯ · V2.0

REST API без внешних зависимостей

Все запросы выполняются на локальном сервере. Координаты запроса и GeoJSON — долгота, широта в EPSG:4326. Площади — гектары и км².

Источники и ограничения

source: reference — просмотр эталонных масок для исследования. Это не инференс и не конкурсный сабмит. source: model — подключённые маски собственной модели. Отсутствующая модельная маска не заменяется эталоном; показатель будет null, запрос слоя вернёт 404.

Каталог ограничен 11 готовыми парами 2018–2021 годов. Новый запрос пересчитывает площади внутри заданной геометрии, но не скачивает новые снимки.

Пространственно-временной запрос

POST /api/query
{
  "bbox": [128.41, 49.48, 128.91, 49.76],
  "date_from": "2021-05-01",
  "date_to": "2021-07-05",
  "aoi": "poyarkovo"
}

Вместо bbox можно передать geometry — валидный GeoJSON Polygon или MultiPolygon. Обе даты пары должны входить в интервал включительно. Площади считаются по центрам пикселей на пересечении геометрии запроса и района. Ответ содержит count, source, список results с площадями пяти классов, изменением, долей затопления и распределением по доступным типам территории. Несколько событий и районов не суммируются.

Невалидные координаты, геометрии и даты возвращают 422. Отсутствие пересечений — 200 с пустым списком.

Каталог, карты и аналитика

МетодПутьРезультат
GET/api/healthСостояние и источник данных
GET/api/pairsКаталог пар с площадями
GET/api/eventsСобытия и их пары
GET/api/pairs/{pair_id}Показатели и метаданные пары
GET/api/pairs/{pair_id}/analyticsПокров, HAND, бассейны
GET/api/pairs/{pair_id}/weatherПосуточные ряды ERA5
GET/api/pairs/{pair_id}/inspect?lon=128.66&lat=49.62Маски и AUX в точке
GET/api/pairs/{pair_id}/overlay/{layer}.pngИзображение слоя в Web Mercator
GET/api/pairs/{pair_id}/overlay/{layer}/metaГраницы изображения WGS 84
GET/api/pairs/{pair_id}/vectors/{kind}aoi, hydrography, basins

Доступные слои: flood, water_pre, water_peak, permanent, receded.

Экспорт

GET /api/pairs/{pair_id}/report.pdf
GET /api/pairs/{pair_id}/export/csv
GET /api/pairs/{pair_id}/export/json
GET /api/pairs/{pair_id}/export/geojson?layer=flood
GET /api/pairs/{pair_id}/export/tif?layer=water_pre

Контуры GeoJSON без прореживания, атрибуты id, pair_id, type, area_ha, area_km2, source. GeoTIFF сохраняет исходную сетку маски и бинарные значения 0/1. CSV и JSON содержат источник и единицы измерения. Названия файлов режима исследования начинаются с reference_.