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.

summary: the result lines, the citation and the page only (fewer tokens); full, the default: the whole answer. A POST body may carry detail instead.

format'json' | 'md'

md: the engine's Markdown report as text/markdown (or send Accept: text/markdown); json, the default.

Request body

examplestring

Start from one of the site's example houses (its slug) in place of the estimator's opening house.

valuesobject

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.

storeys1 | 2
family'wall.framed-exterior' | 'wall.masonry' | 'wall.sip'
selectionobject

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'
roofSelectionobject
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

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

OR

Changes

No recorded changes to this operation across all 1 revision of this API.