{ "openapi": "3.0.1", "info": { "title": "Bien'Ici Scraper - France Real Estate", "description": "Find French property listings on bienici.com by location, sale or rent, price, surface area, rooms, property type, and keywords. Export records with links, photos, location, and contact details to JSON, CSV, Excel, or consume them through the Apify API.", "version": "0.0", "x-build-id": "mYFuOqpsRqKwoy180" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/igolaizola~bienici-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-igolaizola-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/igolaizola~bienici-scraper/runs": { "post": { "operationId": "runs-sync-igolaizola-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/igolaizola~bienici-scraper/run-sync": { "post": { "operationId": "run-sync-igolaizola-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": { "maxItems": { "title": "Maximum listings", "minimum": 1, "type": "integer", "description": "Maximum number of listings to save.", "default": 100 }, "location": { "title": "Search location", "type": "string", "description": "City, postcode, department, or other location name. Example: Paris. Ignored when latitude and longitude are provided.", "default": "Paris" }, "latitude": { "title": "Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Latitude of the center point for coordinate-based search. Use together with longitude. Coordinates take precedence over location." }, "longitude": { "title": "Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Longitude of the center point for coordinate-based search. Use together with latitude." }, "distanceKm": { "title": "Distance (km)", "minimum": 1, "type": "integer", "description": "Search radius around the latitude/longitude point, in kilometers.", "default": 20 }, "operation": { "title": "Listing purpose", "enum": [ "buy", "rent", "new", "build" ], "type": "string", "description": "Whether to find properties for purchase, rent, new construction, or construction projects.", "default": "buy" }, "sortBy": { "title": "Sort listings by", "enum": [ "relevance", "date", "surfaceAsc", "surfaceDesc", "priceAsc", "priceDesc", "pricePerSquareMeterAsc", "pricePerSquareMeterDesc" ], "type": "string", "description": "Order in which matching listings are returned.", "default": "relevance" }, "minPrice": { "title": "Minimum price (€)", "minimum": 0, "type": "integer", "description": "Only include listings priced at or above this amount." }, "maxPrice": { "title": "Maximum price (€)", "minimum": 0, "type": "integer", "description": "Only include listings priced at or below this amount." }, "minSurface": { "title": "Minimum surface area (m²)", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many square metres." }, "maxSurface": { "title": "Maximum surface area (m²)", "minimum": 0, "type": "integer", "description": "Only include listings with at most this many square metres." }, "minRooms": { "title": "Minimum rooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many rooms." }, "maxRooms": { "title": "Maximum rooms", "minimum": 0, "type": "integer", "description": "Only include listings with at most this many rooms." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at least this many bedrooms." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "type": "integer", "description": "Only include listings with at most this many bedrooms." }, "minGardenSurfaceArea": { "title": "Minimum garden area (m²)", "minimum": 0, "type": "integer", "description": "Only include listings with at least this much garden area." }, "maxGardenSurfaceArea": { "title": "Maximum garden area (m²)", "minimum": 0, "type": "integer", "description": "Only include listings with at most this much garden area." }, "propertyAge": { "title": "Property age", "type": "array", "description": "Choose whether to include new or existing properties.", "items": { "type": "string", "enum": [ "new", "old" ], "enumTitles": [ "New", "Existing" ] } }, "propertyTypes": { "title": "Property categories", "type": "array", "description": "Optional property categories to include in the search.", "items": { "type": "string", "enum": [ "house", "flat", "parking", "terrain", "loft", "shop", "building", "castle", "premises", "office", "townhouse", "others" ], "enumTitles": [ "House", "Apartment", "Parking or garage", "Land", "Loft or studio", "Business sale", "Building", "Castle", "Commercial premises", "Office", "Townhouse", "Other" ] } }, "energyClassification": { "title": "Energy class", "type": "array", "description": "Include only listings with one or more selected energy classes.", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ], "enumTitles": [ "A", "B", "C", "D", "E", "F", "G" ] } }, "keywords": { "title": "Keywords", "type": "array", "description": "Optional free-text words or phrases to match in listings. Example: balcony.", "items": { "type": "string" } }, "hasBalcony": { "title": "Balcony", "type": "boolean", "description": "Require a balcony.", "default": false }, "hasTerrace": { "title": "Terrace", "type": "boolean", "description": "Require a terrace.", "default": false }, "hasBalconyOrTerrace": { "title": "Balcony or terrace", "type": "boolean", "description": "Require a balcony or terrace.", "default": false }, "hasCellar": { "title": "Cellar", "type": "boolean", "description": "Require a cellar.", "default": false }, "hasParking": { "title": "Parking", "type": "boolean", "description": "Require parking.", "default": false }, "hasGarden": { "title": "Garden", "type": "boolean", "description": "Require a garden.", "default": false }, "hasDoorCode": { "title": "Door code", "type": "boolean", "description": "Require a door code.", "default": false }, "hasIntercom": { "title": "Intercom", "type": "boolean", "description": "Require an intercom.", "default": false }, "hasCaretaker": { "title": "Caretaker", "type": "boolean", "description": "Require a caretaker.", "default": false }, "hasElevator": { "title": "Elevator", "type": "boolean", "description": "Require an elevator.", "default": false }, "hasFireplace": { "title": "Fireplace", "type": "boolean", "description": "Require a fireplace.", "default": false }, "hasPool": { "title": "Pool", "type": "boolean", "description": "Require a pool.", "default": false }, "hasSeparateToilet": { "title": "Separate toilet", "type": "boolean", "description": "Require a separate toilet.", "default": false }, "furnished": { "title": "Furnished", "type": "boolean", "description": "Require furnished properties.", "default": false }, "unfurnished": { "title": "Unfurnished", "type": "boolean", "description": "Require unfurnished properties.", "default": false }, "noWorkToDo": { "title": "No work needed", "type": "boolean", "description": "Require properties with no work to do.", "default": false }, "workToDo": { "title": "Work needed", "type": "boolean", "description": "Require properties with work to do.", "default": false }, "hasToBeBuilt": { "title": "To be built", "type": "boolean", "description": "Require homes to be built.", "default": false }, "fiberAvailable": { "title": "Fibre available", "type": "boolean", "description": "Require deployed fibre availability.", "default": false }, "hasChargingStations": { "title": "Charging station", "type": "boolean", "description": "Require an electric-vehicle charging station.", "default": false }, "accessibleForDisabled": { "title": "Accessible property", "type": "boolean", "description": "Require accessibility for people with disabilities.", "default": false }, "flatSharing": { "title": "Flat sharing", "type": "boolean", "description": "Require listings allowing flat sharing.", "default": false }, "duplex": { "title": "Duplex", "type": "boolean", "description": "Require duplex properties.", "default": false }, "topFloor": { "title": "Top floor", "type": "boolean", "description": "Require top-floor properties.", "default": false }, "groundFloor": { "title": "Ground floor", "type": "boolean", "description": "Require ground-floor properties.", "default": false }, "excludeGroundFloor": { "title": "Exclude ground floor", "type": "boolean", "description": "Exclude ground-floor properties.", "default": false }, "singleStoreyHouse": { "title": "Single-storey house", "type": "boolean", "description": "Require single-storey houses.", "default": false }, "exclusiveSaleMandate": { "title": "Exclusive mandate", "type": "boolean", "description": "Require exclusive sale mandates.", "default": false }, "has3DModel": { "title": "3D model", "type": "boolean", "description": "Require listings with a 3D model.", "default": false }, "preview": { "title": "Preview listing", "type": "boolean", "description": "Require preview listings.", "default": false }, "hasPhoto": { "title": "Has photo", "type": "boolean", "description": "Require listings with photos.", "default": false }, "lifeAnnuityOnly": { "title": "Life annuity only", "type": "boolean", "description": "Include only life-annuity sales.", "default": false }, "excludeLifeAnnuity": { "title": "Exclude life annuity", "type": "boolean", "description": "Exclude life-annuity sales.", "default": false }, "bareOwnershipOnly": { "title": "Bare ownership only", "type": "boolean", "description": "Include only bare-ownership properties.", "default": false }, "excludeBareOwnership": { "title": "Exclude bare ownership", "type": "boolean", "description": "Exclude bare-ownership properties.", "default": false }, "studentResidence": { "title": "Student residence", "type": "boolean", "description": "Require student residences.", "default": false }, "seniorResidence": { "title": "Senior residence", "type": "boolean", "description": "Require senior residences.", "default": false }, "tourismResidence": { "title": "Tourism residence", "type": "boolean", "description": "Require tourism residences.", "default": false }, "managedResidence": { "title": "Managed residence", "type": "boolean", "description": "Require managed residences.", "default": false }, "excludeResidence": { "title": "Exclude residences", "type": "boolean", "description": "Exclude residence properties.", "default": false }, "eligibleDenormandie": { "title": "Denormandie eligible", "type": "boolean", "description": "Require Denormandie-law eligibility.", "default": false }, "sold": { "title": "Sold listings", "type": "boolean", "description": "Include sold properties.", "default": false }, "excludeAgencyNew": { "title": "Exclude agency new builds", "type": "boolean", "description": "Exclude new-build listings from agencies.", "default": 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 } } } } } } } } } }