{ "openapi": "3.0.1", "info": { "title": "Bien'ici Scraper: France Real Estate Ads & DPE", "description": "Get Bien'ici property ads from any French town, department, region or radius up to 200 km, no login, each search read past the 2,500 ad cap. Rows hold price, price per m2, surface, DPE and GES, district, photos, agency contact. Watch new ads and price changes; pay per ad; JSON, CSV, API.", "version": "0.1", "x-build-id": "Srel85yUqcfczOJvs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation_craft~bienici-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation_craft-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/automation_craft~bienici-scraper/runs": { "post": { "operationId": "runs-sync-automation_craft-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/automation_craft~bienici-scraper/run-sync": { "post": { "operationId": "run-sync-automation_craft-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": { "places": { "title": "Places", "type": "array", "description": "Towns, Paris, Lyon and Marseille arrondissements, departments, postal codes, department numbers, regions or France, as on Bien'ici: Paris, Paris 18e, Lyon 3e, Bordeaux, Gironde, 33160, 75018, 33 (a department number), 2A, Bretagne, Occitanie, France. A name must match exactly one Bien'ici place: when several share it (Saint-Denis), add the department number or the postal code, Saint-Denis (93) or Saint-Denis 93200. A name that matches none or several gives a free row with the candidates. A region name searches all its departments; a town that shares a region's name needs its department (Bretagne (36)).", "items": { "type": "string" } }, "radiusKm": { "title": "Radius around each place (km)", "minimum": 1, "maximum": 200, "type": "integer", "description": "Search around the centre of each place instead of inside it: every ad whose position (the exact one, or the centre of the circle Bien'ici blurs it into) lies within this many kilometres of the centre of the place's map box, with its distance in distanceKm. 1 to 200. Not for a region or France." }, "searchUrls": { "title": "Bien'ici search links", "type": "array", "description": "Search links copied from bienici.com (https://www.bienici.com/recherche/achat/paris-75000/appartement/3-pieces-et-plus?prix-max=600000). The link is read into Bien'ici's own filters in this Actor (never loaded as a page) and searched to its end, with its sort unless you set one below. A link with a parameter this Actor does not read, a drawn area or a travel time zone is refused with a free row. Up to 100.", "items": { "type": "string" } }, "adUrls": { "title": "Ad links or ids", "type": "array", "description": "Ads to read directly: bienici.com ad links (https://www.bienici.com/annonce/...) or Bien'ici ad ids (ag942551-554736311). Each is read from Bien'ici's own record of the ad and delivered as given, also when it is no longer on the market (onTheMarket false). An id Bien'ici does not have is a free row. Up to 5,000.", "items": { "type": "string" } }, "transaction": { "title": "Buy or rent", "enum": [ "buy", "rent" ], "type": "string", "description": "Ads for sale or for rent. Default buy." }, "propertyTypes": { "title": "Property types", "type": "array", "description": "Default apartment and house. New build programmes are delivered with apartments and houses (propertyType programme, with their lots).", "items": { "type": "string", "enum": [ "apartment", "house", "parking", "land", "loft", "shop", "commercial_premises", "office", "castle", "building", "townhouse", "other" ], "enumTitles": [ "Apartment", "House", "Parking or garage", "Land (terrain)", "Loft", "Shop (commerce)", "Commercial premises (local)", "Office", "Castle (chateau)", "Building", "Mansion (hotel particulier)", "Other" ] } }, "newBuild": { "title": "New builds", "enum": [ "include", "only", "exclude" ], "type": "string", "description": "Default include." }, "marketStatus": { "title": "Market status", "enum": [ "on_market", "off_market" ], "type": "string", "description": "Bien'ici keeps ads that left the market and lists them on their own (each with its last price and the date it changed). Default on the market." }, "minPrice": { "title": "Minimum price (EUR)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "The lowest price, in euros (the monthly rent for rentals)." }, "maxPrice": { "title": "Maximum price (EUR)", "minimum": 0, "maximum": 1000000000, "type": "integer", "description": "The highest price, in euros (the monthly rent for rentals)." }, "minSurface": { "title": "Minimum surface (m2)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "The smallest living surface in square metres." }, "maxSurface": { "title": "Maximum surface (m2)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "The largest living surface in square metres." }, "minRooms": { "title": "Minimum rooms (pieces)", "minimum": 0, "maximum": 100, "type": "integer", "description": "The fewest rooms." }, "maxRooms": { "title": "Maximum rooms (pieces)", "minimum": 0, "maximum": 100, "type": "integer", "description": "The most rooms." }, "minBedrooms": { "title": "Minimum bedrooms", "minimum": 0, "maximum": 100, "type": "integer", "description": "The fewest bedrooms." }, "maxBedrooms": { "title": "Maximum bedrooms", "minimum": 0, "maximum": 100, "type": "integer", "description": "The most bedrooms." }, "minLandSurface": { "title": "Minimum land surface (m2)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "The smallest garden or land surface in square metres (Bien'ici reads the garden surface, else the land surface)." }, "maxLandSurface": { "title": "Maximum land surface (m2)", "minimum": 0, "maximum": 100000000, "type": "integer", "description": "The largest garden or land surface in square metres." }, "energyClasses": { "title": "Energy classes (DPE)", "type": "array", "description": "Only ads with one of these energy performance classes (DPE). An ad without a DPE class is left out, free.", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ], "enumTitles": [ "A", "B", "C", "D", "E", "F", "G" ] } }, "features": { "title": "Features", "type": "array", "description": "Only ads with every one of these features, as Bien'ici applies them (its advanced search). A row whose own fields contradict a feature is left out, free; a row that does not show the field is kept as Bien'ici returned it.", "items": { "type": "string", "enum": [ "elevator", "balcony", "terrace", "balcony_or_terrace", "cellar", "parking", "garden", "swimming_pool", "fireplace", "caretaker", "door_code", "intercom", "duplex", "separate_toilet", "top_floor", "ground_floor", "not_ground_floor", "single_storey", "disabled_access", "optical_fiber", "ev_charging", "building_plot", "works_needed", "no_works_needed", "furnished", "unfurnished", "flatsharing", "exclusive_mandate", "with_3d_tour", "with_photos", "with_address", "student_residence", "senior_residence", "tourism_residence", "not_in_residence", "denormandie_eligible", "house_to_build", "no_house_to_build" ], "enumTitles": [ "Elevator", "Balcony", "Terrace", "Balcony or terrace", "Cellar", "Parking or garage", "Garden", "Swimming pool", "Fireplace", "Caretaker (gardien)", "Door code (digicode)", "Intercom", "Duplex", "Separate toilet", "Top floor", "Ground floor", "Not on the ground floor", "Single storey house (plain-pied)", "Reduced mobility access (PMR)", "Optical fibre available", "Electric vehicle charging", "Building plot (constructible)", "Works needed", "No works needed", "Furnished (rentals)", "Unfurnished (rentals)", "Flatsharing allowed (rentals)", "Exclusive mandate", "With a 3D tour", "With photos", "With the address published", "Student residence", "Senior residence", "Tourism residence", "Not in a managed residence", "Eligible for the Denormandie tax law", "House to build (land and house)", "No house to build" ] } }, "lifeAnnuity": { "title": "Life annuity sales (viager)", "enum": [ "include", "exclude", "only" ], "type": "string", "description": "Default include." }, "bareOwnership": { "title": "Bare ownership sales (nue-propriete)", "enum": [ "include", "exclude", "only" ], "type": "string", "description": "Default include." }, "minPricePerSqm": { "title": "Minimum price per m2 (EUR)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "The lowest price per square metre (Bien'ici's own figure, else the price divided by the surface). An ad without one is left out, free." }, "maxPricePerSqm": { "title": "Maximum price per m2 (EUR)", "minimum": 0, "maximum": 1000000, "type": "integer", "description": "The highest price per square metre. An ad without one is left out, free." }, "ghgClasses": { "title": "Greenhouse gas classes (GES)", "type": "array", "description": "Only ads with one of these greenhouse gas classes (GES). An ad without one is left out, free.", "items": { "type": "string", "enum": [ "A", "B", "C", "D", "E", "F", "G" ], "enumTitles": [ "A", "B", "C", "D", "E", "F", "G" ] } }, "minFloor": { "title": "Minimum floor", "minimum": -5, "maximum": 200, "type": "integer", "description": "The lowest floor (0 is the ground floor). An ad without a floor is left out, free." }, "maxFloor": { "title": "Maximum floor", "minimum": -5, "maximum": 200, "type": "integer", "description": "The highest floor. An ad without a floor is left out, free." }, "minYearBuilt": { "title": "Built in or after", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "The earliest year of construction. An ad without one is left out, free." }, "maxYearBuilt": { "title": "Built in or before", "minimum": 1000, "maximum": 2100, "type": "integer", "description": "The latest year of construction. An ad without one is left out, free." }, "minBathrooms": { "title": "Minimum bathrooms and shower rooms", "minimum": 1, "maximum": 20, "type": "integer", "description": "The fewest bathrooms and shower rooms together. An ad that shows neither is left out, free." }, "advertiserTypes": { "title": "Advertiser types", "type": "array", "description": "Only ads of these kinds of advertiser. Every advertiser on Bien'ici is a professional.", "items": { "type": "string", "enum": [ "agency", "network_agent", "developer", "builder", "broker", "network" ], "enumTitles": [ "Agency", "Independent network agent (mandataire)", "Developer (promoteur)", "House builder (constructeur)", "Broker (commercialisateur)", "Agency network" ] } }, "priceDropOnly": { "title": "Price drops only", "type": "boolean", "description": "Only ads whose price Bien'ici marks as lowered (priceHasDecreased)." }, "withVirtualTourOnly": { "title": "With a virtual tour only", "type": "boolean", "description": "Only ads with a video or 3D tour." }, "keywords": { "title": "Keywords", "type": "array", "description": "Words every delivered ad's title or description must contain, as whole words, any case, accents ignored (piscine, vue mer, sans vis-a-vis). Up to 10, each up to 60 characters.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Keywords to leave out", "type": "array", "description": "Ads whose title or description contains any of these words (the same matching as keywords) are left out, free. Up to 10.", "items": { "type": "string" } }, "postedWithinDays": { "title": "Published within (days)", "minimum": 1, "maximum": 365, "type": "integer", "description": "Only ads published in the last N days. The search is read newest first and stops at the first ad older than that. Bien'ici hides the publication date of some ads (publicationDateHidden): those never pass this filter (a monitor catches every new ad)." }, "postedWithinHours": { "title": "Published within (hours)", "minimum": 1, "maximum": 8760, "type": "integer", "description": "Only ads published in the last N hours (instead of days), read the same way. Not with postedWithinDays." }, "minDaysOnMarket": { "title": "On the market for at least (days)", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only ads published at least N days ago (ads whose date Bien'ici hides are left out). Each row carries daysOnMarket." }, "excludeAdIds": { "title": "Ads to leave out", "type": "array", "description": "Bien'ici ad ids or links you already have; they are skipped, free. Up to 10,000.", "items": { "type": "string" } }, "sort": { "title": "Sort", "enum": [ "newest", "oldest", "recently_updated", "relevance", "price_low", "price_high", "price_per_sqm_low", "price_per_sqm_high", "surface_low", "surface_high", "rooms_low", "rooms_high" ], "type": "string", "description": "The order of a search, Bien'ici's own. Newest and oldest first sort on the publication date; the ads whose date Bien'ici hides come last (newest first) or first (oldest first). Past the first 2,500 ads of one order, the rest of a search is read in price bands, each in this order. A pasted link keeps its own sort unless you set one here. Default newest first." }, "maxItems": { "title": "Maximum rows", "minimum": 1, "maximum": 200000, "type": "integer", "description": "The most paid rows the run delivers (ad rows, and a monitor's price change and removed rows, together). Default 100." }, "maxItemsPerSearch": { "title": "Maximum rows per search", "minimum": 1, "maximum": 200000, "type": "integer", "description": "The most rows one place or link delivers." }, "maxPagesPerSearch": { "title": "Maximum pages per search", "minimum": 1, "maximum": 10000, "type": "integer", "description": "The most requests one search makes (results pages of up to 500 ads, and one call per price band)." }, "includeDetails": { "title": "Agency contact details", "type": "boolean", "description": "Read each delivered ad's own record and add the advertiser's contact: agency or network name, phone, address, RCS number, agency id, website, professional body (FNAIM, SNPI) and Bien'ici's generated title. One extra call per row, included in the Listing price." }, "includeRawData": { "title": "Raw Bien'ici data", "type": "boolean", "description": "Add Bien'ici's own ad object as the search answered it (every field it serves, in Bien'ici's names, its texts as served) under raw." }, "includePersonalData": { "title": "Include personal data", "type": "boolean", "description": "Off by default. Some advertisers are individuals: network agents (mandataires) publish under their own name, and an agency can name one of its agents as the contact. On: the agent's name (contact.contactName, and the advertiser name of a network agent), an independent agent's own phone, street and RCS number, an independent agent's account ids (advertiserId, contact.agencyId, the raw account ids) and any id holding or spelling an e-mail address are delivered as Bien'ici shows them logged out. Off: those fields are empty. Titles, descriptions and every other text are delivered as Bien'ici serves them either way: a text can name the agent or give a phone number. You are responsible for using personal data lawfully (GDPR included)." }, "monitorName": { "title": "Monitor name", "type": "string", "description": "A short name of your choice (letters, digits, spaces and . _ , - : # ( ), up to 60 characters). One name belongs to one set of settings." }, "monitorBaseline": { "title": "First run delivers every current ad", "type": "boolean", "description": "With a monitor: its first run delivers every ad of its searches (the stock it starts from) instead of the ads modified in the last 24 hours. Every row is billed as Listing." }, "trackChanges": { "title": "Track price changes and removals", "type": "boolean", "description": "With a monitor: an ad it delivered before whose price changed is delivered again with the previous price, the change in euros and percent and the price history; an ad Bien'ici lists as no longer on the market is a removed row; an ad that comes back after a removal is delivered as reappeared. Each such row is billed as Listing." }, "requestDelayMs": { "title": "Pause between requests (ms)", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Wait at least this long between two requests to Bien'ici (this Actor never sends more than 4 a second). 0 to 10,000." }, "maxRetries": { "title": "Retries per request", "minimum": 0, "maximum": 6, "type": "integer", "description": "How many times a failed request is asked again (default 3). 0 to 6." }, "failIfIncomplete": { "title": "Fail the run when something was not read", "type": "boolean", "description": "Mark the run failed when a search or link could not be read to its end for a reason other than your own limits. The rows delivered stay." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify's datacenter proxy by default, included in the price: Bien'ici answers it on every exit. The RESIDENTIAL group (France unless you choose a country) is accepted too, and so are your own proxy links (http://user:password@host:port, the password 12 characters or more with letters and digits, no space)." } } }, "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 } } } } } } } } } }