{ "openapi": "3.0.1", "info": { "title": "France Price per m² by Address – Batch DVF Comps", "description": "Paste a list of French addresses and get the median, quartiles and yearly trend of price per m² from real notarised sales (official DVF open data) around each one, for flats and houses, plus an optional value range for a given surface. One row per address, $0.01 each.", "version": "1.0", "x-build-id": "oUn4FOvKGDWR6MF4F" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/characteristic_division~dvf-price-per-m2-batch/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-characteristic_division-dvf-price-per-m2-batch", "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/characteristic_division~dvf-price-per-m2-batch/runs": { "post": { "operationId": "runs-sync-characteristic_division-dvf-price-per-m2-batch", "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/characteristic_division~dvf-price-per-m2-batch/run-sync": { "post": { "operationId": "run-sync-characteristic_division-dvf-price-per-m2-batch", "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": { "addresses": { "title": "Addresses", "type": "array", "description": "French addresses, one per line (max 5,000). For a value estimate, use objects instead: {\"address\": \"12 rue Sainte-Catherine, Bordeaux\", \"propertyType\": \"Appartement\", \"surface\": 55, \"rooms\": 2, \"label\": \"my-id\"}." }, "points": { "title": "Coordinates (optional)", "type": "array", "description": "Already geocoded points: [{\"lat\": 48.869, \"lon\": 2.331, \"label\": \"site A\"}]. Same optional fields as addresses (propertyType, surface, rooms)." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Which DVF dwelling types to aggregate when an address does not set its own propertyType.", "items": { "type": "string", "enum": [ "Appartement", "Maison" ], "enumTitles": [ "Flats (Appartement)", "Houses (Maison)" ] }, "default": [ "Appartement", "Maison" ] }, "radiusMeters": { "title": "Search radius (m)", "minimum": 50, "maximum": 5000, "type": "integer", "description": "Initial radius around each address.", "default": 500 }, "minComparables": { "title": "Minimum number of sales", "minimum": 1, "maximum": 200, "type": "integer", "description": "If fewer sales are found, the radius doubles until this number is reached or the maximum radius is hit.", "default": 10 }, "maxRadiusMeters": { "title": "Maximum radius (m)", "minimum": 50, "maximum": 5000, "type": "integer", "description": "Upper bound for the auto-expanding radius.", "default": 2000 }, "yearsBack": { "title": "Number of years", "minimum": 1, "maximum": 6, "type": "integer", "description": "Use the N most recent DVF years published (auto-detected). Ignored when 'years' is set.", "default": 3 }, "years": { "title": "Specific years (optional)", "type": "array", "description": "E.g. [2023, 2024]. Leave empty to use the latest published years." }, "surfaceTolerancePct": { "title": "Surface tolerance (%)", "minimum": 5, "maximum": 100, "type": "integer", "description": "When an address gives propertyType + surface, only sales within ±this % of that surface are used.", "default": 30 }, "includeVefa": { "title": "Include off-plan new-builds (VEFA)", "type": "boolean", "description": "Off-plan sales are priced higher than resale; excluded by default.", "default": false }, "includeComparables": { "title": "Include comparable sales list", "type": "boolean", "description": "Adds the nearest sales (date, price, surface, rooms, €/m², distance, street name). House numbers, parcel IDs and exact coordinates are never output.", "default": false }, "maxComparables": { "title": "Max comparables per type", "minimum": 1, "maximum": 50, "type": "integer", "description": "Only used when the comparables list is enabled.", "default": 10 }, "minGeocodeScore": { "title": "Minimum geocoding score", "minimum": 0, "maximum": 1, "type": "number", "description": "Addresses matched by the national address base (BAN) below this score (0–1) are rejected and not charged.", "default": 0.5 } } }, "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 } } } } } } } } } }