Added Deprecated

v8.5.0

5 days ago

New fields

Whether the building has external cladding, assessed from facade imagery. True where cladding is present or suspected, False where the facade is visible and uncladded, null where it cannot be determined. High-rise apartment buildings only; assessed per building and applied to every flat:

  • premium.property.attributes.outdoor.cladding

Detail of the cladding system: coverage, indicative fire risk, primary material, the model's confidence in each, and free-text risk notes. Only present where cladding is True:

  • premium.property.attributes.outdoor.cladding_details
  • premium.property.attributes.outdoor.cladding_details.cladding_coverage
  • premium.property.attributes.outdoor.cladding_details.cladding_fire_risk
  • premium.property.attributes.outdoor.cladding_details.primary_cladding_material
  • premium.property.attributes.outdoor.cladding_details.cladding_material_confidence
  • premium.property.attributes.outdoor.cladding_details.fire_risk_confidence
  • premium.property.attributes.outdoor.cladding_details.risk_notes

Nearest town or city centre: name, straight-line distance, and travel distance and time by walking, driving and public transport:

  • surroundings.facilities.transport.nearest_city_centre

Travel distance and time by walking, driving and public transport (driving_distance, driving_time, walking_distance, walking_time, public_transport_distance, public_transport_time) for nearest education, health, shop and transport facilities. Each mode resolves to the nearest facility by that mode:

  • surroundings.facilities.education.best_nearby_secondary
  • surroundings.facilities.education.nearest_good_primary
  • surroundings.facilities.education.nearest_nursery
  • surroundings.facilities.education.nearest_primary
  • surroundings.facilities.education.nearest_secondary
  • surroundings.facilities.education.nearest_university
  • surroundings.facilities.health.fire_station
  • surroundings.facilities.health.nearest_gp
  • surroundings.facilities.health.nearest_gym
  • surroundings.facilities.health.nearest_hospital
  • surroundings.facilities.health.nearest_pool
  • surroundings.facilities.health.police_station
  • surroundings.facilities.shops.nearest_cafe
  • surroundings.facilities.shops.nearest_fast_food
  • surroundings.facilities.shops.nearest_nightlife
  • surroundings.facilities.shops.nearest_petrol_station
  • surroundings.facilities.shops.nearest_post_office
  • surroundings.facilities.shops.nearest_restaurant
  • surroundings.facilities.transport.nearest_train_station

The same travel distance and time fields for the nearest supermarket of each major chain (aldi, asda, co_op, iceland, lidl, m_and_s, morrisons, sainsburys, tesco, waitrose):

  • surroundings.facilities.shops.nearest_supermarkets

Geometry for each planning application:

  • plus.property.attributes.status.planning_applications.geometry

Deprecated fields

Deprecated in favour of x_local_grid and y_local_grid:

  • property.attributes.status.irish_grid_x, property.attributes.status.irish_grid_y

Added

v8.4.0

1 month ago

New feature

Added pdf format for generating and downloading visual PDF reports of properties.

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.

Added

v8.2.0

1 month ago

New features

Added 30 test addresses for free testing of the API.

Added new endpoint to check remaining request packs.

Added Deprecated

v8.1.0

1 month ago

New fields

All planning applications for the property, sorted by received date descending, including reference number, proposal, status, decision, appeal details, key dates, constraints, and linked documents:

  • plus.property.attributes.status.planning_applications

Windows description as recorded on the EPC certificate:

  • property.attributes.status.windows_description

Walls description as recorded on the EPC certificate:

  • property.attributes.status.walls_description

Roof description as recorded on the EPC certificate:

  • property.attributes.status.roof_description

Floor description as recorded on the EPC certificate:

  • property.attributes.status.floor_description

Property type as recorded on the EPC certificate:

  • property.attributes.status.epc_property_type

Built form as recorded on the EPC certificate:

  • property.attributes.status.epc_built_form

Floor height in metres as recorded on the EPC certificate, where available:

  • property.attributes.status.floor_height_declared_only

Floor height in metres, taken from the EPC where available and otherwise estimated from the postcode/property-type median:

  • property.attributes.status.floor_height_declared_and_predicted

Modelled floor height in metres from the postcode/property-type median; null where an EPC value exists:

  • property.attributes.status.floor_height_predicted_only

