{ "openapi": "3.0.1", "info": { "title": "Housing.com Listings Scraper - Buy & Rent", "description": "Scrape Housing.com buy and rent listings by city or canonical search URL. Get deduplicated prices, locations, areas, media, tags, RERA, sellers, and optional detail enrichment.", "version": "1.0", "x-build-id": "dmy8SEZXcqEFnyg4y" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/hermandev~housing-com-property-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-hermandev-housing-com-property-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/hermandev~housing-com-property-scraper/runs": { "post": { "operationId": "runs-sync-hermandev-housing-com-property-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/hermandev~housing-com-property-scraper/run-sync": { "post": { "operationId": "run-sync-hermandev-housing-com-property-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": { "cities": { "title": "Cities", "minItems": 1, "type": "array", "description": "Easy mode. Enter one or more supported cities: mumbai, bengaluru, hyderabad, pune, chennai, new-delhi, gurgaon, noida, kolkata, ahmedabad, thane, or navi-mumbai.", "items": { "type": "string" } }, "transactionTypes": { "title": "Listing types", "minItems": 1, "uniqueItems": true, "type": "array", "description": "Buy, rent, or both. Used with city mode; canonical URLs already contain their transaction type.", "items": { "type": "string" }, "default": [ "buy", "rent" ] }, "startUrls": { "title": "Canonical search URLs (advanced)", "minItems": 1, "type": "array", "description": "Exact-search mode. One or more URLs matching /in/buy/searches/ or /rent/search-. Leave cities empty when using URLs.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "maxItems": { "title": "Maximum matching listings", "minimum": 1, "type": "integer", "description": "Maximum number of unique listings saved across every city or URL, after filters are applied.", "default": 100 }, "minPrice": { "title": "Minimum price (INR)", "minimum": 0, "type": "number", "description": "Optional minimum listing price in Indian rupees. Listings without a usable price are excluded when a price filter is active." }, "maxPrice": { "title": "Maximum price (INR)", "minimum": 0, "type": "number", "description": "Optional maximum listing price in Indian rupees." }, "daysOld": { "title": "Listed within the last number of days", "minimum": 1, "type": "integer", "description": "Optional listing-age filter. Listings without a parseable posted date are excluded when enabled." }, "maxPagesPerSearch": { "title": "Maximum pages per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Safety and cost cap for each city/transaction or canonical URL.", "default": 40 }, "maxImages": { "title": "Maximum image URLs per listing", "minimum": 0, "maximum": 50, "type": "integer", "description": "Limits property and floor-plan image URL arrays. Use 0 to omit image arrays while retaining the cover image.", "default": 6 }, "enrichDetails": { "title": "Enrich listing details", "type": "boolean", "description": "Make one additional request per matching listing for richer address, configuration, amenity, RERA, media, and seller fields.", "default": false }, "includeRaw": { "title": "Include raw source data", "type": "boolean", "description": "Include parsed source objects under raw. This can significantly increase dataset size.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify Proxy or custom proxy configuration. Indian residential fallback is attempted after blocks when available.", "default": { "useApifyProxy": false } }, "maxConcurrency": { "title": "Maximum detail concurrency", "minimum": 1, "maximum": 5, "type": "integer", "description": "Concurrent detail requests. Search pages remain sequential to protect pagination correctness.", "default": 2 } } }, "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 } } } } } } } } } }