Docs

Оцінка

Останнє оновлення: 2026-10-038 хв читання

Чотири інструменти оцінки. Підтримуються квартири, будинки і земельні ділянки; експрес-оцінка і звіт відхиляють комерційну нерухомість і житлові комплекси з 422 business_rule; оцінка оренди працює і для комерційної нерухомості.

Експрес-оцінка

POST /valuation/express - область tools:valuation, відповідає одразу. Виклик API плюс ціна експрес-оцінки.

ПолеТипОбов'язковеОпис
propertyCategoryрядокніapartment (за замовчуванням), house, land; commercial відхиляється з 422, будь-яке інше значення (категорії complex немає) - з 400
totalAreaчислоодне з трьохплоща, м²
areaM2числоодне з трьохте саме, що totalArea
landPlotAreaчислоодне з трьохплоща ділянки, м²; рахується площею лише для land
addressTextрядокбажаноадреса одним рядком
country, city, postalCodeрядокніадреса частинами
lat, lonчислонікоординати
roomsчислонікімнат
yearBuiltчислонірік побудови
floor, floorsTotalчислоніповерх і поверховість
houseLevelsчислонірівнів у будинку
heatingTypeрядокніопалення
priceчислоніваша ціна - порівняється з оцінкою
currencyрядокнівалюта результату
languageрядокніне використовується: в експрес-відповіді немає тексту пояснень
targetIdрядокніid вашого об'єкта: повторні оцінки того самого об'єкта 7 днів беруться з кешу
curl -X POST https://developers.grem.capital/api/v1/valuation/express \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5b8c3f7e-2a71-4c55-8d0e-9f1a6b2c4d10" \
  -d '{"propertyCategory":"apartment","addressText":"Torstraße 12, Berlin","totalArea":64,"rooms":2,"currency":"EUR"}'

Відповідь:

ПолеОпис
estimate.pricePointоцінка вартості
estimate.rangeLow, estimate.rangeHighдіапазон
estimate.confidenceрівень впевненості: low, medium або high
estimate.confidenceScoreвпевненість числом від 0 до 1
estimate.currencyвалюта
estimate.analogsзнайдені аналоги: title, address, area, rooms, pricePerM2, originalPrice, adjustedPrice, adjustments, weight, provenance, source, sourceUrl
degradedtrue, якщо це груба оцінка без даних ринку; така оцінка не списується

Без площі або з невідомою propertyCategory - 400 validation; комерційна нерухомість - 422 business_rule з code: commercial_unsupported.

Повний звіт про оцінку

POST /valuation/report - область tools:valuation, завдання. Звіт з аналізом ринку і PDF. Набір обов'язкових полів залежить від propertyCategory. Передавайте лише поля своєї категорії: поле іншої категорії (наприклад, houseLevels для квартири, parking для будинку) відхиляється з 400. Лише квартира: livingArea, kitchenArea, bathrooms, ceilingHeight, floor, storeys, balcony, elevator, parking, houseType, apartmentType. Лише будинок: houseLevels. Лише ділянка: zoning. Будинок і ділянка: utilities.

ПолеТипОпис
propertyCategoryрядокapartment, house або land - обов'язкове
addressоб'єктобов'язкове: country, city, street (може бути порожнім), streetNumber, location (lat, lng)
totalAreaчислом²; обов'язкове для квартири і будинку
landPlotAreaчислом²; обов'язкове для будинку; для ділянки потрібне це поле або totalArea
conditionрядокстан; обов'язкове для квартири і будинку
apartmentTypeрядокквартира: Residential, Commercial, Industrial, Land plot або Complex - обов'язкове
houseTypeрядокквартира: тип будинку - обов'язкове
floor, storeysчислоквартира: поверх і поверхів у будинку - обов'язкові
balcony, elevatorтак/ніквартира: обов'язкові
houseLevelsчислобудинок: рівнів, від 1 до 10 - обов'язкове
roomsчислоквартира, будинок: кімнати
livingArea, kitchenArea, bathrooms, ceilingHeightчислолише квартира: необов'язкові деталі
yearConstructionчислоквартира, будинок: рік побудови
wallMaterial, heatingTypeрядокквартира, будинок: матеріал стін, опалення; для будинку heatingType - одне з central, autonomous, boiler, fireplace, mixed, gas, electric, heat_pump, solid_fuel, underfloor, none
furnishedтак/ніквартира, будинок: меблі
parkingтак/нілише квартира: паркінг
zoningрядоклише ділянка: призначення
utilitiesоб'єктбудинок і ділянка: gas, water, sewage, electricity (так/ні)
priceчисловаша ціна - порівняється з оцінкою
currencyрядокUAH, USD, EUR, AZN, GBP, AED, CNY, TRY, GEL
languageрядокмова звіту: eng, rus, ukr, deu, spa, aze, arb, fra, zho, tur
objectIdрядокid вашого об'єкта, якщо оцінюєте його
commentsрядоккоментар до оцінки
curl -X POST https://developers.grem.capital/api/v1/valuation/report \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "propertyCategory": "apartment",
    "address": { "country": "Germany", "city": "Berlin", "street": "Torstraße", "streetNumber": "12" },
    "currency": "EUR", "language": "eng",
    "apartmentType": "Residential", "houseType": "panel",
    "totalArea": 64, "rooms": 2, "floor": 3, "storeys": 5,
    "balcony": true, "elevator": false, "condition": "good"
  }'