Whether the property contains an airing cupboard:

  • property.attributes.indoor.airing_cupboard

Overall property condition ('excellent', 'good', 'fair', 'poor', or 'unknown'):

  • plus.property.attributes.indoor.condition

Overall interior finish quality ('low', 'medium', 'high', or 'unknown'):

  • plus.property.attributes.indoor.finish_quality

Quality of kitchen finish ('low', 'medium', 'high', or 'unknown'):

  • plus.property.attributes.indoor.kitchen_finish_quality

Whether the kitchen appears recently refitted:

  • plus.property.attributes.indoor.kitchen_recently_refitted

Dominant kitchen countertop material ('laminate', 'solid_wood', 'granite', 'quartz', 'composite_stone', 'marble', 'tile', 'stainless_steel', 'concrete', 'other', or 'unknown'):

  • plus.property.attributes.indoor.kitchen_countertop_material

Quality of bathroom finish ('low', 'medium', 'high', or 'unknown'):

  • plus.property.attributes.indoor.bathroom_finish_quality

Whether the bathroom appears recently refitted:

  • plus.property.attributes.indoor.bathroom_recently_refitted

Dominant flooring type ('carpet', 'hardwood', 'laminate', 'tile', 'stone', 'vinyl', 'mixed', or 'unknown'):

  • plus.property.attributes.indoor.primary_floor_type

Primary window type ('standard', 'bay', 'sash', 'bay_and_sash', 'mixed', 'skylight', or 'unknown'):

  • plus.property.attributes.indoor.window_type

Approximate radiator age ('modern', 'dated', 'vintage', 'mixed', or 'unknown'):

  • plus.property.attributes.indoor.radiator_age

Evidence the loft has been converted to habitable space:

  • plus.property.attributes.indoor.attic_or_loft_conversion

Whether skylights are visible:

  • plus.property.attributes.indoor.skylights

Whether at least one balcony is present:

  • plus.property.attributes.indoor.balcony

Whether a chimney is visible from the roofline:

  • plus.property.attributes.indoor.chimney

Whether a dedicated home-office space is visible:

  • plus.property.attributes.indoor.home_office

Whether the property is cottage-style (beams, wood burner, thatch, old construction):

  • plus.property.attributes.indoor.cottage_style

Likelihood that the property has a header tank:

  • premium.property.attributes.indoor.header_tank_probability

Predicted finish category of the property, such as basic, modern or luxury:

  • premium.property.value.rebuild.predicted_rebuild_finish

Local National Grid x coordinate (British National Grid in Great Britain; Irish Grid in Northern Ireland). Legacy name: easting:

  • property.attributes.status.x_local_grid

Local National Grid y coordinate (British National Grid in Great Britain; Irish Grid in Northern Ireland). Legacy name: northing:

  • property.attributes.status.y_local_grid

Deprecated fields

Deprecated in favour of x_local_grid and y_local_grid:

  • property.attributes.status.easting, property.attributes.status.northing

Added

v7.6.0

3 months ago

New field

Listing price estimate:

  • property.value.sale.estimated_listing_sale_value

Added

v7.5.0

5 months ago

New fields

Total count, total area (m²), and average height (m) of all outbuildings:

  • premium.property.attributes.outdoor.outbuildings_summary

Area (m²), mean height (m), volume (m³), and geometry in WKT format for each outbuilding:

  • premium.property.attributes.outdoor.outbuildings_details

Estimated floor level of the property:

  • premium.property.attributes.status.estimated_floor_level

Maximum possible floor area, when excluding features such as stairs and interior walls:

  • property.attributes.indoor.potential_floor_area

Average property value in the postcode for the property type:

  • property.value.sale.average_proximal_property_value
Added

v7.4.0

5 months ago

Added support to search by postcode.

See documentation here https://docs.chimnie.org/#postcode-search

Added

v7.3.0

5 months ago

New fields

Outbuilding rebuild costs:

  • premium.property.value.rebuild.outbuildings_rebuild_cost_estimate
Added

v7.2.0

8 months ago

New fields

Type of join for listed buildings, describing how the listed building data was matched against the property:

  • property.attributes.status.listed_building.listed_buildings.join_type
Deprecated Added

v7.1.0

8 months ago

New fields

