{ "openapi": "3.0.1", "info": { "title": "France DVF Sold Prices & DPE Energy Ratings (MCP)", "description": "France property data: notarial sold prices (DVF, notaires) + ADEME DPE energy ratings — price, address, GPS, surfaces, energy class, consumption and cost. French sold prices and energy certificates. MCP-ready for AI agents.", "version": "0.0", "x-build-id": "7flfTuZSee5BWVsdE" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/amygraphics~france-property-data-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-amygraphics-france-property-data-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/amygraphics~france-property-data-scraper/runs": { "post": { "operationId": "runs-sync-amygraphics-france-property-data-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/amygraphics~france-property-data-scraper/run-sync": { "post": { "operationId": "run-sync-amygraphics-france-property-data-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": { "mode": { "title": "Mode", "enum": [ "transactions", "dpe" ], "type": "string", "description": "`transactions` = official notarial sales (DVF, per department or commune, 2021-2025). `dpe` = ADEME energy-performance certificates (15.7 M records) with DPE/GES labels.", "default": "transactions" }, "departments": { "title": "Departments", "type": "array", "description": "French department codes, e.g. 75, 92, 13, 2A, 971. Used by both modes.", "items": { "type": "string" }, "default": [ "75" ] }, "communes": { "title": "Communes (INSEE codes)", "type": "array", "description": "Optional INSEE commune codes for precision, e.g. 75111 (Paris 11e), 33063 (Bordeaux). When set, departments are ignored for DVF.", "items": { "type": "string" }, "default": [] }, "years": { "title": "Years (DVF only)", "type": "array", "description": "Years to read for transactions: 2021, 2022, 2023, 2024 or 2025.", "items": { "type": "string" }, "default": [ "2025", "2024" ] }, "propertyTypes": { "title": "Property types (DVF)", "type": "array", "description": "Keep only mutations containing these property types, e.g. Appartement, Maison, Dépendance, Local industriel. commercial ou assimilé, Terrain.", "items": { "type": "string" }, "default": [ "Appartement", "Maison" ] }, "natures": { "title": "Mutation natures (DVF)", "type": "array", "description": "Optional exact filter on the mutation nature, e.g. 'Vente', 'Vente en bloc', 'Adjudication', 'Echange'.", "items": { "type": "string" }, "default": [] }, "minValue": { "title": "Min price (€)", "type": "integer", "description": "Keep only transactions at or above this price." }, "maxValue": { "title": "Max price (€)", "type": "integer", "description": "Keep only transactions at or below this price." }, "minSurface": { "title": "Min built surface (m²)", "type": "integer", "description": "Minimum total built surface of the transaction." }, "maxSurface": { "title": "Max built surface (m²)", "type": "integer", "description": "Maximum total built surface of the transaction." }, "energyClasses": { "title": "DPE energy classes (dpe mode)", "type": "array", "description": "Energy labels to keep: A to G. Use F, G to target poor-performing ('passoires thermiques') dwellings.", "items": { "type": "string" }, "default": [] }, "gesClasses": { "title": "GES classes (dpe mode)", "type": "array", "description": "Greenhouse-gas labels to keep: A to G.", "items": { "type": "string" }, "default": [] }, "buildingTypes": { "title": "Building types (dpe mode)", "type": "array", "description": "ADEME building types: appartement, immeuble, maison.", "items": { "type": "string" }, "default": [] }, "dateFrom": { "title": "DPE established from (dpe mode)", "type": "string", "description": "Start date of the DPE establishment date range, format YYYY-MM-DD.", "default": "" }, "dateTo": { "title": "DPE established until (dpe mode)", "type": "string", "description": "End date of the DPE establishment date range, format YYYY-MM-DD.", "default": "" }, "maxResults": { "title": "Max records to extract", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of records to extract in this run. One billable event per extracted record.", "default": 200 }, "chargedEventName": { "title": "Billable event name", "type": "string", "description": "Pay-per-event name charged for each successfully extracted record.", "default": "record-extracted" } } }, "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 } } } } } } } } } }