{ "openapi": "3.0.1", "info": { "title": "CommonFloor Scraper - Property Listings & Prices", "description": "Scrape property listings from CommonFloor.com. Get title, price, BHK, area, location, project name, coordinates, and more for buy/rent/PG listings across Indian cities.", "version": "0.2", "x-build-id": "0phMJDWBKtR5s3SdR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/thirdwatch~commonfloor-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-thirdwatch-commonfloor-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/thirdwatch~commonfloor-scraper/runs": { "post": { "operationId": "runs-sync-thirdwatch-commonfloor-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/thirdwatch~commonfloor-scraper/run-sync": { "post": { "operationId": "run-sync-thirdwatch-commonfloor-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": [ "searchMode", "city" ], "properties": { "searchMode": { "title": "Search Mode", "enum": [ "rent", "buy", "pg" ], "type": "string", "description": "What kind of listings to scrape. `rent` = rentals, `buy` = sale listings, `pg` = paying guest / shared accommodation.", "default": "rent" }, "city": { "title": "City", "type": "string", "description": "Indian city to search in. Examples: Bangalore, Mumbai, Delhi, Hyderabad, Pune, Chennai, Gurgaon, Noida, Kolkata, Ahmedabad.", "default": "Bangalore" }, "localities": { "title": "Localities (optional)", "type": "array", "description": "Filter to specific neighbourhoods/localities within the city. Example: [\"Koramangala\", \"HSR Layout\", \"Indiranagar\"]. Leave empty to get all localities.", "default": [], "items": { "type": "string" } }, "bhk": { "title": "BHK (bedrooms)", "uniqueItems": true, "type": "array", "description": "Filter by number of bedrooms. Select one or more. Leave empty for all. (5 = 5+ BHK.)", "items": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "enumTitles": [ "1 BHK", "2 BHK", "3 BHK", "4 BHK", "5+ BHK" ] }, "default": [] }, "propertyType": { "title": "Property Type", "uniqueItems": true, "type": "array", "description": "Filter by property type. Leave empty for all types. Note: `pg` auto-applies when Search Mode = PG.", "items": { "type": "string", "enum": [ "apartment", "villa", "independent-house", "builder-floor", "studio", "plot", "pg" ], "enumTitles": [ "Apartment", "Villa", "Independent House", "Builder Floor", "Studio", "Plot / Land", "PG / Paying Guest" ] }, "default": [] }, "minPrice": { "title": "Minimum Price (INR)", "minimum": 0, "type": "integer", "description": "Minimum price in Indian Rupees. For `rent`/`pg`: monthly rent (e.g. 10000). For `buy`: total price (e.g. 5000000 for 50 Lakh)." }, "maxPrice": { "title": "Maximum Price (INR)", "minimum": 0, "type": "integer", "description": "Maximum price in Indian Rupees. For `rent`/`pg`: monthly rent (e.g. 50000). For `buy`: total price (e.g. 20000000 for 2 Cr)." }, "minArea": { "title": "Minimum Area (sq ft)", "minimum": 0, "type": "integer", "description": "Minimum property area in square feet." }, "maxArea": { "title": "Maximum Area (sq ft)", "minimum": 0, "type": "integer", "description": "Maximum property area in square feet." }, "furnishing": { "title": "Furnishing (rent only)", "uniqueItems": true, "type": "array", "description": "Filter by furnishing status. Typically applies to rent listings.", "items": { "type": "string", "enum": [ "furnished", "semi-furnished", "unfurnished" ], "enumTitles": [ "Furnished", "Semi-Furnished", "Unfurnished" ] }, "default": [] }, "availability": { "title": "Availability (buy only)", "enum": [ "any", "ready", "under-construction" ], "type": "string", "description": "For buy listings: restrict to ready-to-move-in or under-construction properties.", "default": "any" }, "tenantType": { "title": "Tenant Type (rent only)", "uniqueItems": true, "type": "array", "description": "For rent listings: restrict to listings that allow the chosen tenant type(s).", "items": { "type": "string", "enum": [ "family", "bachelor", "company" ], "enumTitles": [ "Family", "Bachelor", "Company / Corporate" ] }, "default": [] }, "fetchDetails": { "title": "Fetch Detail Pages", "type": "boolean", "description": "Fetch each listing's detail page for extra fields: deposit, furnishing, facing, floor, bathrooms, amenities, description, etc. Default: true for rent/PG, false for buy. Adds ~1 second per listing." }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Maximum number of listings to return. CommonFloor returns 30 listings per page.", "default": 15 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Pre-configured to use India-based addresses for best results. Leave as-is unless you have a specific need.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "IN" } } } }, "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 } } } } } } } } } }