Documentation

Guidance around API usage and specific endpoint documentation.

The base URL for the API is https://api.epcdata.scot.

Endpoints are authenticated by API key.

Results are paginated and by default, the first 100 results are returned, which can be changed by the limit query parameter. To get the next pages use the returned _meta.cursor as the value for the cursor query parameter.

To achieve interoperability with the original England and Wales domestic search API, the following transformations were applied to the EPC CSV data:

kebab-case field keys.
For dwellings with multiple efficiency ratings, only take the first rating.
Generate an address field, a comma seperated combination of the other address (address1, address2 and address3) fields.
Only return latest certificate for an address.
Standardise inspection-date to the %Y-%m-%d format.
Parse out invalid values (e.g. when non-numeric provided for numeric ones, or enum value does not match).

The 10-digit uprn from Scottish Energy Performance Certificate Register is mapped to building-reference-number.

The 9-12-digit uprn from One Scotland Gazetteer is mapped to uprn.