Obtaining EPC images
For users wanting to obtain the EPC graph images in the API response they will have to uses the include request parameter to specify they want it included:
?include=epc.image
This is telling the API that you would like the EPC included AND it's related image if it is present.
Once this is done (and the property has an EPC and associated image) you will be able to find the following in the response:
{
"type": "epc",
"id": "a36343ca-5a9c-4b25-b945-664485ad5faa",
"attributes": {
"rating": "C",
"report_url": null,
"energy_efficiency_current": "72.0",
"energy_efficiency_potential": "89.0",
"environment_impact_current": "74.00",
"environment_impact_potential": "92.00",
"created_at": "2022-07-28T15:00:05+01:00",
"updated_at": "2022-07-28T15:00:05+01:00"
},
"relationships": {
"image": {
"data": {
"type": "image",
"id": "80edbb92-eda8-42a8-88d0-62619cae57a5"
}
}
}
The image details will then be available as an image object in the response and can be identified by it's id as shown below:
{
"type": "image",
"id": "80edbb92-eda8-42a8-88d0-62619cae57a5",
"attributes": {
"name": "media-libraryepGhpl",
"order": 1511622,
"is_featured": null,
"feature_index": null,
"title": null,
"media_type": null,
"is_image": true,
"url": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_feed_full\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png",
"urls": {
"thumbnail": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_thumb\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png",
"small": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_small_fill_crop\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png",
"medium": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_medium_fill_crop\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png",
"large": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_large_fill_crop\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png",
"hero": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_hero\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png",
"full": "https:\/\/ik.imagekit.io\/street\/street-live\/tr:pr-true,n-property_feed_full\/epcs\/property_epcs_image\/3021145\/9e3bbdcb-ccd2-498b-b925-3ceff4780ea2.png"
}
}
},