{ "openapi": "3.0.1", "info": { "title": "Bien'ici France Real Estate Scraper — Annonces, Prix, DPE", "description": "Extrait les annonces immobilières de bienici.com (achat ou location) par ville, code postal ou arrondissement : prix, prix au m², surface, pièces, DPE, coordonnées, photos, agence. Filtres prix, surface, pièces, neuf/ancien.", "version": "0.1", "x-build-id": "QxbJfreje741osrHw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/cyrilfaia~bienici-fr-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-cyrilfaia-bienici-fr-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/cyrilfaia~bienici-fr-scraper/runs": { "post": { "operationId": "runs-sync-cyrilfaia-bienici-fr-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/cyrilfaia~bienici-fr-scraper/run-sync": { "post": { "operationId": "run-sync-cyrilfaia-bienici-fr-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": { "locations": { "title": "Localités", "type": "array", "description": "Villes, codes postaux, arrondissements ou départements, un par ligne (ex. « Marseille », « 13007 », « Lyon 3e », « Bouches-du-Rhône »). Résolus via la recherche Bien'ici.", "items": { "type": "string" } }, "zoneIds": { "title": "Identifiants de zone Bien'ici (avancé)", "type": "array", "description": "Identifiants internes de zone (ex. « -76469 ») si vous les connaissez déjà.", "items": { "type": "string" } }, "transaction": { "title": "Transaction", "enum": [ "buy", "rent" ], "type": "string", "description": "Achat ou location.", "default": "buy" }, "propertyTypes": { "title": "Types de bien", "type": "array", "description": "flat, house, programme (neuf), parking, terrain, loft, shop, building, castle, premises, office, townhouse.", "default": [ "flat", "house" ], "items": { "type": "string" } }, "minPrice": { "title": "Prix minimum (€)", "minimum": 0, "type": "integer", "description": "Prix ou loyer mensuel minimum." }, "maxPrice": { "title": "Prix maximum (€)", "minimum": 0, "type": "integer", "description": "Prix ou loyer mensuel maximum." }, "minArea": { "title": "Surface minimum (m²)", "minimum": 0, "type": "integer", "description": "Surface habitable minimum." }, "maxArea": { "title": "Surface maximum (m²)", "minimum": 0, "type": "integer", "description": "Surface habitable maximum." }, "minRooms": { "title": "Pièces minimum", "minimum": 1, "type": "integer", "description": "Nombre de pièces minimum." }, "minBedrooms": { "title": "Chambres minimum", "minimum": 1, "type": "integer", "description": "Nombre de chambres minimum." }, "newProperty": { "title": "Neuf / ancien", "enum": [ "all", "only", "exclude" ], "type": "string", "description": "Inclure tout, seulement le neuf, ou exclure le neuf.", "default": "all" }, "sort": { "title": "Tri", "enum": [ "relevance", "newest", "priceAsc", "priceDesc", "surfaceDesc", "pricePerM2Asc" ], "type": "string", "description": "Ordre des résultats.", "default": "newest" }, "maxItems": { "title": "Nombre maximal d'annonces", "minimum": 0, "type": "integer", "description": "0 = illimité.", "default": 200 }, "maxPagesPerLocation": { "title": "Pages maximales par localité", "minimum": 1, "maximum": 100, "type": "integer", "description": "100 annonces par page.", "default": 10 }, "fetchDetails": { "title": "Enrichir avec la fiche complète", "type": "boolean", "description": "Une requête supplémentaire par annonce : DPE détaillé, étage, année de construction, chauffage, charges de copropriété, taxe foncière, équipements. Facturé par fiche.", "default": false }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy Apify (datacenter suffit)." } } }, "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 } } } } } } } } } }