Estimated rebuild cost for different kind of finishes.

  • premium.property.value.rebuild.basic_finish_rebuild_cost_estimate
  • premium.property.value.rebuild.modern_finish_rebuild_cost_estimate
  • premium.property.value.rebuild.luxury_finish_rebuild_cost_estimate

Breakdowns on material and labour cost for modern finish rebuilds.

  • premium.property.value.rebuild.modern_finish_material_cost_estimate
  • premium.property.value.rebuild.modern_finish_labour_cost_estimate

Please note that the premium.property.value.rebuild.estimated_rebuild_cost is now deprecated and these new fields should be used instead, although the former field will be kept indefinitely for backwards compatibility.

Added Deprecated

v7.0.0

9 months ago

Commercial Property Data API released.

The force_residential field is now deprecated, please use the new commercial data endpoints to request data for commercial and dual use properties.

Added

v6.5.0

1 year ago

New fields

Flag identifying a farm (True/NULL).

  • property.outdoor.farmland

Whether the property is a freehold or leasehold.

  • property.ownership.lease_type

The estimated banded range (e.g. 0% - 10%) of the total glazed area of the Property that is multiple glazed.

  • property.attributes.status.multi_glaze_proportion

Ranged estimate of the total glazed area of the habitable area.

  • property.attributes.status.glazed_area

Type of glazing (single, double, triple, etc.).

  • property.attributes.status.glazed_type

Extension count.

  • property.indoor.extension_count

The potential Environmental Impact Rating.

  • property.bills.energy.environment_impact_potential

The type of fuel used to power the central heating e.g. Gas, Electricity.

  • property.bills.energy.main_fuel

The Environmental Impact Rating.

  • property.bills.energy.environment_impact_current

Suggested improvements by EPC assessors and indicative cost.

  • property.bills.energy.epc_recommendations

Hot water system description.

  • property.bills.energy.hotwater_description

Current COâ‚‚ emissions in tonnes per year.

  • property.bills.energy.co2_emissions_current

Potential COâ‚‚ emissions in tonnes per year.  

  • property.bills.energy.co2_emissions_potential

Main heating control description.  

  • property.bills.energy.mainheat_control_description

Lighting system description.

  • property.bills.energy.lighting_description

List of UPRNs that share the same grounds with the property.

  • property.premium.property.attributes.status.outdoor.properties_in_grounds

Added

v6.4.0

1 year ago

New field

 Predicted property type.

  • property.attributes.status.property_type_predicted

This is provided as a cheaper alternative to the declared property type from the Plus tier as it's not dependent on third party royalties.

Added

v6.3.0

1 year ago

New fields

Historical predicted market value of the property (5 years history).

  • property.value.sale.historical_property_values

Predicted time window for the property to enter the market: <1y/1-2y/2-5y/5-10y/10+y

  • property.value.sale.sale_propensity
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 

Added

v6.1.0

1 year ago

New fields

Whether the flat is converted or purpose_built.

  • premium.property.attributes.status.flat_build_type

The predicted number of storeys in the block of flats.

  • premium.property.attributes.status.flat_storey_count_predicted

Whether the property shares its grounds with other properties.

  • premium.property.attributes.status.shared_grounds

Added

v6.0.0

1 year ago

Feature

Address autocomplete is now public.

Read more in https://docs.chimnie.com/#address-autocomplete.

Added

v5.3.0

1 year ago

New fields

The predicted council tax band for the property.

  • property.bills.tax.council_tax_band_predicted

Lower and upper bounds of the property value estimate.

  • property.value.sale.property_value_range

The confidence in the property value, one of high, medium, low.

  • property.value.sale.property_value_confidence

Added

v5.1.0

1 year ago

New fields

The risk details for a property being affected by surface water flooding, showing the individual risk for grounds and building as well as the water depth.

  • property.attributes.flood.risk_details_surface_water

The price of the most recent transaction for the property.

  • property.value.sale.last_transaction_price

The date of the most recent transaction for the property.

  • property.value.sale.last_transaction_date

These last two fields don't use credits if requested via UPRN, as they are part of the Free AVM.
Added

v4.6.0

1 year ago

New field

The type of risk associated with a property being affected by surface water in the event of a flood. Possible values are: No Risk, Buildings, Grounds.

  • property.attributes.flood.risk_category_surface_water
