{ "openapi": "3.0.1", "info": { "title": "Bien'ici Scraper — France Property Listings & Prices, No Phones", "description": "French property listings from Bien'ici, for sale or to rent: price, price per m², surface, rooms, bedrooms, floor, town, postcode, energy class (DPE/GES), agency and full description. No phones. Unofficial Bien'ici API.", "version": "0.1", "x-build-id": "PaNmtvbOaaW5PmTOH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/highbrow_fame~bienici-properties/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-highbrow_fame-bienici-properties", "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/highbrow_fame~bienici-properties/runs": { "post": { "operationId": "runs-sync-highbrow_fame-bienici-properties", "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/highbrow_fame~bienici-properties/run-sync": { "post": { "operationId": "run-sync-highbrow_fame-bienici-properties", "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": { "searchUrls": { "title": "Search links", "type": "array", "description": "Set up a search on bienici.com with all the filters you want (buy or rent, place, type, rooms, price…) and paste the address of the results page. One per line.", "items": { "type": "string" } }, "locations": { "title": "Places", "type": "array", "description": "Or search here without a link: towns, arrondissements, postcodes, departments or regions (Lyon, Paris 11e, 33000, Gironde, Bretagne). The filters below apply.", "items": { "type": "string" } }, "maxListingsPerSearch": { "title": "Max listings per search", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stops each search after this many listings.", "default": 200 }, "transaction": { "title": "Buy or rent", "enum": [ "buy", "rent" ], "type": "string", "description": "For the places above.", "default": "buy" }, "propertyTypes": { "title": "Property types", "uniqueItems": true, "type": "array", "description": "For the places above. New developments come with flats and houses.", "items": { "type": "string", "enum": [ "flat", "house", "loft", "castle", "townhouse", "terrain", "parking", "building", "office", "premises", "shop", "others" ], "enumTitles": [ "Flat", "House / villa", "Loft", "Castle / manor", "Mansion (hôtel particulier)", "Land", "Parking / garage", "Building", "Office", "Business premises", "Shop / commercial lease", "Other" ] }, "default": [ "flat", "house" ] }, "minPrice": { "title": "Min price (€)", "minimum": 0, "type": "integer", "description": "Optional. For rent: per month." }, "maxPrice": { "title": "Max price (€)", "minimum": 0, "type": "integer", "description": "Optional. For rent: per month." }, "minArea": { "title": "Min area (m²)", "minimum": 0, "type": "integer", "description": "Optional." }, "maxArea": { "title": "Max area (m²)", "minimum": 0, "type": "integer", "description": "Optional." }, "minRooms": { "title": "Min rooms (pièces)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Optional. French room count: living room and bedrooms, not kitchen or bathroom." }, "maxRooms": { "title": "Max rooms (pièces)", "minimum": 1, "maximum": 20, "type": "integer", "description": "Optional." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 1, "maximum": 20, "type": "integer", "description": "Optional." }, "newBuild": { "title": "New or old", "enum": [ "all", "new", "old" ], "type": "string", "description": "Optional.", "default": "all" }, "furnished": { "title": "Furnished (rent)", "enum": [ "all", "furnished", "unfurnished" ], "type": "string", "description": "Optional, for rentals.", "default": "all" }, "energyClasses": { "title": "Energy class (DPE)", "uniqueItems": true, "type": "array", "description": "Optional: any of these classes.", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ] } }, "sortBy": { "title": "Sort", "enum": [ "relevance", "newest", "cheapest", "priciest", "largest" ], "type": "string", "description": "For the places above. When Max listings per search is over 2,500 and a search has more, its listings come cheapest first (Bien'ici shows 2,500 per search).", "default": "relevance" }, "maxConcurrency": { "title": "Parallel searches", "minimum": 1, "maximum": 10, "type": "integer", "description": "How many searches to work on at the same time.", "default": 3 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used only to try again after a network error: the first try goes out directly.", "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 } } } } } } } } } }