{ "openapi": "3.0.1", "info": { "title": "ADEME DPE Scraper: 25M+ French Energy Diagnostics", "description": "Search 25M+ French Energy Performance Diagnostics from the official ADEME database. Filter by city, postal, dept, DPE class (A-G), GES class, surface, year built. Get class, GES, address, GPS, energy use. Mandatory data in French real-estate ads. For agents, hunters, marchands, renovators. $2/1K.", "version": "1.0", "x-build-id": "OdRe09YeVQqHnZ0JQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dltik~ademe-dpe-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dltik-ademe-dpe-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/dltik~ademe-dpe-scraper/runs": { "post": { "operationId": "runs-sync-dltik-ademe-dpe-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/dltik~ademe-dpe-scraper/run-sync": { "post": { "operationId": "run-sync-dltik-ademe-dpe-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": { "dataset": { "title": "Dataset", "enum": [ "logements-existants", "logements-anciens", "logements-neufs", "tertiaire-recent", "tertiaire-ancien" ], "type": "string", "description": "Which ADEME DPE dataset to query. 'logements-existants' covers most use-cases (post-July-2021, 14.6M records).", "default": "logements-existants" }, "code_postal": { "title": "Postal code", "type": "string", "description": "5-digit postal code. Examples: '75001' (Paris 1), '69002' (Lyon 2), '13001' (Marseille 1)." }, "code_insee": { "title": "INSEE code", "type": "string", "description": "INSEE city code (different from postal). Example: '75101' for Paris 1st arrondissement." }, "nom_commune": { "title": "City name", "type": "string", "description": "Exact city name (case-sensitive in some cases). Example: 'Paris', 'Lyon', 'Marseille'." }, "code_departement": { "title": "Department code", "type": "string", "description": "Two-digit department code (e.g. '75', '69', '13', '92')." }, "code_region": { "title": "Region code", "type": "string", "description": "Two-digit region code (11 = Île-de-France, 84 = Auvergne-Rhône-Alpes, 93 = PACA)." }, "etiquette_dpe": { "title": "DPE class", "type": "array", "description": "Filter by energy class A (best) to G (worst, 'passoire thermique'). Multiple = OR. Example: ['F','G'] for 'passoires'.", "items": { "type": "string" }, "default": [] }, "etiquette_ges": { "title": "GES class", "type": "array", "description": "Filter by GHG emission class A-G.", "items": { "type": "string" }, "default": [] }, "type_batiment": { "title": "Building type", "enum": [ "appartement", "maison", "immeuble" ], "type": "string", "description": "'appartement', 'maison', or 'immeuble'." }, "type_installation_chauffage": { "title": "Heating type", "enum": [ "individuel", "collectif", "mixte" ], "type": "string", "description": "'individuel' or 'collectif'." }, "zone_climatique": { "title": "Climate zone", "type": "string", "description": "FR climate zone: H1a, H1b, H1c, H2a, H2b, H2c, H2d, H3." }, "surface_min": { "title": "Min surface (m²)", "minimum": 0, "type": "integer", "description": "Minimum living area (surface habitable) in m²." }, "surface_max": { "title": "Max surface (m²)", "minimum": 0, "type": "integer", "description": "Maximum living area in m²." }, "annee_construction_min": { "title": "Min construction year", "minimum": 1700, "maximum": 2030, "type": "integer", "description": "Earliest year of construction." }, "annee_construction_max": { "title": "Max construction year", "minimum": 1700, "maximum": 2030, "type": "integer", "description": "Latest year of construction." }, "date_etablissement_apres": { "title": "DPE established after", "type": "string", "description": "ISO date — only DPE established after this date." }, "date_etablissement_avant": { "title": "DPE established before", "type": "string", "description": "ISO date — only DPE established before this date." }, "validite_apres": { "title": "Valid until after", "type": "string", "description": "ISO date — only DPE valid until on/after this date." }, "freeText": { "title": "Free text search", "type": "string", "description": "Full-text search across all fields. Combine with filters above." }, "raw_qs": { "title": "Raw qs query (advanced)", "type": "string", "description": "Append a raw Lucene-style query to the auto-built one. Example: 'consommation_energie_finale:[100 TO 200]'." }, "addLatLon": { "title": "Convert Lambert-93 → lat/lon", "type": "boolean", "description": "Auto-convert ADEME's Lambert-93 coords to standard lat/lon (WGS84).", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Max diagnostics to return.", "default": 100 }, "proxyConfig": { "title": "Proxy (rarely needed)", "type": "object", "description": "Optional. ADEME open API rarely needs proxy.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }