---
title: "Estimate a house"
method: POST
path: "/house"
tags: ["House and canvas"]
---

# Estimate a house

`POST /house`

## Request

- Base URL: `https://api.craftquantities.com/v1`
- URL: `https://api.craftquantities.com/v1/house`
- Auth: none declared

## Query parameters

- `detail` 'full' | 'summary': full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read.
- `format` 'json' | 'md'

## Request body

- object
  - `example` string: Start from one of the site's example houses (its slug) in place of the estimator's opening house.
  - `values` object: The form's figures, each length with its unit: length, width, storeyHeight, eaveOverhang, rakeOverhang, slabThickness, footingWidth, footingDepth, trenchDepth, windowWidth, windowHeight, doorWidth, doorHeight ("12 m", "40 ft"); and the counts partitions, windows, outsideDoors, interiorDoors, iceDamEaves. Any left out opens where the page opens it.
  - `storeys` 1 | 2
  - `family` 'wall.framed-exterior' | 'wall.masonry' | 'wall.sip'
  - `selection` object: The exterior wall's build-up choices.
  - `pitch` '4' | '6' | '8' | '10' | '12': Roof pitch, rise in 12.
  - `roofFamily` 'roof.asphalt-shingle' | 'roof.tile-slate'
  - `roofSelection` object
  - `system` 'metric' | 'imperial': The unit system inputs left out open in, and the one the page link opens in. The answer comes in both.
  - `inputUnits` 'base': Send "base" to pass bare numbers on dimensioned inputs in base units (m, m², L, kg …), as the published test vectors are written. Without it a length, area or volume must carry its unit.

## Response `200`

The house's quantities, plan, labour and sources.

- union
  - object
    - `engine` object, required
    - `house` object, required
    - `system` 'metric' | 'imperial', required
    - `values` object[], required
    - `rows` object[], required
      - `key` string, required
      - `section` string, required
      - `label` string, required
      - `where` string, required
      - `quantity` number, required
      - `unit` string, required
      - `order` object
      - `otherSystem` object, nullable, required
      - `calculator` object, required
      - `note` string
    - `counts` object[], required
    - `unplaced` object, required
    - `raised` string[], required
    - `assumptions` string[], required
    - `omitted` object[], required
    - `plans` object[], required
    - `labour` object, required
    - `sources` object[], required
    - `citation` object, required
      - `author` string, required
      - `title` string, required
      - `version` string, nullable
      - `sourcesChecked` string, nullable
      - `url` string, required
      - `accessDate` string, nullable, required
      - `formats` object, required
        - `plain` string, required
        - `apa` string, required
        - `harvard` string, required
        - `bibtex` string, required
    - `links` object, required
    - `licence` object, required
      - `name` string, required
      - `url` string, required
      - `attribution` string, required
    - `notice` string, required
  - object
    - `detail` 'summary', required
    - `tool` string, required
    - `title` string, required
    - `lines` object[], required: The result lines, as the report's table gives them.
    - `notes` string[], required: What a professional must decide, when to call one, a false-friend warning, that adoption is local: kept in every summary.
    - `citation` string, required: The one citation line, built from the answer's own data.
    - `url` string, nullable, required
    - `open` string, nullable, required
    - `more` string, nullable, required

## Other responses

- `400`: The request was refused; every problem is listed.
- `404`: The request was refused; every problem is listed.

---

[API](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api.md) · [All operations](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api/llms.txt) · [OpenAPI document](https://skmtc.dev/craftquantities/apis/craft-quantities-engine-api/revisions/a69883abc23b?raw)