Відповідь 202: { "jobId": "...", "status": "processing", "state": "running" }. Готове завдання (GET /valuation/report/jobs/{id}) містить:

ПолеОпис
metricsцифри: potPrice, priceRangeLow, priceRangeHigh, avgPrice, analogCount, growth - ринкова вартість, її діапазон, ціна за м², кількість аналогів, зростання у %
confidence, priceMethod, estimateTypeнаскільки надійна вартість (high…very_low), яким методом пораховано, точка чи діапазон
currencyвалюта всіх цифр
justificationчому вартість саме така
recommendationsрекомендації щодо ціни і продажу
pdfMetaдані PDF-звіту
analogsаналоги, на яких побудовано вартість (та сама таблиця, що в PDF): title, address, area, rooms, pricePerM2, originalPrice, adjustedPrice, adjustments, weight, provenance, source, sourceUrl. provenance: model_estimate - орієнтир без оголошення за ним

Комерційна нерухомість (зокрема apartmentType Commercial або Industrial) відхиляється з 422 business_rule і code: commercial_unsupported - її оренду оцінить POST /valuation/rent. Житловий комплекс (apartmentType: Complex) - 422 з code: complex_unsupported: оцінюйте окрему квартиру або будинок у ньому.

PDF: GET /artifacts/v1/ai/appraisal/reports/{id}/pdf. Подія - valuation.completed / valuation.failed.

Оцінка оренди

POST /valuation/rent - область tools:rent, відповідає одразу. Описуйте об'єкт полями або передайте objectId свого чи публічного об'єкта.

ПолеТипОпис
objectIdрядокоб'єкт замість опису
cityрядокобов'язкове без objectId
totalAreaчислом²; обов'язкове без objectId
country, district, streetрядокадреса
propertyCategoryрядоктип нерухомості
rooms, floorчислокімнати, поверх
furnishedтак/ніз меблями
conditionрядокстан
rentTermрядокlong - помісячна оренда (за замовчуванням), short - подобова. Це різні ринки
occupancyPctчислоподобова оренда: очікуване завантаження, від 10 до 100 %
monthRentalRateчисловаша місячна ставка - відповідь покаже, як вона співвідноситься з ринком
declaredDayRateчисловаша ставка за добу
currencyрядоквалюта результату
curl -X POST https://developers.grem.capital/api/v1/valuation/rent \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"propertyCategory":"apartment","country":"Germany","city":"Berlin","totalArea":50,"rooms":2,"currency":"EUR"}'

Відповідь:

ПолеОпис
idid оцінки; PDF - GET /artifacts/v1/ai/appraisal/rent/{id}/pdf
currencyвалюта
rent.monthlyRentринкова оренда на місяць
rent.low, rent.highдіапазон
rent.annualRentна рік
rent.pricePerM2за м² на місяць
rent.grossYieldPctвалова дохідність до ціни об'єкта, %, якщо ціна відома
rent.confidenceвпевненість
rent.basedOnскільки порівнянних оголошень лягло в основу
rent.termBasislong або short
compsусі розглянуті оголошення та їхня доля в розрахунку: address, area, rooms, monthlyRent/dayRent, effectiveMonthly, term, status, usedInEstimate, source, url

Без площі чи міста - 400 з detail на кшталт "Missing or invalid: totalArea".

Перевірка чужого звіту

POST /valuation/review - область tools:review. Завантажте звіт про оцінку (PDF, DOCX, DOC, RTF; до 40 МБ) - GREM прочитає його і перевірить вартість на ринкових даних.

Тіло - multipart/form-data:

ЧастинаОпис
fileдокумент звіту (або частина document)
languageмова результату, rus за замовчуванням
currencyвалюта, USD за замовчуванням
curl -X POST https://developers.grem.capital/api/v1/valuation/review \
  -H "Authorization: Bearer gsk_live_xxx" \
  -F "[email protected]" \
  -F "language=eng" -F "currency=EUR"

Документ читається одразу. Відповідь 202 містить jobId, status і state:

  • action_required (status: need_confirm) - поле extracted містить дані, витягнуті з документа. Перевірте і підтвердьте: POST /valuation/review/jobs/{id}/confirm (Завдання і результати). Після підтвердження завдання переходить у running.
  • failed (status: rejected) - документ не є звітом про оцінку нерухомості.

Готовий результат - GET /valuation/review/jobs/{id}; звіт перевірки - GET /artifacts/v1/ai/appraisal/reviews/{id}/report.pdf або report.docx. Події - review.completed / review.failed; відстеження для вебхука починається після підтвердження.

Пов'язані статті

Ця стаття була корисною?