Added

v4.5.0

1 year ago

Feature

Added support for json-compact and csv-compact response formats. Read more in https://docs.chimnie.com/#using-the-format-parameter.

Added

v4.4.0

2 years ago

New fields

The classification of the property. One of: Residential, Commercial, Dual Use, Parent Shell or Other.

  • property.attributes.status.classification

UK region. One of East Midlands, East of England, London, North East, North West, Scotland, South East, South West, Wales, West Midlands, Yorkshire and The Humber.

  • plus.property.attributes.status.region

Country. One of England, Scotland, Wales.

  • plus.property.attributes.status.country

Added

v4.3.0

2 years ago

Feature

Added support for force_residential parameter, which forces the property to be residential even if the address is commercial, dual use or parent shell, so data can be returned. 

Added

v4.2.0

2 years ago

New fields

Area of the property grounds in square metres classified by surface type. Classes: built_surface, lawns, tarmac, tree_cover and other.

  • premium.property.attributes.outdoor.grounds_class

Tree fall hazard index, calculated as the height of the closest tree within 10m of the property divided by the distance to the tree.

  • premium.property.attributes.outdoor.tree_hazard_index

Height in metres of the closest tree within 10m of the property.

  • premium.property.attributes.outdoor.closest_tree_height

Distance in metres to the closest tree within 10m of the property.

  • premium.property.attributes.outdoor.closest_tree_distance
Added

v4.1.0

2 years ago

New field

Distance of the property in metres from the nearest road.

  • premium.property.attributes.outdoor.distance_from_road
Added

v3.6.0

2 years ago

New fields

Air pollution.

  • surroundings.environment.air.pollution_bz
  • surroundings.environment.air.pollution_com8hr
  • surroundings.environment.air.pollution_ozone
  • surroundings.environment.air.pollution_no2
  • surroundings.environment.air.pollution_nox
  • surroundings.environment.air.pollution_pm10
  • surroundings.environment.air.pollution_pm25
  • surroundings.environment.air.pollution_so2

Flood risk from reservoirs.

  • surroundings.environment.flood.reservoirs_risk_flag
  • surroundings.environment.flood.reservoirs_risk_level
  • surroundings.environment.flood.reservoirs_risk_details

Added

v3.5.0

2 years ago

New fields

UPRN of the containing building of the property, e.g. the block of flats where a flat is.

  • plus.property.attributes.status.parent_uprn

List of sibling properties, e.g. other flats within the same block.

  • plus.property.attributes.status.sibling_uprns
Added

v3.4.0

2 years ago

New field

The likelihood of the property being affected by surface water flooding in a given year, measured in % probability.

  • surroundings.environment.flood.flood_risk_surface_water

Added

v3.3.0

2 years ago

New field

Support for Parent Shells. Parent Shells return a list of contained properties in plus.property.attributes.status.subproperties.

Added

v3.2.0

2 years ago

New fields

Number of reception rooms.

  • property.attributes.indoor.reception_rooms

Date of declaration of number of reception rooms.

  • property.attributes.indoor.reception_rooms_date

Added

v3.1.0

2 years ago

Feature

We now send notification e-mails when credits are running low and when expired.

Added

v3.0.0

2 years ago

New endpoints

Find properties by their UDPRN.

Feature

Return remaining credits in chimnie-credits-remaining response header.

Added

v2.8.0

2 years ago

New properties

We now return information on pre-builds. These are denoted by the property.attributes.status.prebuild field being true. Properties of the prebuild category are part of the Premium tier and have a cost of 3 credits.

New fields

Primary and secondary heating types.

  • property.bills.energy.primary_heating_source
  • property.bills.energy.secondary_heating_source

Declaration date for bedrooms and bathrooms.

  • property.attributes.indoor.bedrooms_date
  • property.attributes.indoor.bathrooms_date

Added

v2.7.0

2 years ago

New fields

Connected property risk data (Premium tier)

  • premium.property.ownership.connected_property_risk
  • premium.property.ownership.connected_property_risk_details
  • premium.property.ownership.parent_property_risk_details

More granular property types (Plus tier)

  • plus.property.attributes.status.property_class
  • plus.property.attributes.status.property_subtype

Added

v2.6.0

2 years ago

Feature

Added support for CSV as response format.

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