{ "openapi": "3.0.1", "info": { "title": "Pap.fr Scraper", "description": "Scraper d'annonces immobilières du site **PAP.fr** (De Particulier à Particulier) qui permet de récupérer des annonces de vente, location et leasing avec des critères de recherche structurés.", "version": "1.0", "x-build-id": "ceaxc4MnvCLDancB7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/devnaz~pap-fr-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-devnaz-pap-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/devnaz~pap-fr-scraper/runs": { "post": { "operationId": "runs-sync-devnaz-pap-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/devnaz~pap-fr-scraper/run-sync": { "post": { "operationId": "run-sync-devnaz-pap-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", "required": [ "produit" ], "properties": { "produit": { "title": "Type de produit ⭐ OBLIGATOIRE", "enum": [ "vente", "location", "leasing" ], "type": "string", "description": "Type de transaction immobilière recherchée", "default": "vente" }, "typesBien": { "title": "Types de bien", "type": "array", "description": "Sélectionnez les types de biens à rechercher. Format JSON: [\"appartement\", \"maison\"]. Laissez vide pour tous les types. Note: le leasing accepte uniquement maison et appartement." }, "localisation": { "title": "🌍 Localisation", "type": "object", "description": "Ville de recherche. L'autocomplete récupère automatiquement le code département et geoId via l'API PAP.fr.", "properties": { "ville": { "title": "Ville", "type": "string", "description": "Nom de la ville" }, "codeDepartement": { "title": "Code Département", "type": "string", "description": "Optionnel - Auto-complété si non fourni" }, "geoId": { "title": "Geo ID", "type": "string", "description": "Optionnel - Auto-complété si non fourni" } } }, "nbPieces": { "title": "🚪 Nombre de pièces", "type": "object", "description": "Formats: {\"values\": [2,3]} pour 2 OU 3 pièces, ou {\"min\": 2} pour minimum 2 pièces" }, "nbChambresMin": { "title": "🛏️ Nombre minimum de chambres", "minimum": 1, "maximum": 6, "type": "integer", "description": "Nombre minimum de chambres (1 à 6). Laissez vide pour tous." }, "prix": { "title": "💰 Prix", "type": "object", "description": "Prix en euros. Formats: {\"max\": 500000}, {\"min\": 200000}, ou {\"min\": 150000, \"max\": 400000}. Pour location = loyer mensuel." }, "surface": { "title": "📐 Surface du bien (m²)", "type": "object", "description": "Surface en m². Formats: {\"min\": 50}, {\"max\": 100}, ou {\"min\": 40, \"max\": 70}" }, "surfaceTerrain": { "title": "🌳 Surface du terrain (m²)", "type": "object", "description": "Pour maisons avec jardin ou terrains. Format: {\"min\": 500, \"max\": 2000}" }, "tags": { "title": "🏷️ Critères avancés (Tags)", "type": "array", "description": "Tags spécifiques. Format JSON: [\"ascenseur\", \"piscine\"]. VENTE: ascenseur, balcon-terrasse, piscine, dernier-etage, garages-parkings, visite-virtuelle, duplex-triplex. LOCATION: vide, meuble, coloc, etudiant." }, "neufExclus": { "title": "🏗️ Masquer les logements neufs", "type": "boolean", "description": "Uniquement pour la vente. Exclut les programmes neufs des résultats.", "default": false }, "maxListings": { "title": "🔢 Nombre maximum d'annonces", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Limite le nombre d'annonces scrapées. 0 = illimité (scrape toutes les annonces trouvées)", "default": 50 }, "triDate": { "title": "📅 Tri par date de publication", "enum": [ "aucun", "plus-recent", "plus-ancien" ], "type": "string", "description": "Ordre de tri des annonces retournées par PAP.fr. Combiné avec maxListings, permet de récupérer par exemple les 50 annonces les plus récentes.", "default": "aucun" }, "proxyConfig": { "title": "🔐 Configuration Proxy", "type": "object", "description": "Configuration des proxies. Par défaut: Apify Residential (REQUIS pour contourner Cloudflare sur PAP.fr). Les IP datacenter et directes sont systématiquement bloquées.", "properties": { "type": { "title": "Type de proxy", "type": "string", "description": "Type de proxy à utiliser. 'apify-residential' recommandé — PAP.fr bloque les autres options.", "enum": [ "apify-residential", "apify-datacenter", "custom", "none" ], "default": "apify-residential" }, "customProxies": { "title": "Proxies personnalisés", "type": "array", "description": "Liste d'URLs de proxies personnalisés. Format: [\"http://user:pass@proxy1.com:8080\", \"http://proxy2.com:3128\"]. Obligatoire si type = 'custom'.", "items": { "type": "string" } } } } } }, "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 } } } } } } } } } }