{ "openapi": "3.0.1", "info": { "title": "France Energy Ratings (DPE): Homes, Energy Certificates, Sieves", "description": "DPE scraper & DPE API: official energy performance certificates (EPC, diagnostic de performance énergétique) of French homes (ADEME data) — energy efficiency class & CO2 class, address, surface, consumption, yearly bill, insulation. Find F/G energy sieves (passoires thermiques); alerts on new ones.", "version": "0.1", "x-build-id": "eO5T6athFIWypXqOm" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/euroscrape~france-energy-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-euroscrape-france-energy-ratings", "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/euroscrape~france-energy-ratings/runs": { "post": { "operationId": "runs-sync-euroscrape-france-energy-ratings", "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/euroscrape~france-energy-ratings/run-sync": { "post": { "operationId": "run-sync-euroscrape-france-energy-ratings", "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": { "locations": { "title": "Locations", "type": "array", "description": "French cities (\"Grenoble\"), postal codes (\"38000\") or INSEE codes. Paris, Lyon and Marseille cover all their arrondissements.", "items": { "type": "string" } }, "ratings": { "title": "Energy ratings", "type": "array", "description": "Keep only these DPE classes. F and G are the \"energy sieves\" (passoires thermiques). Leave empty for all classes.", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ], "enumTitles": [ "A", "B", "C", "D", "E", "F (energy sieve)", "G (energy sieve)" ] }, "default": [] }, "propertyType": { "title": "Property type", "enum": [ "all", "apartment", "house" ], "type": "string", "description": "Apartments, houses, or both.", "default": "all" }, "minSurface": { "title": "Minimum surface (m²)", "minimum": 1, "type": "integer", "description": "Living area of at least this many square metres." }, "maxSurface": { "title": "Maximum surface (m²)", "minimum": 1, "type": "integer", "description": "Living area of at most this many square metres." }, "issuedAfter": { "title": "Issued since", "type": "string", "description": "Only certificates issued on or after this date (YYYY-MM-DD). A recent certificate usually means a sale or a new lease is coming." }, "maxRatingsPerLocation": { "title": "Maximum ratings per location", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Most recent certificates first.", "default": 100 }, "includeSummary": { "title": "Add a free summary per location", "type": "boolean", "description": "Breakdown of all certificates of the location by class (A-G), with the share of F/G energy sieves.", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Set a name and schedule the Actor (e.g. daily): after the first baseline run, each run delivers only the certificates you have not seen yet, and sends alerts." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Alerts on Telegram: create a bot with @BotFather and paste its token." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "Your chat ID (send a message to your bot, then open api.telegram.org/bot/getUpdates)." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Alerts in a Discord channel: Channel settings → Integrations → Webhooks." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Alerts in Slack: create an Incoming Webhook for your channel." }, "webhookUrl": { "title": "Webhook URL (JSON)", "type": "string", "description": "Receives one POST per run with the new energy ratings (Make, Zapier, n8n…)." }, "maxNotifications": { "title": "Maximum alerts per run", "minimum": 1, "maximum": 200, "type": "integer", "description": "Maximum number of alert messages per run.", "default": 30 } } }, "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 } } } } } } } } } }