{ "openapi": "3.0.1", "info": { "title": "France Property Valuation & Sold Prices (DVF)", "description": "Value any apartment or house in France from official DVF sale prices (notarial deeds): estimate, price per m², range, comparable sales, or a market report for any address or commune.", "version": "1.0", "x-build-id": "LSoJn9Iv3C7w5Wd6O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kris_fili~france-property-valuation-dvf/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kris_fili-france-property-valuation-dvf", "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/kris_fili~france-property-valuation-dvf/runs": { "post": { "operationId": "runs-sync-kris_fili-france-property-valuation-dvf", "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/kris_fili~france-property-valuation-dvf/run-sync": { "post": { "operationId": "run-sync-kris_fili-france-property-valuation-dvf", "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": "What do you need?", "enum": [ "valuation", "market_report" ], "type": "string", "description": "Valuation = value of one property (or a list). Market report = sale price statistics for an address or a whole commune.", "default": "valuation" }, "address": { "title": "Address, commune or postcode", "type": "string", "description": "A French address, e.g. '12 rue de la Roquette, Paris' or '25 cours de l'Intendance, Bordeaux'. For a market report a commune or postcode also works ('Lyon 6e', '33000')." }, "propertyType": { "title": "Property type", "enum": [ "apartment", "house" ], "type": "string", "description": "Apartment (appartement) or house (maison).", "default": "apartment" }, "areaM2": { "title": "Living area (m²)", "minimum": 9, "maximum": 1000, "type": "number", "description": "Living area in square metres (9–1000). Required for a valuation." }, "rooms": { "title": "Rooms (pièces principales)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Main rooms as in French listings – a 'T2' or '2 pièces' = 2. Optional, improves the match." }, "market": { "title": "Market", "enum": [ "resale", "new", "any" ], "type": "string", "description": "Resale (ancien) for most valuations; new = bought off-plan from a developer (VEFA); any = both.", "default": "resale" }, "monthsBack": { "title": "Period – months of sales", "minimum": 12, "maximum": 60, "type": "integer", "description": "How many months of DVF sales to use (12–60), counted back from the newest data. Older sales are adjusted with the local trend.", "default": 36 }, "properties": { "title": "Many properties at once (optional)", "type": "array", "description": "Value up to 100 properties in one run, e.g. [{\"address\": \"10 rue Sainte-Catherine, Bordeaux\", \"areaM2\": 60, \"rooms\": 3, \"propertyType\": \"apartment\"}]. When set, the single-property fields above are ignored. Each successful valuation is charged separately." }, "includeComparables": { "title": "Include the 10 most similar sales", "type": "boolean", "description": "List the comparable DVF sales used for the estimate (no extra charge).", "default": true }, "areaScope": { "title": "Market report: area", "enum": [ "auto", "radius", "commune" ], "type": "string", "description": "Auto = a radius around a street address, the whole commune for a commune or postcode.", "default": "auto" }, "radiusMeters": { "title": "Market report: radius (m)", "minimum": 100, "maximum": 10000, "type": "integer", "description": "Radius around the address for a market report (100–10,000 m).", "default": 500 }, "includeTransactions": { "title": "Market report: list the sales", "type": "boolean", "description": "Also write the individual sales (newest first) to the dataset – charged per sale.", "default": false }, "maxTransactions": { "title": "Market report: maximum sales listed", "minimum": 1, "maximum": 5000, "type": "integer", "description": "1–5,000.", "default": 100 } } }, "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 } } } } } } } } } }