Valuation

Four valuation tools. Apartments, houses and land plots are supported; the express valuation and the report refuse commercial property and residential complexes with 422 business_rule; the rent estimate works for commercial property too.

Express valuation

POST /valuation/express - scope tools:valuation, immediate. One API call plus the express valuation price.

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"}'

Response:

No area or an unknown propertyCategory - 400 validation; commercial property - 422 business_rule with code: commercial_unsupported.

Full valuation report

POST /valuation/report - scope tools:valuation, job. A report with market analysis and a PDF. Required fields depend on propertyCategory. Send only the fields of your category: a field of another category (for example houseLevels for an apartment, parking for a house) is refused with 400. Apartment only: livingArea, kitchenArea, bathrooms, ceilingHeight, floor, storeys, balcony, elevator, parking, houseType, apartmentType. House only: houseLevels. Land only: zoning. House and land: utilities.

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 response: { "jobId": "...", "status": "processing", "state": "running" }. The finished job (GET /valuation/report/jobs/{id}) holds:

Commercial property (including apartmentType Commercial or Industrial) is refused with 422 business_rule and code: commercial_unsupported - estimate its rent with POST /valuation/rent. A residential complex (apartmentType: Complex) - 422 with code: complex_unsupported: value one apartment or house in it.

PDF: GET /artifacts/v1/ai/appraisal/reports/{id}/pdf. Events - valuation.completed / valuation.failed.

Rent estimate

POST /valuation/rent - scope tools:rent, immediate. Describe the property with fields or pass the objectId of your own or a public listing.

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"}'

Response:

Without area or city - 400 with a detail like "Missing or invalid: totalArea".

Report review

POST /valuation/review - scope tools:review. Upload a valuation report (PDF, DOCX, DOC, RTF; up to 40 MB) - GREM reads it and checks the value against market data.

Body - multipart/form-data:

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"

The document is read right away. The 202 response holds jobId, status and state:

• action_required (status: need_confirm) - extracted holds the data read from the document. Check it and confirm: POST /valuation/review/jobs/{id}/confirm (Jobs and results). After confirmation the job moves to running.
• failed (status: rejected) - the document is not a real-estate valuation report.

The finished result - GET /valuation/review/jobs/{id}; the review report - GET /artifacts/v1/ai/appraisal/reviews/{id}/report.pdf or report.docx. Events - review.completed / review.failed; webhook tracking starts after the confirmation.

Related

• Jobs and results
• Errors
• Limits and billing