Deprecated Changed Added

v8.3.0

1 month ago

New feature

Address autocomplete and postcode search now support commercial, dual use, and parent shell addresses.

As part of this improvement, we have moved the endpoints to a dedicated /search path instead of /residential.

The /residential/autocomplete and /residential/postcode endpoints will remain working for backwards compatibility.

Changed Deprecated

V8.0.0

1 month ago

New billing system based on actual pound balance instead of credits, as well as support for pre-paid request packs for volume discounts. This introduces new headers:

chimnie-balance-used: Amount deducted from your balance for the request.

chimnie-balance-remaining: Balance remaining after the request.

chimnie-pack-used: Number of pack request units consumed by the request. 

chimnie-pack-kind: The kind (core / plus / premium / commercial) of the pack that satisfied the request. 

chimnie-pack-remaining: Number of requests remaining across all your active packs of that kind, after the request. 

Former credit-based headers will be kept for backwards compatibility for some time.

Full details on the current billing system are available in our documentation https://docs.chimnie.com/#billing-system

Added Deprecated Changed

v6.2.0

1 year ago

New fields

Images of the property from previous listings.

  • property.attributes.images.listing_images

Floorplans of the property.

  • property.attributes.images.floorplan_images

Clearer predicted fields

We've improved how we expose predicted values by splitting them into three distinct categories:

  • [field]_declared_only: Values officially declared in public records.
  • [field]_predicted_only: Values derived purely from our prediction models. Will be null when there is a declared value available.
  • [field]_declared_and_predicted: Combined values from both predicted and declared.

While the legacy fields are now deprecated, they will remain available for backwards compatibility.

For example, the bedrooms count fields are now structured as:

  • New field: bedrooms_declared_only - Legacy field: bedrooms
  • New field: bedrooms_declared_and_predicted - Legacy field: bedrooms_predicted
  • New field: bedrooms_predicted_only -  Legacy field: N/A 

Changed

v5.2.0

1 year ago

Feature

Enhanced LLM phase of address matching, improving address match rates.

Changed

v5.0.0

1 year ago

Feature

Now property.value.sale.property_value does not consume credits if requested via UPRN, as part of our Free AVM service.

More info in https://docs.chimnie.com/#free-avm.

Added Changed

v2.5.0

2 years ago

New fields

Added roof, building and terrain fields from Lidar (Premium tier, except flat_storey_count which is Core tier)

  • property.attributes.status.flat_storey_count
  • premium.property.attributes.status.main_ridge_height
  • premium.property.attributes.status.main_gutter_height
  • premium.property.attributes.status.main_roof_slope_degrees
  • premium.property.attributes.status.building_volume
  • premium.property.attributes.status.roof_area_up_to_10_degrees
  • premium.property.attributes.status.roof_area_up_to_5_degrees
  • premium.property.attributes.status.pct_south_facing
  • premium.property.attributes.status.roof_area_up_to_20_degrees
  • premium.property.attributes.status.roof_area_up_to_15_degrees
  • premium.property.attributes.status.roof_area
  • premium.property.attributes.status.maximum_height
  • premium.property.attributes.status.storey_count
  • premium.property.attributes.status.property_elevation_min
  • premium.property.attributes.status.property_elevation_max

Breaking change

affected_areas in all categories of surroundings.environment.land now contain an array of objects instead of an array of strings, providing more detailed data.

Added Changed

v4.0.0

22 years ago

Breaking changes

premium.property.ownership.total_hhi_predicted is now a string with banded values, e.g "10000-20000", "20000-30000" etc.

surroundings.facilities.shops.nearest_petrol_station now has street address instead of lat/long, to be consistent with other similar fields like nearest_post_office.

property.bills.energy.heating_types has been standardised to an array with the following possible values:

  • Heat Pump
  • Electric Storage Heaters
  • Gas Boiler
  • LPG/Oil Boiler
  • Underfloor Heating
  • Mineral/Wood/Coal
  • BioFuel
  • Community Scheme
  • Other Electric Heating