{ "openapi": "3.0.1", "info": { "title": "Leboncoin Real Estate Scraper", "description": "Scrape leboncoin.fr real estate listings with full filters: city, price, surface, rooms, DPE. Returns 40+ fields per ad — GPS, images, seller info, energy class. No proxy setup needed, works out of the box.", "version": "1.0", "x-build-id": "FViORksFUgdletfbz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/leadsbrary~leboncoin-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-leadsbrary-leboncoin-real-estate-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/leadsbrary~leboncoin-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-leadsbrary-leboncoin-real-estate-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/leadsbrary~leboncoin-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-leadsbrary-leboncoin-real-estate-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": { "keywords": { "title": "Keywords", "type": "string", "description": "Search keywords. Examples: 'maison', 'appartement', 'appartement T3', 'villa'", "default": "maison" }, "city": { "title": "City / Arrondissement", "type": "string", "description": "City name or postcode. Examples: 'Paris 15', '75015', 'Lyon 3', '69003', 'Bordeaux', 'Marseille 8'" }, "radius": { "title": "Search Radius (meters)", "minimum": 500, "maximum": 100000, "type": "integer", "description": "Radius around the city centre in meters. Default: 10000 (10 km).", "default": 10000 }, "priceMin": { "title": "Price Min (€)", "minimum": 0, "type": "integer", "description": "Minimum price in euros." }, "priceMax": { "title": "Price Max (€)", "minimum": 0, "type": "integer", "description": "Maximum price in euros." }, "surfaceMin": { "title": "Surface Min (m²)", "minimum": 0, "type": "integer", "description": "Minimum living area in square metres." }, "surfaceMax": { "title": "Surface Max (m²)", "minimum": 0, "type": "integer", "description": "Maximum living area in square metres." }, "roomsMin": { "title": "Rooms Min", "minimum": 1, "maximum": 20, "type": "integer", "description": "Minimum number of rooms (pièces)." }, "maxAds": { "title": "Max Ads", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of ads to collect. Leboncoin returns 35 ads per page.", "default": 100 }, "delay": { "title": "Delay Between Pages (seconds)", "minimum": 0.5, "maximum": 30, "type": "number", "description": "Pause between page requests to avoid rate limiting. Default: 2.0s", "default": 2 }, "forceDescription": { "title": "Force Description (if not found)", "type": "boolean", "description": "Leboncoin's search results never include the ad description ('description' is always empty otherwise) — the full text only exists on the ad's own page. Enable this to force the actor to open each ad's page and fetch it. Billing: each ad for which a description is found this way is charged as 1 extra result, on top of its normal result charge — same per-result price your account already pays (whatever your Apify plan/tier gives you), no separate fixed fee. Also adds 1 extra request per ad and longer run time — recommended only with a reasonable maxAds.", "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 } } } } } } } } } }