{ "openapi": "3.0.1", "info": { "title": "French Property Data — PLU Zoning, DPE, Risks, DVF Prices", "description": "Enrich any French address, cadastral parcel or coordinate with its PLU zoning, nearby DPE energy ratings, the full Géorisques risk profile, and real recorded sale prices from the DVF register — in one flat row.", "version": "0.1", "x-build-id": "jPXt1tE00TTlBkvoH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dalbian~french-property-due-diligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dalbian-french-property-due-diligence", "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/dalbian~french-property-due-diligence/runs": { "post": { "operationId": "runs-sync-dalbian-french-property-due-diligence", "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/dalbian~french-property-due-diligence/run-sync": { "post": { "operationId": "run-sync-dalbian-french-property-due-diligence", "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 postal addresses, one per line. Each is geocoded against the official BAN address base before the surrounding records are gathered. Use this for a client file, a prospect list or a property portfolio.", "default": [ "39 rue du Félibrige, 84270 Vedène" ], "items": { "type": "string" } }, "parcels": { "title": "Cadastral parcels", "type": "array", "description": "Cadastral references as 'insee,section,number' (84141,AW,1) or a full 14-character id (84141000AW0001), one per line. The parcel is the right unit for permit and land-acquisition work, where a street address is ambiguous.", "items": { "type": "string" } }, "coordinates": { "title": "Coordinates (lon,lat)", "type": "array", "description": "WGS84 pairs as 'longitude,latitude', longitude first as in GeoJSON. Use this when your data is already geocoded and you want to skip address matching.", "items": { "type": "string" } }, "radiusMeters": { "title": "Search radius (metres)", "minimum": 25, "maximum": 5000, "type": "integer", "description": "How far around each point to look for energy records, recorded sales, classified facilities and polluted sites. 300 m covers a neighbourhood; drop to 100 m in a dense city centre, raise to 1000 m in open countryside where the nearest comparable sale may be far away.", "default": 300 }, "includeZoning": { "title": "Include urban planning", "type": "boolean", "description": "Return the PLU zone covering the point, its official label, and a link to the written règlement. This is what tells you whether anything can be built at all.", "default": true }, "includeEnergyRating": { "title": "Include energy performance (DPE)", "type": "boolean", "description": "Return the nearest energy-performance certificates from ADEME's register: energy and greenhouse classes, floor area, year built and assessment date. Useful to place a property against its immediate neighbours.", "default": true }, "includeRisks": { "title": "Include risks", "type": "boolean", "description": "Return the Géorisques profile: clay shrink-swell exposure, seismic zone, radon potential, the commune's declared risks and past natural-disaster orders, plus classified industrial facilities and recorded polluted sites within the radius.", "default": true }, "includeSalePrices": { "title": "Include recorded sale prices (DVF)", "type": "boolean", "description": "Return real recorded property sales around the point from the DVF register, with a median price per square metre. These are actual transfer prices from the tax administration, not asking prices.", "default": true }, "salePriceYears": { "title": "Sale price years", "type": "array", "description": "Which DVF years to read, such as 2024 and 2023. Leave empty for the three most recent available. More years means more comparable sales but a slower run.", "items": { "type": "string" } }, "maxRecordsPerSource": { "title": "Records per source", "minimum": 1, "maximum": 50, "type": "integer", "description": "How many individual energy certificates and recorded sales to list per location. Counts and medians are always computed over everything found in the radius; this only caps the detail rows.", "default": 5 }, "maxLocations": { "title": "Maximum locations", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Hard stop on how many locations this run processes. Set it below your list size for a cheap trial before committing a full batch.", "default": 500 } } }, "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 } } } } } } } } } }