ReportQuote

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/swathapi-com/json-schema/swathapi-com-report-quote-schema.json",
  "title": "ReportQuote",
  "description": "Cost preview for a Swath Report — counts only, no property rows",
  "x-generated": "2026-10-31",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/swathapi-com-openapi.json#/components/schemas/ReportQuote",
  "type": "object",
  "properties": {
    "storm_id": {
      "type": "string"
    },
    "swath_id": {
      "type": "string"
    },
    "total_cached": {
      "type": "integer",
      "description": "Cached properties matching the filters (1 credit each when returned)"
    },
    "fresh_possible": {
      "type": "boolean",
      "description": "Whether a paid-plan report could trigger live vendor fetches (uncovered tiles exist)"
    },
    "fresh_estimate": {
      "type": [
        "integer",
        "null"
      ],
      "description": "ESTIMATE of fresh-fetchable records (uncovered tiles × observed parcels-per-tile average); null when no basis. Billing uses actuals only."
    },
    "quote": {
      "type": "object",
      "properties": {
        "cached_credits": {
          "type": "integer",
          "description": "total_cached × 1 credit"
        },
        "fresh_surcharge_per_record": {
          "type": "integer",
          "description": "Credits added per fresh-fetched record (25 at current rates)"
        },
        "minimum": {
          "type": "integer",
          "description": "Per-request billing floor (10 credits)"
        },
        "note": {
          "type": "string"
        }
      }
    }
  }
}