{ "openapi": "3.0.1", "info": { "title": "Figaro Immobilier Scraper", "description": "Scrape property listings from immobilier.lefigaro.fr. Use structured filters (listing type, property type, location, rooms, price — great for AI agents) or paste an input_url (great for humans). Returns price, surface, rooms, DPE, location, agency, and photos.", "version": "0.1", "x-build-id": "oyG5Urz46gx9fiR9O" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dadhalfdev~figaro-immobilier-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dadhalfdev-figaro-immobilier-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/dadhalfdev~figaro-immobilier-scraper/runs": { "post": { "operationId": "runs-sync-dadhalfdev-figaro-immobilier-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/dadhalfdev~figaro-immobilier-scraper/run-sync": { "post": { "operationId": "run-sync-dadhalfdev-figaro-immobilier-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": { "input_url": { "title": "Input URL", "type": "string", "description": "Optional. Paste any Figaro Immobilier search results URL to override the filters below. Leave empty to use structured filters instead (better for AI agents)." }, "listing_type": { "title": "Listing type", "enum": [ "vente", "location" ], "type": "string", "description": "Buy (vente) or rent (location). Ignored when input_url is set.", "default": "vente" }, "property_type": { "title": "Property type", "enum": [ "appartement", "maison", "parking", "terrain", "divers", "bien" ], "type": "string", "description": "Property category. Ignored when input_url is set.", "default": "appartement" }, "location": { "title": "Location", "type": "string", "description": "City or place name (e.g. paris, lyon, toulouse, france). Many cities work better with a postal code — common ones are auto-added if postal_code is empty. Ignored when input_url is set.", "default": "paris" }, "district": { "title": "District / arrondissement", "type": "string", "description": "Optional district (e.g. 11eme, 16eme). Ignored when input_url is set." }, "postal_code": { "title": "Postal code", "type": "string", "description": "Postal code (e.g. 31000 for Toulouse, 33000 for Bordeaux). Helpful for many cities. Ignored when input_url is set." }, "rooms": { "title": "Rooms", "enum": [ "", "studio", "2pieces", "3pieces", "4pieces", "5pieces", "6pieces" ], "type": "string", "description": "Optional room filter. Ignored when input_url is set.", "default": "" }, "price_min": { "title": "Minimum price (€)", "minimum": 0, "type": "integer", "description": "Optional minimum price in euros. Ignored when input_url is set." }, "price_max": { "title": "Maximum price (€)", "minimum": 0, "type": "integer", "description": "Optional maximum price in euros. Ignored when input_url is set." }, "max_properties": { "title": "Maximum number of listings", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many listings to return (1–500).", "default": 50 } } }, "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 } } } } } } } } } }