Documentation

Guidance around API usage and specific endpoint documentation.

The REST API can be accessed on https://api.epcdata.scot with the obtained 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.

This endpoint aims to mimic the API for England and Wales provided by The Department for Levelling Up, Housing & Communities.

To achieve this the data has gone through some additional transformation:

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.

This endpoint exposes all fields documented below without any cleaning or transformation.