Vepler logo
v2.132.0 Breaking change

Coordinate-exact air-quality endpoint, reworked air-quality query contract, and schools reference catalogues

New air-quality point endpoint with property-decay overlay, a reworked air-quality query contract (0-100 score, renamed attributes), new schools reference endpoints, and a consistent v2 list envelope on safety routes.

Added

  • New endpoint POST /v1/air-quality/point returns property-exact air quality for a single coordinate. It reads the 1km cell substrate then applies a versioned decay overlay, adding coordinate, cellId and a decay block to the standard air-quality response.
  • Request options on POST /v1/air-quality/point: options.decay toggles the overlay, options.decayModel selects the model version (v1), and options.explain adds a per-pollutant calculation trail under decay.calculation. The premium attributes nearestRoad, nearestMotorway, installations and the explain trail require the air-quality:premium permission.
  • New schools reference endpoints: GET /v1/schools/frameworks and GET /v1/schools/frameworks/{framework} list the framework catalogue and per-framework metric definitions; GET /v1/schools/coverage returns the coverage matrix; GET /v1/schools/changelog lists Schools API changelog entries.

Changed

  • Breaking: POST /v1/air-quality/query now uses a platform 0-100 score (higher is better). The scoreMin and scoreMax filters accept 0-100 instead of the previous 0-10 range.
  • Breaking: the attributes groups on POST /v1/air-quality/query were renamed: zones becomes regulatoryZones (a flat system-discriminated array covering AQMA, CAZ, ULEZ, LEZ, SMOKE_CONTROL), and the premium roadProximity becomes nearestRoad plus nearestMotorway.
  • New attributes groups on POST /v1/air-quality/query: officialIndices (DAQI), framework-tagged per-pollutant compliance checks (UK AQS 2010, WHO AQG 2021), healthImpact, and propertyValueImpact (replacing propertyImpact). officialIndices, healthImpact and propertyValueImpact are now returned by default.
  • Air quality is now a gated product: requests under /v1/air-quality require the air_quality product to be enabled on the tenant.

Fixed