{
  "openapi": "3.0.1",
  "info": {
    "title": "Housing.com Scraper",
    "description": "Scrape property listings from Housing.com using search queries or start URLs. Extract prices, amenities, seller/agent details, and optional listing-page extras.",
    "version": "1.0",
    "x-build-id": "faBcXGh0r2ja0h8HV"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/rigelbytes~housing-com-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-rigelbytes-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/rigelbytes~housing-com-scraper/runs": {
      "post": {
        "operationId": "runs-sync-rigelbytes-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/rigelbytes~housing-com-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-rigelbytes-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",
        "properties": {
          "searchQueries": {
            "title": "Search Queries",
            "type": "array",
            "description": "Locations to search on Housing.com (e.g. \"Delhi\", \"Whitefield Bangalore\", \"Bandra Mumbai\"). Primary input for AI agents — no URL required. The first autocomplete match is used.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "Start URLs",
            "type": "array",
            "description": "Housing.com search or listing URLs (e.g. \"https://housing.com/in/buy/new-delhi/\", \"https://housing.com/in/buy/new-delhi/house-fid/\", or a listing page). Optional — filters still apply to query-based searches.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "service": {
            "title": "Service",
            "enum": [
              "buy",
              "rent",
              "plots",
              "commercial",
              "paying_guest",
              "flatmate"
            ],
            "type": "string",
            "description": "Housing.com product to search (e.g. buy, rent). Applies to search queries and city start URLs that do not already encode a product.",
            "default": "buy"
          },
          "category": {
            "title": "Category",
            "enum": [
              "residential",
              "commercial"
            ],
            "type": "string",
            "description": "Inventory category. Use residential for homes and commercial for offices or shops.",
            "default": "residential"
          },
          "propertyTypes": {
            "title": "Property types",
            "uniqueItems": true,
            "type": "array",
            "description": "Restrict results to these property types (e.g. apartment, independent house, plot). Leave empty for all types.",
            "items": {
              "type": "string",
              "enum": [
                "apartment",
                "independent_house",
                "villa",
                "plot",
                "studio",
                "penthouse",
                "farmhouse",
                "builder_floor",
                "duplex"
              ],
              "enumTitles": [
                "Apartment",
                "Independent house",
                "Villa",
                "Plot",
                "Studio apartment",
                "Penthouse",
                "Farmhouse / agricultural land",
                "Builder floor",
                "Duplex"
              ]
            }
          },
          "bhk": {
            "title": "BHK",
            "uniqueItems": true,
            "type": "array",
            "description": "Bedroom configuration to include (e.g. 2, 3). 1rk is studio / 1 RK.",
            "items": {
              "type": "string",
              "enum": [
                "1rk",
                "1",
                "2",
                "3",
                "4",
                "5"
              ],
              "enumTitles": [
                "1 RK",
                "1 BHK",
                "2 BHK",
                "3 BHK",
                "4 BHK",
                "5+ BHK"
              ]
            }
          },
          "furnishTypes": {
            "title": "Furnishing",
            "uniqueItems": true,
            "type": "array",
            "description": "Furnishing filter (furnished, semi-furnished, unfurnished).",
            "items": {
              "type": "string",
              "enum": [
                "furnished",
                "semi_furnished",
                "unfurnished"
              ],
              "enumTitles": [
                "Furnished",
                "Semi-furnished",
                "Unfurnished"
              ]
            }
          },
          "listingTypes": {
            "title": "Listing type",
            "uniqueItems": true,
            "type": "array",
            "description": "New projects, resale listings, or both. Leave empty for all.",
            "items": {
              "type": "string",
              "enum": [
                "project",
                "resale"
              ],
              "enumTitles": [
                "New projects",
                "Resale"
              ]
            }
          },
          "possession": {
            "title": "Possession",
            "enum": [
              "",
              "ready_to_move"
            ],
            "type": "string",
            "description": "Ready-to-move inventory only, or no restriction."
          },
          "postedBy": {
            "title": "Posted by",
            "enum": [
              "",
              "owner"
            ],
            "type": "string",
            "description": "Restrict to owner / without-brokerage listings when set to Owner."
          },
          "gatedCommunity": {
            "title": "Gated community",
            "type": "boolean",
            "description": "Only include gated-community listings when enabled.",
            "default": false
          },
          "reraVerified": {
            "title": "RERA verified",
            "type": "boolean",
            "description": "Only include RERA-verified listings when enabled.",
            "default": false
          },
          "minPrice": {
            "title": "Minimum price (INR)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings at or above this price in Indian rupees (e.g. 5000000 for ₹50 L). Applied after results are fetched."
          },
          "maxPrice": {
            "title": "Maximum price (INR)",
            "minimum": 0,
            "type": "integer",
            "description": "Keep listings at or below this price in Indian rupees (e.g. 20000000 for ₹2 Cr). Applied after results are fetched."
          },
          "extractListingDetails": {
            "title": "Extract listing details",
            "type": "boolean",
            "description": "Open each listing in parallel for neighbourhood landmarks, Q&A, and page extras. Charged as listing-details only when extras are actually attached. Search-card fields are always returned.",
            "default": false
          },
          "extractAgentInfo": {
            "title": "Extract agent information",
            "type": "boolean",
            "description": "Also scrape recommended Housing.com agents / brokers for each search. Each agent is a separate dataset row charged as agent-info. Listing sellers on the card are always included.",
            "default": false
          },
          "maxConcurrency": {
            "title": "Max concurrency",
            "minimum": 1,
            "maximum": 10,
            "type": "integer",
            "description": "Parallel listing-detail workers (1–10). Higher is faster; each request uses a rotated residential proxy.",
            "default": 5
          },
          "maxItems": {
            "title": "Max Items",
            "minimum": 0,
            "type": "integer",
            "description": "Maximum number of listing records to scrape (0 = unlimited). Agent rows do not count toward this cap.",
            "default": 0
          },
          "proxyConfiguration": {
            "title": "Proxy Configuration",
            "type": "object",
            "description": "Proxy settings for anti-bot protection. Apify Residential is recommended for Housing.com.",
            "default": {
              "useApifyProxy": true,
              "apifyProxyGroups": [
                "RESIDENTIAL"
              ]
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}