{ "openapi": "3.0.1", "info": { "title": "SquareYards Scraper", "description": "Scrape SquareYards (squareyards.com) - India property listings. Search resale/rental listings by type x city/locality, browse new projects, fetch by URL or ID. Prices in INR, BHK/area, geo, agent, images. SSR, no auth.", "version": "1.0", "x-build-id": "AT2XvBquX9VCevzfW" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~squareyards-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-squareyards-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~squareyards-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-squareyards-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~squareyards-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-squareyards-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", "byCity", "byLocality", "byProject", "byUrls", "byIds" ], "type": "string", "description": "What to fetch.", "default": "search" }, "listingType": { "title": "Listing type (mode=search/byCity/byLocality)", "enum": [ "sale", "rent" ], "type": "string", "description": "Sale (resale listings) or rent (rental listings).", "default": "sale" }, "propertyType": { "title": "Property type (mode=search/byLocality)", "enum": [ "all", "apartments", "independent-houses", "builder-floors", "villas", "plots", "studio", "1-bhk", "2-bhk", "3-bhk", "4-bhk", "5-bhk", "6-bhk", "1-rk", "furnished-properties", "gated-community", "office-spaces", "shops", "showrooms", "owner-properties", "warehouses", "industrial-plots", "lands", "penthouses" ], "type": "string", "description": "Property category. `all` returns every category (property-for-sale-in-...).", "default": "apartments" }, "city": { "title": "City", "enum": [ "delhi", "mumbai", "bangalore", "hyderabad", "pune", "chennai", "kolkata", "gurgaon", "noida", "navi-mumbai", "thane", "lucknow", "ahmedabad", "jaipur", "chandigarh", "indore", "kochi", "goa", "nagpur", "surat", "vadodara", "agra", "kanpur", "patna", "bhopal", "rajkot" ], "type": "string", "description": "Target city. Locality pages are built as /sale/-for-sale-in--.", "default": "delhi" }, "locality": { "title": "Locality (optional)", "type": "string", "description": "Locality slug (e.g. `dwarka`, `rohini`, `andheri-west`). Appended to the city in the URL: /sale/-for-sale-in-dwarka-delhi. Leave empty for city-wide pages." }, "includeProjects": { "title": "Include new projects", "type": "boolean", "description": "SquareYards listing pages embed a few featured new-project cards alongside resale listings. When enabled, they are emitted as `project` records.", "default": true }, "startUrls": { "title": "Listing URLs (mode=byUrls)", "type": "array", "description": "Any SquareYards property page: resale/rental listing pages, detail pages (`/resale-.../`, `/rental-.../`) or project pages (`/-residential-property///project`).", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "ids": { "title": "Listing IDs (mode=byIds)", "type": "array", "description": "SquareYards listing IDs (the trailing number in any listing URL, e.g. `10504566`). Resolved via /resale-property/ and /rental-property/ redirects.", "default": [], "items": { "type": "string" } }, "minPrice": { "title": "Min price (INR)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Drop listings priced below this amount (absolute INR). Sale prices are full amounts, rent prices are monthly." }, "maxPrice": { "title": "Max price (INR)", "minimum": 0, "maximum": 10000000000, "type": "integer", "description": "Drop listings priced above this amount (absolute INR)." }, "possessionStatus": { "title": "Possession status", "enum": [ "any", "readyToMove", "underConstruction", "newLaunch" ], "type": "string", "description": "Filter resale listings and projects by possession/launch status.", "default": "any" }, "furnishing": { "title": "Furnishing", "enum": [ "any", "furnished", "semiFurnished", "unfurnished" ], "type": "string", "description": "Filter listings by furnishing state (mostly populated on rental listings).", "default": "any" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records.", "default": 50 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional. SquareYards is openly accessible without a proxy; enable Apify proxy (AUTO) only if you need it — the actor escalates through it automatically on 403/429.", "default": { "useApifyProxy": 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 } } } } } } } } } }