{ "openapi": "3.0.1", "info": { "title": "France Real Estate Sold Prices (DVF): €/m², Sales & Trends", "description": "Real estate France: sold house prices from the State's record of property sales in France (DVF, valeurs foncières, prix immobilier) — price, €/m², address, 2021-2025, with the energy rating (DPE) of the home sold and indicative rental yield (rendement locatif). Medians per city, alerts on new sales.", "version": "0.1", "x-build-id": "rT2XOZQeNf1Yok7sd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/euroscrape~france-property-prices/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-euroscrape-france-property-prices", "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-property-prices/runs": { "post": { "operationId": "runs-sync-euroscrape-france-property-prices", "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-property-prices/run-sync": { "post": { "operationId": "run-sync-euroscrape-france-property-prices", "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, postal codes or INSEE codes: \"Grenoble\", \"Paris\", \"38000\", \"33063\"… Paris, Lyon and Marseille automatically cover all their arrondissements.", "items": { "type": "string" } }, "years": { "title": "Years", "type": "array", "description": "Sale years to load, between 2021 and 2025 (the State publishes DVF data with a few months of delay, in April and October).", "default": [ 2024, 2025 ] }, "propertyTypes": { "title": "Property types", "type": "array", "description": "house, apartment, commercial, land, outbuilding.", "items": { "type": "string", "enum": [ "house", "apartment", "commercial", "land", "outbuilding" ], "enumTitles": [ "Houses", "Apartments", "Commercial premises", "Land", "Outbuildings" ] }, "default": [ "house", "apartment" ] }, "minSurface": { "title": "Minimum living surface (m²)", "minimum": 0, "type": "integer", "description": "Keep sales with at least this living surface." }, "maxSurface": { "title": "Maximum living surface (m²)", "minimum": 1, "type": "integer", "description": "Keep sales up to this living surface." }, "minPrice": { "title": "Minimum price (€)", "minimum": 0, "type": "integer", "description": "Keep sales at or above this price." }, "maxPrice": { "title": "Maximum price (€)", "minimum": 1, "type": "integer", "description": "Keep sales up to this price." }, "minRooms": { "title": "Minimum main rooms", "minimum": 1, "type": "integer", "description": "Keep dwellings with at least this many main rooms." }, "newBuild": { "title": "New builds (VEFA)", "enum": [ "include", "only", "exclude" ], "type": "string", "description": "Off-plan sales (vente en l'état futur d'achèvement).", "default": "include" }, "maxSalesPerLocation": { "title": "Maximum sales per location", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Most recent first. Summary statistics still use ALL matching sales.", "default": 500 }, "includeSummary": { "title": "Add a free summary per location", "type": "boolean", "description": "Median €/m² and price for apartments and houses, year-by-year trend, share of new builds, most active streets.", "default": true }, "includeEnergyRating": { "title": "Add the energy rating (DPE) of each home sold", "type": "boolean", "description": "Matches each sale to its official energy performance certificate (ADEME open data): energy class A-G, CO2 class, kWh/m²/year and certificate date. Free. A class is only attached when the address, property type, surface and date agree; about one sale in two gets one.", "default": true }, "includeRentalYield": { "title": "Add an indicative gross rental yield", "type": "boolean", "description": "For each sale: the State's asking-rent indicator of the commune for a typical home of that kind (Carte des loyers, charges included), and the gross yield it implies at the real sale price. The free summary gives median yields per city and ranks communes or arrondissements. Free, no extra time.", "default": true }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Set a name and schedule the Actor (e.g. monthly): each run then flags sales it has not seen before — the State adds fresh sales about twice a year." }, "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 sales (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 } } } } } } } } } }