{ "openapi": "3.0.1", "info": { "title": "Energy Certificate Checker for Property Listings", "description": "Check EU property ads for missing energy certificate details: Germany's Energieausweis items under GEG ยง87, France's DPE energy and climate class, annual energy cost and F/G notice, and the energy class EU EPBD 2024/1275 requires on portals (ES, IT and others). Sources per finding.", "version": "0.1", "x-build-id": "QV4BwY6dOyq7QbceW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ultimatemc~property-energy-certificate-checker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ultimatemc-property-energy-certificate-checker", "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/ultimatemc~property-energy-certificate-checker/runs": { "post": { "operationId": "runs-sync-ultimatemc-property-energy-certificate-checker", "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/ultimatemc~property-energy-certificate-checker/run-sync": { "post": { "operationId": "run-sync-ultimatemc-property-energy-certificate-checker", "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": { "listings": { "title": "Listings", "type": "array", "description": "Array of objects with \"title\", \"description\" and optional \"country\" (DE, FR, ES, IT...), \"energyClass\", \"energyValue\", \"certificateType\", \"energyCarrier\", \"yearBuilt\", \"ghgClass\", \"energyCost\", \"propertyType\", \"id\" and \"url\". The prefilled example shows common gaps next to complete ads; replace it with your own." }, "texts": { "title": "Listing texts only (simple mode)", "type": "array", "description": "One listing description per entry; set Default market so the right country rules apply.", "items": { "type": "string" } }, "market": { "title": "Default market", "type": "string", "description": "Two-letter country code used when a listing has no country field and the URL doesn't show it (e.g. DE, FR, ES, IT, AT, PT)." }, "datasetId": { "title": "Dataset ID (optional)", "type": "string", "description": "Apify dataset with property listings, for example the output of an ImmoScout24, Immowelt, Kleinanzeigen, SeLoger, Leboncoin, Idealista or Immobiliare.it scraper. Common fields (description, energyEfficiencyClass, thermalCharacteristic, constructionYear) are detected automatically; override them with Field map." }, "fieldMap": { "title": "Field map (optional)", "type": "object", "description": "Override field names; dotted paths work for nested fields. Example: {\"energyClass\": \"energyCertificate.energyEfficiencyClass\", \"description\": \"descriptionNote\"}." }, "onlyFlagged": { "title": "Only save rows with findings", "type": "boolean", "description": "Skip listings with no findings (you are only charged for saved rows).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 200000, "type": "integer", "description": "Maximum number of listings to check in this run.", "default": 20000 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }