{ "openapi": "3.0.1", "info": { "title": "Housing.com India Scraper", "description": "Scrape residential property listings from housing.com. Supports buy and rent across 750+ cities.", "version": "0.1", "x-build-id": "FjVfZCbGf2rbC6VS5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/abotapi~housing-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-abotapi-housing-com-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~housing-com-scraper/runs": { "post": { "operationId": "runs-sync-abotapi-housing-com-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~housing-com-scraper/run-sync": { "post": { "operationId": "run-sync-abotapi-housing-com-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", "url" ], "type": "string", "description": "Scraping mode: 'search' builds query from city/locality, 'url' extracts locality from provided housing.com URLs", "default": "search" }, "urls": { "title": "Search URLs", "type": "array", "description": "Housing.com search URLs (url mode only). e.g. https://housing.com/in/buy/search?f=eyJiYX...", "items": { "type": "string" } }, "service": { "title": "Service", "enum": [ "buy", "rent" ], "type": "string", "description": "Buy or Rent", "default": "buy" }, "city": { "title": "City", "type": "string", "description": "City name (e.g. 'Mumbai', 'Delhi', 'Bangalore', 'Pune'). Use the city listing to find exact names.", "default": "Mumbai" }, "locality": { "title": "Locality", "type": "string", "description": "Locality/area within the city (e.g. 'andheri_west', 'bandra_west'). Leave empty for entire city." }, "min_price": { "title": "Min Price (INR)", "type": "integer", "description": "Minimum price in INR. Post-filter — applied client-side after fetching results. For buy: e.g. 5000000 = 50 Lakhs. For rent: e.g. 30000 = ₹30K/month." }, "max_price": { "title": "Max Price (INR)", "type": "integer", "description": "Maximum price in INR. Post-filter — applied client-side." }, "min_bhk": { "title": "Min BHK", "minimum": 1, "maximum": 6, "type": "number", "description": "Minimum BHK (e.g. 2 for 2+ BHK). Post-filter — applied client-side." }, "max_bhk": { "title": "Max BHK", "minimum": 1, "maximum": 6, "type": "number", "description": "Maximum BHK (e.g. 3 for up to 3 BHK). Post-filter — applied client-side." }, "property_type": { "title": "Property Type", "enum": [ "project", "resale", "rent" ], "type": "string", "description": "Filter by property type. Post-filter — applied client-side." }, "max_properties": { "title": "Max Properties", "minimum": 0, "type": "integer", "description": "Maximum number of properties to scrape (0=unlimited)", "default": 30 }, "max_pages": { "title": "Max Pages", "minimum": 1, "type": "integer", "description": "Maximum number of result pages (30 listings per page)", "default": 1000 }, "proxy": { "title": "Proxy Configuration", "type": "object", "description": "Proxy configuration. Optional — the API works without proxy." }, "dataset_name": { "title": "Dataset Name", "type": "string", "description": "Custom dataset name (leave empty for default)" }, "clear_dataset": { "title": "Clear Dataset", "type": "boolean", "description": "Clear the dataset before scraping", "default": false } } }, "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 } } } } } } } } } }