House and canvas

Estimate a house (example, system and figures in the query)

Every parameter other than example, system, storeys, family, pitch, roofFamily and inputUnits is a figure of the form, written with its unit.

get/house

Request

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

Query parameters

examplestring
system'metric' | 'imperial'

The unit system inputs left out open in, and the one the page link opens in. The answer comes in both.

storeys1 | 2
family'wall.framed-exterior' | 'wall.masonry' | 'wall.sip'
pitch'4' | '6' | '8' | '10' | '12'

Roof pitch, rise in 12.

roofFamily'roof.asphalt-shingle' | 'roof.tile-slate'
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.

Response

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

OR

Changes

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