Epc planner
curl --request GET \
--url https://api.sortx.co.uk/compliance/epc-planner \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/epc-planner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/epc-planner"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"dataAsOf": "<string>",
"policyVersion": "<string>",
"items": [
{
"propertyId": "<string>",
"address": "<string>",
"postcode": "<string>",
"standing": "below_c",
"rating": "A",
"bandsToC": 123,
"certificate": {
"documentId": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"reference": "<string>"
},
"expiredOn": "<string>",
"measures": [
{
"measure": "<string>",
"costLowMinor": 123,
"costHighMinor": 123,
"ratingAfter": "A",
"scoreAfter": 123
}
],
"measuresSource": "read",
"potentialRating": "A",
"toC": {
"steps": 123,
"costLowMinor": 123,
"costHighMinor": 123,
"basis": "steps"
},
"dates": [
{
"on": "<string>",
"kind": "epc_expires",
"label": "<string>"
}
],
"landlordContactId": "<string>",
"landlord": "<string>"
}
],
"summary": {
"properties": 123,
"belowC": 123,
"cOrAbove": 123,
"noRating": 123,
"noEpc": 123,
"indicativeToC": {
"costLowMinor": 123,
"costHighMinor": 123,
"properties": 123
}
},
"landlords": [
{
"id": "<string>",
"name": "<string>"
}
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}compliance
Epc planner
Every active property’s EPC band, its gap to band C, the measures its certificate recommends and the band C dates (advisory: not law yet)
GET
/
compliance
/
epc-planner
Epc planner
curl --request GET \
--url https://api.sortx.co.uk/compliance/epc-planner \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sortx.co.uk/compliance/epc-planner', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sortx.co.uk/compliance/epc-planner"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"today": "<string>",
"dataAsOf": "<string>",
"policyVersion": "<string>",
"items": [
{
"propertyId": "<string>",
"address": "<string>",
"postcode": "<string>",
"standing": "below_c",
"rating": "A",
"bandsToC": 123,
"certificate": {
"documentId": "<string>",
"issuedOn": "<string>",
"expiresOn": "<string>",
"reference": "<string>"
},
"expiredOn": "<string>",
"measures": [
{
"measure": "<string>",
"costLowMinor": 123,
"costHighMinor": 123,
"ratingAfter": "A",
"scoreAfter": 123
}
],
"measuresSource": "read",
"potentialRating": "A",
"toC": {
"steps": 123,
"costLowMinor": 123,
"costHighMinor": 123,
"basis": "steps"
},
"dates": [
{
"on": "<string>",
"kind": "epc_expires",
"label": "<string>"
}
],
"landlordContactId": "<string>",
"landlord": "<string>"
}
],
"summary": {
"properties": 123,
"belowC": 123,
"cOrAbove": 123,
"noRating": 123,
"noEpc": 123,
"indicativeToC": {
"costLowMinor": 123,
"costHighMinor": 123,
"properties": 123
}
},
"landlords": [
{
"id": "<string>",
"name": "<string>"
}
]
}{
"_tag": "TenantCreateRejected",
"reason": "<string>",
"field": "<string>"
}{
"_tag": "Unauthenticated"
}{
"_tag": "TenantSuspended",
"tenantId": "<string>",
"reason": "<string>"
}{
"_tag": "EntitlementMissing",
"tenantId": "<string>",
"moduleId": "<string>"
}{
"_tag": "TenantNotFound",
"slug": "<string>"
}{
"_tag": "WebhookDuplicate",
"integration": "<string>",
"externalId": "<string>"
}{
"_tag": "RateLimited",
"key": "<string>",
"retryAfterSeconds": 123,
"message": "<string>"
}{
"_tag": "IntegrationUnavailable",
"integration": "<string>",
"detail": "<string>"
}Authorizations
A workspace API key (Settings → API keys), scoped to <group>:read / <group>:write.