{ "openapi": "3.0.1", "info": { "title": "Bien'ici Scraper", "description": "Scrape bienici.com - one of France's largest real-estate portals. Search flats, houses, lofts, commercial premises and more, for sale or rent, by location/price/surface/rooms, or fetch specific listings by ID or URL.", "version": "1.0", "x-build-id": "JrnCvWGVnYp7qbiLJ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~bienici-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-bienici-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/crawlerbros~bienici-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-bienici-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/crawlerbros~bienici-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-bienici-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": { "mode": { "title": "Mode", "enum": [ "search", "byIds" ], "type": "string", "description": "Search listings by filters, or fetch specific listing IDs/URLs.", "default": "search" }, "transactionType": { "title": "Transaction type (mode=search)", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy (for sale) or rent.", "default": "buy" }, "propertyTypes": { "title": "Property types (mode=search)", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "flat", "house", "loft", "castle", "townhouse", "building", "premises", "parking" ], "enumTitles": [ "Flat/apartment", "House", "Loft", "Castle/manor", "Townhouse", "Building", "Commercial premises", "Parking space" ] }, "default": [ "flat" ] }, "locationQuery": { "title": "Location (city, district, region)", "type": "string", "description": "Free-text French place name, e.g. `Paris`, `Lyon`, `Bordeaux`. Leave empty to search all of France.", "default": "Paris" }, "priceMin": { "title": "Min price (EUR)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Minimum price (total price for sale, monthly rent for rentals)." }, "priceMax": { "title": "Max price (EUR)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "Maximum price (total price for sale, monthly rent for rentals)." }, "areaMin": { "title": "Min surface area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Minimum livable surface area (Loi Carrez) in square meters." }, "areaMax": { "title": "Max surface area (m²)", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Maximum livable surface area (Loi Carrez) in square meters." }, "roomsMin": { "title": "Min number of rooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with fewer total rooms than this." }, "bedroomsMin": { "title": "Min number of bedrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with fewer bedrooms than this." }, "newPropertyOnly": { "title": "New properties only", "type": "boolean", "description": "Only include new-build (off-plan / newly built) properties.", "default": false }, "elevatorOnly": { "title": "Elevator only (mode=search)", "type": "boolean", "description": "Only include listings whose building has an elevator.", "default": false }, "furnishedOnly": { "title": "Furnished only (mode=search)", "type": "boolean", "description": "Only include furnished listings (mainly relevant for rentals).", "default": false }, "gardenOnly": { "title": "Garden only (mode=search)", "type": "boolean", "description": "Only include listings with a garden.", "default": false }, "poolOnly": { "title": "Swimming pool only (mode=search)", "type": "boolean", "description": "Only include listings with a swimming pool.", "default": false }, "parkingOnly": { "title": "Parking only (mode=search)", "type": "boolean", "description": "Only include listings with at least one parking space.", "default": false }, "balconyOnly": { "title": "Balcony only (mode=search)", "type": "boolean", "description": "Only include listings with a balcony.", "default": false }, "terraceOnly": { "title": "Terrace only (mode=search)", "type": "boolean", "description": "Only include listings with a terrace.", "default": false }, "cellarOnly": { "title": "Cellar only (mode=search)", "type": "boolean", "description": "Only include listings with a cellar/storage room.", "default": false }, "fireplaceOnly": { "title": "Fireplace only (mode=search)", "type": "boolean", "description": "Only include listings with a fireplace.", "default": false }, "separateToiletOnly": { "title": "Separate toilet only (mode=search)", "type": "boolean", "description": "Only include listings with a separate toilet (WC separated from the bathroom).", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "relevance", "priceAsc", "priceDesc", "dateDesc", "surfaceDesc" ], "type": "string", "description": "Order to return results in.", "default": "relevance" }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Only keep listings whose title/description/city/district contains this text (case-insensitive)." }, "adIds": { "title": "Listing IDs or URLs (mode=byIds)", "type": "array", "description": "Bien'ici ad IDs (e.g. `immo-facile-60587888`) or full listing URLs (e.g. `https://www.bienici.com/annonce/immo-facile-60587888`).", "default": [], "items": { "type": "string" } }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Maximum number of listings to scrape.", "default": 30 } } }, "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 } } } } } } } } } }