{ "openapi": "3.0.1", "info": { "title": "French-Property.com Scraper", "description": "Scrape French property listings from French-Property.com. Use filters (sale/rent, type, location, bedrooms, price) or paste a search URL — the URL wins when set. Returns price, size, bedrooms, location, agency, DPE, and photos.", "version": "0.1", "x-build-id": "LHakodFqSyTHwjAcK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dadhalfdev~french-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dadhalfdev-french-property-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/dadhalfdev~french-property-scraper/runs": { "post": { "operationId": "runs-sync-dadhalfdev-french-property-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/dadhalfdev~french-property-scraper/run-sync": { "post": { "operationId": "run-sync-dadhalfdev-french-property-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": { "input_url": { "title": "Input URL", "type": "string", "description": "Optional. Paste any French-Property.com search results URL to override the filters below. Leave empty to use structured filters instead (better for AI agents)." }, "listing_type": { "title": "Listing type", "enum": [ "vente", "location" ], "type": "string", "description": "Buy (for sale) or rent. Ignored when input_url is set.", "default": "vente" }, "property_type": { "title": "Property type", "enum": [ "", "house", "apartment", "business", "land" ], "type": "string", "description": "Property category. Ignored when input_url is set.", "default": "house" }, "popular_location": { "title": "Popular location", "enum": [ "", "atlantic-coast", "brittany-and-normandy", "burgundy-and-rhone", "central-france", "cote-d-azur", "dordogne-lot-and-quercy", "eastern-france", "french-alps", "french-pyrenees", "french-riviera", "gascony", "languedoc", "limousin-and-auvergne", "loire-valley", "massif-central", "mediterranean-coast", "normandy-and-mayenne", "north-east-france", "north-west-france", "northern-alps-ski", "northern-france", "poitou-charentes-and-vendee", "provence", "pyrenees-ski", "perigord", "quercy", "roussillon", "south-east-france", "south-of-france", "south-west-france", "southern-alps-ski", "tarn-and-cevennes", "ile-d-oleron", "ile-de-re" ], "type": "string", "description": "Popular area from the website (e.g. Dordogne, Lot & Quercy, French Alps). Ignored when input_url is set.", "default": "" }, "region": { "title": "Region", "enum": [ "", "alsace", "aquitaine", "auvergne", "auvergne-rhone-alpes", "brittany", "burgundy", "burgundy-franche-comte", "centre-val-de-loire", "champagne-ardenne", "corsica", "franche-comte", "grand-est", "hauts-de-france", "languedoc-roussillon", "limousin", "lorraine", "lower-normandy", "midi-pyrenees", "nord-pas-de-calais", "normandy", "nouvelle-aquitaine", "occitanie", "paris-ile-de-france", "pays-de-la-loire", "picardy", "poitou-charentes", "provence-alpes-cote-d-azur", "rhone-alpes", "upper-normandy" ], "type": "string", "description": "French region. Ignored when input_url is set.", "default": "" }, "department": { "title": "Department", "enum": [ "", "ain", "aisne", "allier", "alpes-de-haute-provence", "alpes-maritimes", "ardennes", "ardeche", "ariege", "aube", "aude", "aveyron", "bas-rhin", "bouches-du-rhone", "calvados", "cantal", "charente", "charente-maritime", "cher", "correze", "corse-du-sud", "creuse", "cote-d-or", "cotes-d-armor", "deux-sevres", "dordogne", "doubs", "drome", "essonne", "eure", "eure-et-loir", "finistere", "gard", "gers", "gironde", "haut-rhin", "haute-corse", "haute-garonne", "haute-loire", "haute-marne", "haute-savoie", "haute-saone", "haute-vienne", "hautes-alpes", "hautes-pyrenees", "hauts-de-seine", "herault", "ille-et-vilaine", "indre", "indre-et-loire", "isere", "jura", "landes", "loir-et-cher", "loire", "loire-atlantique", "loiret", "lot", "lot-et-garonne", "lozere", "maine-et-loire", "manche", "marne", "mayenne", "meurthe-et-moselle", "meuse", "morbihan", "moselle", "nievre", "nord", "oise", "orne", "paris", "pas-de-calais", "puy-de-dome", "pyrenees-atlantiques", "pyrenees-orientales", "rhone", "sarthe", "savoie", "saone-et-loire", "seine-et-marne", "seine-maritime", "seine-saint-denis", "somme", "tarn", "tarn-et-garonne", "territoire-de-belfort", "val-d-oise", "val-de-marne", "var", "vaucluse", "vendee", "vienne", "vosges", "yonne", "yvelines" ], "type": "string", "description": "French department. Ignored when input_url is set.", "default": "dordogne" }, "city": { "title": "City / town", "type": "string", "description": "Optional city or town (e.g. Bergerac, Nice, Paris). Combined with department when possible. Ignored when input_url is set." }, "postal_code": { "title": "Postal code", "type": "string", "description": "Optional postal code (e.g. 24100, 75011). Ignored when input_url is set." }, "minimum_bedrooms": { "title": "Minimum bedrooms", "enum": [ "", "0", "1", "2", "3", "4", "5", "6", "7", "8", "9" ], "type": "string", "description": "Minimum bedrooms. Ignored when input_url is set.", "default": "" }, "maximum_bedrooms": { "title": "Maximum bedrooms", "enum": [ "", "1", "2", "3", "4", "5", "6", "7", "8", "9", "10" ], "type": "string", "description": "Maximum bedrooms. Ignored when input_url is set.", "default": "" }, "price_min": { "title": "Minimum price (€)", "enum": [ "", "50000", "75000", "100000", "150000", "200000", "250000", "300000", "400000", "500000", "600000", "750000", "1000000", "1250000", "1500000", "1750000", "2000000", "3000000", "4000000", "5000000" ], "type": "string", "description": "Minimum price in euros. Ignored when input_url is set.", "default": "" }, "price_max": { "title": "Maximum price (€)", "enum": [ "", "50000", "75000", "100000", "150000", "200000", "250000", "300000", "400000", "500000", "600000", "750000", "1000000", "1250000", "1500000", "1750000", "2000000", "3000000", "4000000", "5000000" ], "type": "string", "description": "Maximum price in euros. Ignored when input_url is set.", "default": "" }, "minimum_land_size": { "title": "Minimum land size", "minimum": 0, "type": "integer", "description": "Optional minimum land size. Unit is set below. Ignored when input_url is set." }, "maximum_land_size": { "title": "Maximum land size", "minimum": 0, "type": "integer", "description": "Optional maximum land size. Unit is set below. Ignored when input_url is set." }, "land_size_unit": { "title": "Land size unit", "enum": [ "m²", "ac", "ha" ], "type": "string", "description": "Unit for land size filters. Ignored when input_url is set.", "default": "m²" }, "swimming_pool": { "title": "Swimming pool", "type": "boolean", "description": "Only listings with a swimming pool. Ignored when input_url is set.", "default": false }, "outbuildings": { "title": "Outbuildings", "type": "boolean", "description": "Only listings with outbuildings. Ignored when input_url is set.", "default": false }, "sort_by": { "title": "Sort by", "enum": [ "", "price_asc", "price_desc", "date_desc", "land_size_desc" ], "type": "string", "description": "Result order. Ignored when input_url is set.", "default": "" }, "max_properties": { "title": "Maximum number of listings", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many listings to return (1–1000).", "default": 50 } } }, "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 } } } } } } } } } }