{
"openapi": "3.0.1",
"info": {
"title": "UK EPC Register Scraper · Energy Certificates + Assessors",
"description": "Search the official UK Energy Certificate Register (England, Wales & Northern Ireland) by postcode, street or certificate number. Get EPC/CEPC/DEC/AC certificates with ratings, floor areas, energy use, CO2, improvement steps and assessor contacts. Pay only for results.",
"version": "0.1",
"x-build-id": "wcvKhlMKhb9JhLT2n"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/automation_craft~uk-energy-certificate-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-automation_craft-uk-energy-certificate-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/acts/automation_craft~uk-energy-certificate-scraper/runs": {
"post": {
"operationId": "runs-sync-automation_craft-uk-energy-certificate-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor and returns information about the initiated run in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/runsResponseSchema"
}
}
}
}
}
}
},
"/acts/automation_craft~uk-energy-certificate-scraper/run-sync": {
"post": {
"operationId": "run-sync-automation_craft-uk-energy-certificate-scraper",
"x-openai-isConsequential": false,
"summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
"tags": [
"Run Actor"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/inputSchema"
}
}
}
},
"parameters": [
{
"name": "token",
"in": "query",
"required": true,
"schema": {
"type": "string"
},
"description": "Enter your Apify token here"
}
],
"responses": {
"200": {
"description": "OK"
}
}
}
}
},
"components": {
"schemas": {
"inputSchema": {
"type": "object",
"properties": {
"postcodes": {
"title": "Postcodes",
"type": "array",
"description": "UK postcodes to search, e.g. LS6 1EF. Every certificate registered at each postcode is returned (England, Wales and Northern Ireland; Scotland has a separate register that this actor does not cover). Casing and spacing are normalized automatically.",
"items": {
"type": "string"
}
},
"streetSearches": {
"title": "Street searches",
"type": "array",
"description": "Optional street-level searches as objects: [{\"streetName\": \"Hessle Avenue\", \"town\": \"Leeds\"}]. Broad streets in big towns can come back as 'too many results' — the register refuses to list them; use postcodes instead in that case (a free status item is emitted, nothing is charged)."
},
"certificateUrls": {
"title": "Certificate URLs or numbers",
"type": "array",
"description": "Optional direct certificate lookups: full URLs like https://find-energy-certificate.service.gov.uk/energy-certificate/0260-2870-6219-9191-6111 or 20-digit certificate numbers (dashes optional). Each is fetched as a full certificate item.",
"items": {
"type": "string"
}
},
"register": {
"title": "Register",
"enum": [
"domestic",
"non-domestic",
"both"
],
"type": "string",
"description": "Which register to search: domestic (homes — EPCs), non-domestic (commercial buildings — CEPC, DEC, air-conditioning certificates) or both. Direct certificate URLs work regardless of this setting."
},
"fetchDetails": {
"title": "Fetch full certificate details",
"type": "boolean",
"description": "Off (default): emit cheap search-result rows only (address, rating, valid-until, certificate link). On: also open every certificate and emit the full detail item — scores, floor area, energy use, CO2, improvement steps and assessor contact details. Full details cost more per item, so this is off unless you switch it on."
},
"ratingFilter": {
"title": "Rating filter",
"type": "array",
"description": "Only keep certificates whose CURRENT rating is in this list (e.g. [\"F\",\"G\"] for MEES-non-compliant properties). Empty = all ratings. Applied client-side after the search. Note: non-domestic search rows carry no rating, so combine this filter with Fetch full certificate details when searching the non-domestic register.",
"items": {
"type": "string",
"enum": [
"A+",
"A",
"B",
"C",
"D",
"E",
"F",
"G"
],
"enumTitles": [
"A+ (non-domestic only)",
"A",
"B",
"C",
"D",
"E",
"F",
"G"
]
}
},
"maxItems": {
"title": "Max charged items",
"minimum": 1,
"type": "integer",
"description": "Hard cap on the number of charged result items (search-result rows + certificate details) for this run, honored exactly. Status items and the run summary are always free."
}
}
},
"runsResponseSchema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"actId": {
"type": "string"
},
"userId": {
"type": "string"
},
"startedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"finishedAt": {
"type": "string",
"format": "date-time",
"example": "2025-01-08T00:00:00.000Z"
},
"status": {
"type": "string",
"example": "READY"
},
"meta": {
"type": "object",
"properties": {
"origin": {
"type": "string",
"example": "API"
},
"userAgent": {
"type": "string"
}
}
},
"stats": {
"type": "object",
"properties": {
"inputBodyLen": {
"type": "integer",
"example": 2000
},
"rebootCount": {
"type": "integer",
"example": 0
},
"restartCount": {
"type": "integer",
"example": 0
},
"resurrectCount": {
"type": "integer",
"example": 0
},
"computeUnits": {
"type": "integer",
"example": 0
}
}
},
"options": {
"type": "object",
"properties": {
"build": {
"type": "string",
"example": "latest"
},
"timeoutSecs": {
"type": "integer",
"example": 300
},
"memoryMbytes": {
"type": "integer",
"example": 1024
},
"diskMbytes": {
"type": "integer",
"example": 2048
}
}
},
"buildId": {
"type": "string"
},
"defaultKeyValueStoreId": {
"type": "string"
},
"defaultDatasetId": {
"type": "string"
},
"defaultRequestQueueId": {
"type": "string"
},
"buildNumber": {
"type": "string",
"example": "1.0.0"
},
"containerUrl": {
"type": "string"
},
"usage": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "integer",
"example": 1
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
},
"usageTotalUsd": {
"type": "number",
"example": 0.00005
},
"usageUsd": {
"type": "object",
"properties": {
"ACTOR_COMPUTE_UNITS": {
"type": "integer",
"example": 0
},
"DATASET_READS": {
"type": "integer",
"example": 0
},
"DATASET_WRITES": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_READS": {
"type": "integer",
"example": 0
},
"KEY_VALUE_STORE_WRITES": {
"type": "number",
"example": 0.00005
},
"KEY_VALUE_STORE_LISTS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_READS": {
"type": "integer",
"example": 0
},
"REQUEST_QUEUE_WRITES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_INTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"DATA_TRANSFER_EXTERNAL_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
"type": "integer",
"example": 0
},
"PROXY_SERPS": {
"type": "integer",
"example": 0
}
}
}
}
}
}
}
}
}
}