API DomXML
REST API для управления шахматкой: жилые комплексы, квартиры, статусы, фиды. База: https://domxml.ru/api/v1. Для нейросетей есть MCP-сервер с теми же возможностями.
Аутентификация
Создайте ключ в панели: аватарка → API и MCP → «Создать ключ». Секрет показывается один раз. Передавайте его в заголовке:
curl https://domxml.ru/api/v1/complexes \ -H "Authorization: Bearer dxk_ВАШ_КЛЮЧ"
При создании ключа выбираются:
- Уровень доступа:
readonly— только GET;editor— чтение и изменение;full— плюс удаление. - ЖК: все или выбранные (ключ с ограничением работает только с путями
/complexes/{id}/…). - Срок: пресеты 1–30 дней или бессрочно. Отзыв в панели действует мгновенно.
Управление доступами, профиль и выпуск ключей по ключу недоступны — только в панели.
Основные эндпоинты
| Метод | Путь | Описание |
|---|---|---|
| GET | /complexes | Список ЖК |
| GET | /complexes/{id} | Данные ЖК |
| GET | /complexes/{id}/apartments | Квартиры (фильтры rooms, status) |
| POST | /complexes/{id}/apartments | Создать квартиру |
| PUT | /complexes/{id}/apartments/{aid} | Изменить квартиру (частичное тело) |
| PUT | /complexes/{id}/apartments/bulk | Массовое изменение |
| GET | /complexes/{id}/apartments/statuses | Статусы квартир ЖК |
| GET | /complexes/{id}/buildings | Корпуса |
| GET | /complexes/{id}/discounts | Акции |
| GET | /complexes/{id}/feeds/status | Состояние фидов |
| POST | /complexes/{id}/feeds/{type}/generate | Пересобрать фид (domclick | cian | yandex | avito) |
| GET | /complexes/{id}/changelog | Журнал изменений |
Примеры
Изменить цену квартиры
curl -X PUT https://domxml.ru/api/v1/complexes/12/apartments/345 \
-H "Authorization: Bearer dxk_ВАШ_КЛЮЧ" \
-H "Content-Type: application/json" \
-d '{"price": 5200000}'
Пересобрать фид Домклик
curl -X POST https://domxml.ru/api/v1/complexes/12/feeds/domclick/generate \ -H "Authorization: Bearer dxk_ВАШ_КЛЮЧ"
Готовый фид всегда доступен по постоянной ссылке https://domxml.ru/feeds/{type}/complex_{id}.xml.
Ошибки
Всегда JSON вида {"detail": "текст"}. Коды: 401 — недействительный или отозванный ключ, 403 — не хватает уровня доступа или ЖК вне списка ключа, 404 — не найдено, 422 — некорректное тело запроса.