Skip to main content

Concepts

Estimate​

An estimate is one answer to one job description. It has an id that starts with est_ and a status:

StatusMeaning
pricedHometown recognized the job and priced it.
needs_detailThe job is recognized but a size is missing. question says what to ask.
unsupportedHometown does not price this kind of job.
unclearThe description does not say enough to tell what the job is.

Region​

A region sets the currency and the rates. GET /v1/regions lists them. An account has a default region, and a request can name another one with region.

Credit​

Live keys spend credits. A text estimate costs 10 credits, an estimate with photos costs 25, and a follow-up costs 5. A test key spends none.

Test and live​

Every key is test or live. Test keys start with hw_test_ and live keys with hw_live_. Each key reads only the estimates of its own environment.

Request id​

Every answer carries X-Request-Id, and every error carries request_id in its body. Quote it when you contact support.