{ "openapi": "3.0.1", "info": { "title": "Bien'ici Scraper — France Real Estate Data", "description": "Scrape France real estate listings from Bien'ici (bienici.com) via its public JSON API — no browser. Filter by location, buy/rent, property type, price (€), area, rooms, bedrooms. Returns price, €/m², DPE energy class, GPS, city/district, agency and images per listing.", "version": "1.0", "x-build-id": "a0z0ALchZdmgpMgWn" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/logiover~bien-ici-fr-scraper-france-real-estate/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-logiover-bien-ici-fr-scraper-france-real-estate", "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/logiover~bien-ici-fr-scraper-france-real-estate/runs": { "post": { "operationId": "runs-sync-logiover-bien-ici-fr-scraper-france-real-estate", "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/logiover~bien-ici-fr-scraper-france-real-estate/run-sync": { "post": { "operationId": "run-sync-logiover-bien-ici-fr-scraper-france-real-estate", "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": { "locations": { "title": "Locations (city / district names)", "type": "array", "description": "French place names to search — e.g. `Paris`, `Lyon`, `Marseille`, `Bordeaux 33000`, `Paris 15e`, `Nice`, `Toulouse`. Each entry is resolved to a Bien'ici zone via the site's own geo-suggest and becomes its own scraping task. Cities, arrondissements, départements and postal codes all work. Leave empty (and leave Zone IDs empty) to search all of France.", "default": [ "Paris" ], "items": { "type": "string" } }, "zoneIds": { "title": "Zone IDs (advanced)", "type": "array", "description": "Optional Bien'ici internal zone IDs (e.g. `-7444` for Paris). Advanced escape hatch when a place name is ambiguous — grab them from a bienici.com search URL's `filters` parameter. All IDs listed here are combined into a single search. Usually you can ignore this and just use Locations.", "default": [], "items": { "type": "string" } }, "transaction": { "title": "Transaction Type", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy (achat / vente) or rent (location).", "default": "buy" }, "propertyTypes": { "title": "Property Types", "type": "array", "description": "One or more Bien'ici property categories. Combine freely (e.g. flat + house).", "items": { "type": "string", "enum": [ "flat", "house", "loft", "townhouse", "castle", "building", "terrain", "parking", "shop", "office", "premises", "others" ], "enumTitles": [ "Apartment (appartement)", "House (maison)", "Loft", "Townhouse (hôtel particulier)", "Castle (château)", "Building (immeuble)", "Land / plot (terrain)", "Parking / garage", "Shop (local commercial)", "Office (bureau)", "Premises (local / fonds)", "Other" ] }, "default": [ "flat", "house" ] }, "priceMin": { "title": "Min Price (€)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Minimum price in euros. For rent this is monthly rent. 0 = no minimum.", "default": 0 }, "priceMax": { "title": "Max Price (€)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "Maximum price in euros. For rent this is monthly rent. 0 = no maximum.", "default": 0 }, "areaMin": { "title": "Min Area (m²)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Minimum living area in square meters. 0 = no minimum.", "default": 0 }, "areaMax": { "title": "Max Area (m²)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Maximum living area in square meters. 0 = no maximum.", "default": 0 }, "roomsMin": { "title": "Min Rooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Minimum total rooms (pièces). In France a studio = 1 room, a 2-room flat = T2, etc. 0 = no minimum.", "default": 0 }, "roomsMax": { "title": "Max Rooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Maximum total rooms (pièces). 0 = no maximum.", "default": 0 }, "bedroomsMin": { "title": "Min Bedrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Minimum number of bedrooms (chambres). 0 = no minimum.", "default": 0 }, "newBuildOnly": { "title": "New Build Only (neuf)", "type": "boolean", "description": "Only return brand-new / off-plan developer properties (immobilier neuf).", "default": false }, "sort": { "title": "Sort Order", "enum": [ "relevance", "newest", "price_asc", "price_desc", "area_asc", "area_desc", "price_per_m_asc", "price_per_m_desc" ], "type": "string", "description": "Result ordering.", "default": "relevance" }, "pageSize": { "title": "Listings per Page", "minimum": 1, "maximum": 100, "type": "integer", "description": "Page size for the API (1–100). Larger pages mean fewer requests.", "default": 24 }, "maxListings": { "title": "Max Listings", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "Total cap across all location tasks (0 = unlimited).", "default": 200 }, "maxPagesPerTask": { "title": "Max Pages per Task", "minimum": 1, "maximum": 200, "type": "integer", "description": "Pagination depth per location. Combined with page size this caps listings per location. Narrow with price/area filters to reach deeper inventory.", "default": 5 }, "requestDelay": { "title": "Request Delay (ms)", "minimum": 0, "maximum": 30000, "type": "integer", "description": "Delay between sequential requests. Keep ≥ 500 ms to stay polite.", "default": 700 }, "maxRetries": { "title": "Max Retries", "minimum": 0, "maximum": 10, "type": "integer", "description": "Retries per request on HTTP / proxy errors (rotates proxy IP each attempt).", "default": 3 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Apify Proxy is required. Bien'ici's API is served from France — RESIDENTIAL with country=FR is strongly recommended for reliable access.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "FR" } } } }, "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 } } } } } } } } } }