{ "openapi": "3.0.1", "info": { "title": "France Property Sale Prices Scraper (DVF Open Data)", "description": "Recorded property sales in France from the government's DVF open data: date, price, address, property type, built and land area, rooms, price per m² and GPS position, by town. Newest sales first.", "version": "0.1", "x-build-id": "cNJ2FrYOrJsmsYTpP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/soogrow_berries~france-property-sales-dvf-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-soogrow_berries-france-property-sales-dvf-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/soogrow_berries~france-property-sales-dvf-scraper/runs": { "post": { "operationId": "runs-sync-soogrow_berries-france-property-sales-dvf-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/soogrow_berries~france-property-sales-dvf-scraper/run-sync": { "post": { "operationId": "run-sync-soogrow_berries-france-property-sales-dvf-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": { "communes": { "title": "Towns (communes)", "type": "array", "description": "Town names or INSEE codes, such as \"Bordeaux\", \"33063\" or \"Saint-Denis 974\" (a department code after the name picks between towns of the same name; without it the largest is used). Paris, Lyon and Marseille cover all their arrondissements.", "items": { "type": "string" } }, "postalCodes": { "title": "Postal codes", "type": "array", "description": "Optional. Postal codes, such as \"33000\" or \"75011\"; each adds the towns that use it.", "items": { "type": "string" } }, "years": { "title": "Years", "type": "array", "description": "Optional. Years of sales to read, such as \"2025\" or \"2024\". Default: the newest year published. DVF is published twice a year, with a delay of about six months.", "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional. Keep only these main property types: Maison (house), Appartement (flat), Local (shop, office or industrial premises), Dépendance (garage, cellar, parking), Terrain (land only). Sales left out are not charged.", "items": { "type": "string" } }, "minPriceEur": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Optional. Keep only sales at or above this price. Sales left out are not charged." }, "maxPriceEur": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Optional. Keep only sales at or below this price. Sales left out are not charged." }, "startUrls": { "title": "DVF town files", "type": "array", "description": "Optional. DVF files by town and year from data.gouv.fr, such as https://files.data.gouv.fr/geo-dvf/latest/csv/2025/communes/33/33063.csv.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after saving this many sales. You pay per result, so this also caps the cost.", "default": 20 }, "onlyNew": { "title": "Only new results", "type": "boolean", "description": "Skip sales that an earlier run with the same towns and filters already saved. Skipped sales are not saved and not charged. The list of saved IDs is kept in a key-value store named \"france-property-sales-dvf-scraper-seen\" in your Apify account; delete it to start over.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. The Actor runs without a 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 }, "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 } } } } } } } } } }