{ "openapi": "3.0.1", "info": { "title": "Bien'ici Property Scraper · Buy & rent France · $1/1K", "description": "Search Bien'ici property listings by French city or postal code for real estate research, rental monitoring and price analysis. Buy or rent, with price, surface, rooms, energy rating and photos. $1/1K listings.", "version": "0.1", "x-build-id": "rCksERgyPpylM21SP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mlg14~bienici-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mlg14-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/mlg14~bienici-scraper/runs": { "post": { "operationId": "runs-sync-mlg14-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/mlg14~bienici-scraper/run-sync": { "post": { "operationId": "run-sync-mlg14-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": { "startUrls": { "title": "Search URLs", "type": "array", "description": "Bien'ici search result URLs; transaction, location and property type are read from the route. Example: [{\"url\": \"https://www.bienici.com/recherche/achat/paris-75000\"}]. Leave empty to use location.", "items": { "type": "string" }, "default": [] }, "transactionType": { "title": "Transaction Type", "enum": [ "buy", "rent" ], "type": "string", "description": "Search for sale or for rent. Allowed values: buy, rent. Example: rent. Used when startUrls is empty or does not specify one. Use rent for rentals.", "default": "buy" }, "location": { "title": "Location", "type": "string", "description": "French city, district or postal code to search. Example: Paris, Lyon or 75011. Use when startUrls is empty.", "default": "Paris" }, "propertyTypes": { "title": "Property Types", "uniqueItems": true, "type": "array", "description": "Limit results to these property types. Allowed values: flat, house, loft, townhouse, castle, terrain, parking, building, shop, office, premises. Example: [\"flat\", \"house\"]. Leave empty for all types.", "items": { "type": "string", "enum": [ "flat", "house", "loft", "townhouse", "castle", "terrain", "parking", "building", "shop", "office", "premises" ], "enumTitles": [ "Apartment", "House", "Loft", "Townhouse", "Castle or mansion", "Land", "Parking or garage", "Building", "Shop", "Office", "Commercial premises" ] }, "default": [] }, "priceMin": { "title": "Minimum Price (€)", "minimum": 0, "type": "integer", "description": "Minimum price in euros; for rentals the monthly rent. Example: 200000. Leave empty for no minimum." }, "priceMax": { "title": "Maximum Price (€)", "minimum": 0, "type": "integer", "description": "Maximum price in euros; for rentals the monthly rent. Example: 600000. Leave empty for no maximum." }, "roomsMin": { "title": "Minimum Rooms", "minimum": 0, "type": "integer", "description": "Minimum number of rooms (pieces), an integer. Example: 3. Leave empty for no minimum." }, "bedroomsMin": { "title": "Minimum Bedrooms", "minimum": 0, "type": "integer", "description": "Minimum number of bedrooms (chambres), an integer. Example: 2. Leave empty for no minimum." }, "surfaceMin": { "title": "Minimum Surface (m²)", "minimum": 0, "type": "integer", "description": "Minimum living surface in square meters, an integer. Example: 50. Leave empty for no minimum." }, "surfaceMax": { "title": "Maximum Surface (m²)", "minimum": 0, "type": "integer", "description": "Maximum living surface in square meters, an integer. Example: 120. Leave empty for no maximum." }, "sortBy": { "title": "Sort By", "enum": [ "relevance", "priceAsc", "priceDesc", "newest", "surfaceDesc" ], "type": "string", "description": "Order of results. Allowed values: relevance, priceAsc, priceDesc, newest, surfaceDesc. Example: newest. Use newest to monitor fresh listings.", "default": "relevance" }, "includeDetails": { "title": "Include Agency Details", "type": "boolean", "description": "Request each listing's public record for extra agency contact and property fields, true or false. Example: true. Leave false for fast runs; true adds one request per listing.", "default": false }, "maxResults": { "title": "Maximum Results", "minimum": 0, "type": "integer", "description": "Maximum listings across the run, an integer. Example: 50. Set 0 for up to the site limit of 2,500 per URL.", "default": 100 }, "maxResultsPerUrl": { "title": "Maximum Results Per URL", "minimum": 0, "type": "integer", "description": "Maximum listings from each search URL, an integer. Example: 100. Set 0 to use the site limit of 2,500 per URL.", "default": 0 }, "ignoreUrlFailures": { "title": "Continue If a URL Fails", "type": "boolean", "description": "Skip a failed search URL and continue with the rest, true or false. Example: false to stop on the first failure. Leave true otherwise; a run with no listings still fails.", "default": true }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy configuration for requests to public Bien'ici search endpoints. Leave the default.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }