Takeoffs

Work a takeoff

post/takeoff/{id}/run

Request

  • Base URL: https://api.craftquantities.com/v1
  • URL: https://api.craftquantities.com/v1/takeoff/{id}/run
  • Auth: none declared

Path parameters

idstring required

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

measurementsobject

Measurement id → value, each length, area or volume with its unit ("12 ft", {"value": 3.6, "unit": "m"}); counts as numbers. Ids are those of the takeoff; any left out opens at the page's own figure.

selectionobject

Build-up choice id → option id, the takeoff's own (a stud size, an insulation, a cladding). Choices left out take the page's own for the system.

allowancesobject

Row → an allowance the reader sets: a percentage (cutting waste, overlap), or the option an allowance follows (a lay pattern). Row names are the takeoff's steps (the calculator slug, or the step key where one runs twice).

leaveOutstring[]

Rows the reader leaves out of the job: still worked and shown, not put in the project or counted in labour.

system'metric' | 'imperial'

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

market'US' | 'CA' | 'UK' | 'AU' | 'INTL'

Optional. A market whose own opening choice some inputs take (a UK reader's code, an IEC motor), and whose currency symbol prints the caller's own money figures.

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

Every row, with its quantity, order, working and sources.

OR

Changes

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