{ "openapi": "3.0.1", "info": { "title": "France Notaires Real Estate API - Immobilier Notaires", "description": "[💵 $3.00 / 1K] Annonces officielles des Notaires de France (immobilier.notaires.fr) en schema anglais propre: prix, honoraires, DPE, surface, geo et contact du notaire. Filter by departement, price, area; monitoring mode returns only new listings.", "version": "0.1", "x-build-id": "eHJEUcc5bmULFTOAs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/webdata_labs~france-notaires-property-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-webdata_labs-france-notaires-property-api", "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/webdata_labs~france-notaires-property-api/runs": { "post": { "operationId": "runs-sync-webdata_labs-france-notaires-property-api", "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/webdata_labs~france-notaires-property-api/run-sync": { "post": { "operationId": "run-sync-webdata_labs-france-notaires-property-api", "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": { "departments": { "title": "French departments", "type": "array", "description": "Department codes to search, e.g. \"75\" (Paris), \"13\" (Bouches-du-Rhone), \"33\" (Gironde), \"06\" (Alpes-Maritimes), \"2A\"/\"2B\" (Corsica), \"971\"-\"976\" (overseas). One request per department. Leave empty or use \"all\" to search the whole of France (cap with Max results).", "items": { "type": "string" } }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Optional filter (applied client-side). Codes: MAI (house), APP (apartment), IMM (building), TER (land), LAC/LOC (commercial premises), GAR/PAR (garage/parking), FON (business), BUR (office), CHA (chateau). Empty = all types.", "default": [], "items": { "type": "string" } }, "minPriceEur": { "title": "Min price (EUR)", "minimum": 0, "type": "integer", "description": "Only listings at or above this price." }, "maxPriceEur": { "title": "Max price (EUR)", "minimum": 0, "type": "integer", "description": "Only listings at or below this price." }, "minAreaSqm": { "title": "Min living area (m2)", "minimum": 0, "type": "integer", "description": "Only listings at or above this habitable surface." }, "minRooms": { "title": "Min rooms", "minimum": 0, "type": "integer", "description": "Only listings with at least this many rooms (pieces)." }, "onlyInteractiveAuctions": { "title": "Only interactive auctions (VNI)", "type": "boolean", "description": "Keep only ventes notariales interactives (online notarial auctions). Note: these are a small share of listings.", "default": false }, "onlyJudicial": { "title": "Only judicial-origin sales", "type": "boolean", "description": "Keep only sales flagged as judicial in origin. Rare in the public feed.", "default": false }, "includeDetails": { "title": "Include full details", "type": "boolean", "description": "Fetch each listing's detail page for living/land area, energy class (DPE), features, full description, coordinates and the notary's name, phone and email. One extra request per listing - slower on large searches.", "default": false }, "onlyNewListings": { "title": "Only new listings (monitoring mode)", "type": "boolean", "description": "Push only listings not seen in previous runs of this Actor on your account (per department). The first run returns everything and initializes memory; every following run returns just the delta - ideal for scheduled monitoring, and you are charged only for new rows.", "default": false }, "maxResults": { "title": "Max results per department", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Cap the number of listings collected per department (or for all France).", "default": 1000 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Optional. The notaires API is a public official source; enable Apify Proxy only if you hit rate limits.", "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 } } }, "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 } } } } } } } } } }