{ "openapi": "3.0.1", "info": { "title": "Bien'ici Property Scraper (France)", "description": "Scrapes flats and houses for sale or rent from Bien'ici, France's #3 real estate portal. Search any city, district or postal code; returns price, surface area, rooms, bedrooms, floor, energy class, full description, photos and seller details.", "version": "0.1", "x-build-id": "hydgUH4TIgLqsHXUv" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~bienici-properties-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-bienici-properties-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/scrapyx~bienici-properties-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-bienici-properties-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/scrapyx~bienici-properties-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-bienici-properties-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": { "transactionType": { "title": "Buy or rent", "enum": [ "buy", "rent" ], "type": "string", "description": "Which side of the market to search. An unrecognised value is NOT rejected upstream -- Bien'ici silently combines both buy and rent results -- so this actor validates strictly and refuses invalid input rather than risk a mislabelled dataset.", "default": "buy" }, "propertyType": { "title": "Property type", "enum": [ "flat", "house" ], "type": "string", "description": "Only these two are verified real Bien'ici filter values this session.", "default": "flat" }, "locations": { "title": "Locations", "type": "array", "description": "Free-text place names -- resolved through Bien'ici's own geocoder, the same one their search box uses (city, district, postal code or arrondissement all work: 'Paris', 'Paris 15e', '75015', 'Lyon'). One search per entry, each with its own SEARCH_SUMMARY row. A name that resolves to nothing returns a clean not_found row -- verified live, never a silent fallback to a nationwide search.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Minimum price (EUR)", "minimum": 0, "type": "integer", "description": "Leave empty or 0 for no minimum. Verified to actually shift the match count (not a silent no-op).", "default": 0 }, "maxPrice": { "title": "Maximum price (EUR)", "minimum": 0, "type": "integer", "description": "Leave empty or 0 for no maximum. Verified to actually shift the match count.", "default": 0 }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "type": "integer", "description": "Leave empty or 0 for any. Verified to actually shift the match count.", "default": 0 }, "maxItems": { "title": "Max properties per location", "minimum": 0, "type": "integer", "description": "Stop paginating a location after this many properties. Set to 0 for unlimited -- still bounded by Bien'ici's own result-window cap, roughly 2,400-2,500 rows per query regardless of matches ('Too many ads requested' past that). Narrow by price/bedrooms or search a smaller area to reach further into a very broad result set.", "default": 240 }, "pageSize": { "title": "Results per request", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many listings to request per page (Bien'ici's own default is 24). Higher values mean fewer requests to cover the same ground.", "default": 24 }, "maxConcurrency": { "title": "Max concurrent requests", "minimum": 1, "maximum": 16, "type": "integer", "description": "Upper bound on requests in flight at once, across independent locations.", "default": 4 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy on the shared datacenter pool. This is the default because it is included in your plan at no extra cost and this target works through it. If you start seeing blocks, challenges or empty results, switch the group here to Residential -- it uses real consumer IPs and gets through more, but Apify bills residential traffic per gigabyte, so leave it off unless you need it.", "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 } } } } } } } } } }