{ "openapi": "3.0.1", "info": { "title": "Pap.fr $1💰| URL Search | Keyword Filters | Rich Output", "description": "From $1/1k. Extract property listings from pap.fr. Get fully-detailed listings with price, address, rooms, area, photo gallery, description, and arrondissement/department/region geography.", "version": "1.0", "x-build-id": "qjaXPZj81eF9wrRdZ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~pap-fr-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-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/abotapi~pap-fr-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-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/abotapi~pap-fr-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-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", "properties": { "mode": { "title": "1. Search mode", "enum": [ "filter", "url" ], "type": "string", "description": "Filter mode = pick property type + city + department. URL mode = paste any pap.fr search URL already refined in a browser (recommended for price/surface filters since pap.fr encodes those only after you've interacted with the search form).", "default": "filter" }, "locations": { "title": "Locations to search (Filter mode)", "type": "array", "description": "Enter a French city name. The 2-digit department code is auto-derived from the city and is only required to disambiguate names shared by multiple communes (e.g. Saint-Denis exists in both 93 and 974).", "items": { "type": "object", "properties": { "city": { "title": "City", "type": "string", "description": "French city name, e.g. Paris, Lyon, Marseille, Bordeaux, Nice, Toulouse.", "editor": "textfield" }, "department": { "title": "Department code (optional)", "type": "string", "description": "Optional. 2-digit French department code (département). Auto-derived from the city if left blank. Provide it only when the city name is shared by multiple communes (e.g. Saint-Denis: 93 vs 974, Saint-Pierre: 9 communes). Paris=75, Rhône=69, Bouches-du-Rhône=13, Gironde=33, Alpes-Maritimes=06, Haute-Garonne=31, Nord=59.", "editor": "textfield" } } } }, "listingType": { "title": "Buy or rent? (Filter mode)", "enum": [ "Buy", "Rent" ], "type": "string", "description": "Pick Vente (Buy) or Location (Rent). Filter mode only.", "default": "Buy" }, "propertyType": { "title": "Property type (Filter mode)", "enum": [ "Apartment", "House", "Plot", "Parking", "CommercialProperty" ], "type": "string", "description": "What kind of property to search for. Filter mode only.", "default": "Apartment" }, "roomsMin": { "title": "Min rooms / pièces (Filter mode)", "minimum": 1, "maximum": 10, "type": "integer", "description": "Minimum number of rooms (pièces). PAP encodes rooms as a URL path segment, so this is applied to the generated URL. Filter mode only." }, "sortBy": { "title": "Sort order (Filter mode)", "enum": [ "Default", "PriceAsc", "PriceDesc", "SurfaceAsc", "SurfaceDesc", "DateAsc" ], "type": "string", "description": "How to order results. Filter mode only — in URL mode the sort is taken from your pasted URL. Default = most recent first (PAP's own default).", "default": "Default" }, "urls": { "title": "Search URLs (URL mode)", "type": "array", "description": "One or more full pap.fr search URLs. Tip: open pap.fr in your browser, pick property type + location + any price/surface filters, then paste the resulting URL here. If the URL ends with `-N` (page number), scraping starts at page N and walks forward.", "items": { "type": "string" } }, "maxPages": { "title": "Max pages per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "How many result pages to walk per location / URL. PAP returns 20 listings per page.", "default": 1 }, "maxListings": { "title": "Max total listings", "minimum": 0, "type": "integer", "description": "Hard cap across the whole run. 0 = unlimited (bounded only by Max pages).", "default": 0 }, "fetchDetails": { "title": "Visit each listing's detail page", "type": "boolean", "description": "Adds lat/lng, DPE/GES energy classes, street address, full seller description, reference number, bedrooms, floor, HOA charges, property tax, heating type, and the full high-res photo gallery. Turn off for a faster run with just the SERP-level fields (price, rooms, m², city, primary photo).", "default": true }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "EU residential proxy is preferred. FR may have issues; default pins IT." } } }, "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 } } } } } } } } } }