Cost preview for the Swath Report: filtered cached-property count and fresh-fetch estimate, no rows returned (1 credit)

Runs the report's filtered COUNT over cached parcels (1 credit, no property rows). Returns total_cached, whether fresh vendor fetches are possible, and a clearly-labeled fresh_estimate (null when no basis). Billing of the real report always uses actual counts.

get/v1/swaths/{id}/properties/quote

Request

  • Base URL: https://swathapi.com
  • URL: https://swathapi.com/v1/swaths/{id}/properties/quote
  • Auth: HTTP bearer

Path parameters

idstring required

Swath id (swath_...) or storm id (sw_...)

Query parameters

roof_age_minnumber

Minimum estimated roof age in years

roof_materialstring

Exact roof material match, e.g. asphalt_shingle

owner_occupiedboolean

true = owner-occupied only, false = non-owner-occupied only

year_built_beforenumber

Built strictly before this year

year_built_afternumber

Built strictly after this year

value_minnumber

Minimum assessed value (USD)

value_maxnumber

Maximum assessed value (USD)

min_exposure_scorenumber

Minimum exposure score, 0 to 1

Response

Cost preview

storm_idstring
swath_idstring
total_cachedinteger

Cached properties matching the filters (1 credit each when returned)

fresh_possibleboolean

Whether a paid-plan report could trigger live vendor fetches (uncovered tiles exist)

fresh_estimateinteger nullable

ESTIMATE of fresh-fetchable records (uncovered tiles × observed parcels-per-tile average); null when no basis. Billing uses actuals only.

Changes

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