{ "openapi": "3.0.1", "info": { "title": "Zameen Real Estate Scraper", "description": "Scrape Pakistani real estate listings from zameen.com - houses, plots, and commercial property for sale or rent. Filter by city, price, bedrooms, and area, or fetch full property details by URL.", "version": "1.0", "x-build-id": "sPAdovBAjjxxunNKO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~zameen-real-estate-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-zameen-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/crawlerbros~zameen-real-estate-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-zameen-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/crawlerbros~zameen-real-estate-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-zameen-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "search", "byUrl" ], "type": "string", "description": "`search` browses listings by city + listing type + filters. `byUrl` fetches full detail records for specific zameen.com property URLs.", "default": "search" }, "city": { "title": "City (mode=search)", "enum": [ "Lahore", "Karachi", "Islamabad", "Rawalpindi", "Faisalabad", "Multan", "Peshawar", "Sialkot", "Gujranwala", "Bahawalpur", "Sargodha", "Sahiwal", "Hyderabad", "Quetta", "Abbottabad", "Sukkur", "Gujrat", "Jhelum", "Mardan", "Sheikhupura", "Kasur", "Okara", "Nowshera", "Attock", "Muzaffarabad", "Mirpur (AJK)", "Chakwal", "Mandi Bahauddin", "Toba Tek Singh" ], "type": "string", "description": "Pakistani city to browse. Use `customLocationSlug` instead for a city/area not in this list.", "default": "Lahore" }, "customLocationSlug": { "title": "Custom location slug (mode=search, advanced)", "type": "string", "description": "Override `city` with any zameen.com location slug, e.g. `Lahore_Jubilee_Town-766` or `Lahore-1` (found in a zameen.com search URL like zameen.com/Homes/-1.html). Leave empty to use `city`." }, "listingType": { "title": "Listing type (mode=search)", "enum": [ "housesForSale", "plotsForSale", "commercialForSale", "housesForRent", "plotsForRent", "commercialForRent" ], "type": "string", "description": "Property super-category and sale/rent purpose.", "default": "housesForSale" }, "propertyUrls": { "title": "Property URLs (mode=byUrl)", "type": "array", "description": "Full zameen.com property page URLs, e.g. `https://www.zameen.com/Property/.html`.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price (PKR)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Drop listings priced below this (Pakistani Rupees). Listings without a parseable price are kept." }, "maxPrice": { "title": "Max price (PKR)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Drop listings priced above this (Pakistani Rupees). Listings without a parseable price are kept." }, "minBedrooms": { "title": "Min bedrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with fewer bedrooms than this. Plots and listings without a parseable bedroom count (not every zameen.com listing reports one) are kept." }, "maxBedrooms": { "title": "Max bedrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with more bedrooms than this. Plots and listings without a parseable bedroom count (not every zameen.com listing reports one) are kept." }, "minBathrooms": { "title": "Min bathrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with fewer bathrooms than this. Plots and listings without a parseable bathroom count are kept." }, "maxBathrooms": { "title": "Max bathrooms", "minimum": 0, "maximum": 50, "type": "integer", "description": "Drop listings with more bathrooms than this. Plots and listings without a parseable bathroom count are kept." }, "minArea": { "title": "Min area", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Drop listings smaller than this (unit set by `areaUnit`). Listings without a parseable area are kept." }, "maxArea": { "title": "Max area", "minimum": 0, "maximum": 1000000, "type": "number", "description": "Drop listings larger than this (unit set by `areaUnit`). Listings without a parseable area are kept." }, "areaUnit": { "title": "Area unit", "enum": [ "marla", "kanal", "sqft", "sqm" ], "type": "string", "description": "Unit for `minArea` / `maxArea`.", "default": "marla" }, "sortBy": { "title": "Sort by (mode=search)", "enum": [ "popular", "newest", "priceLowToHigh", "priceHighToLow" ], "type": "string", "description": "Result ordering, applied server-side by zameen.com before the price/bedroom/area/keyword filters below run. `popular` (default) is zameen.com's own relevance/featured ranking. Useful with a low `maxItems` to get e.g. the 30 cheapest or 30 newest matching listings instead of an arbitrary relevance-ranked slice.", "default": "popular" }, "verifiedOnly": { "title": "Verified listings only", "type": "boolean", "description": "Only emit listings zameen.com has marked as verified.", "default": false }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Only emit listings whose title/description/location contains this text (case-insensitive). Matches both the English and Urdu title/description fields, so Urdu-script keywords work too." }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 2000, "type": "integer", "description": "Hard cap on emitted records.", "default": 30 } } }, "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 } } } } } } } } } }