{ "openapi": "3.0.1", "info": { "title": "99acres Scraper - India Property Listings", "description": "Scrape 99acres.com property listings to buy, rent or resale in any Indian city, or paste a search URL. Every record carries the price, area and locality the site publishes. Filter by distance from a point. Structured rows, ready for a spreadsheet or a CRM.", "version": "0.1", "x-build-id": "ylYtQcj6dlSta3Rax" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/blackfalcondata~99acres-com-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-blackfalcondata-99acres-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/blackfalcondata~99acres-com-scraper/runs": { "post": { "operationId": "runs-sync-blackfalcondata-99acres-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/blackfalcondata~99acres-com-scraper/run-sync": { "post": { "operationId": "run-sync-blackfalcondata-99acres-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": { "query": { "title": "🔍 What to search", "type": "string", "description": "The kind of listings to collect - a listing type, not a free-text keyword. One of: `buy` (default), `rent`, `resale`, `new-booking`, `pg`, `commercial`, `commercial-rent`. You can also paste a full 99acres search URL here with all its filters applied. Required if no Start URLs are provided. Use a JSON array for several searches in one run, e.g. [\"buy\",\"rent\"]." }, "location": { "title": "📍 City", "type": "string", "description": "City to search, e.g. Mumbai, Bangalore, Pune, Delhi. Defaults to Mumbai. Use a JSON array for several cities in one run, e.g. [\"Mumbai\",\"Pune\"]." }, "maxResults": { "title": "💯 Max Results", "minimum": 0, "maximum": 1000, "type": "integer", "description": "Maximum total results (0 = unlimited).", "default": 100 }, "startUrls": { "title": "🔗 Start URLs", "type": "array", "description": "Paste 99acres.com pages: a search page (a city search such as https://www.99acres.com/property-in-mumbai-ffid for buy, rent, resale, PG or commercial; filters in the URL are kept), the \"properties for sale\" or \"properties for rent\" listings page of a project (the link ends in -npffid or -rnpffid), a project page (its own \"for sale\" and \"for rent\" listings are scraped), or a single property page. Each URL becomes its own task; results are merged and deduped by listing ID across all URLs. When provided, startUrls REPLACE the query/location fields (unsupported URLs are skipped, and if none is supported the run stops with an input error).", "items": { "type": "string" }, "default": [] }, "bedrooms": { "title": "🛏️ Bedrooms", "type": "array", "description": "Keep only listings with these bedroom counts, e.g. [\"2\",\"3\"]. Use \"4+\" (any N from 1 to 9 followed by +) for N or more. Empty = any. Listings that do not state a bedroom count are left out when this is set.", "items": { "type": "string" } }, "propertyTypes": { "title": "🏠 Property types", "type": "array", "description": "Keep only these property types. Empty = any.", "items": { "type": "string", "enum": [ "apartment", "independent-house", "villa", "builder-floor", "plot", "farm-house", "studio", "serviced-apartment", "office", "shop", "showroom", "warehouse", "commercial-land", "industrial-land", "agricultural-land", "factory", "hotel" ], "enumTitles": [ "Apartment / Flat", "Independent house", "Villa", "Builder floor", "Plot / residential land", "Farm house", "Studio apartment", "Serviced apartment", "Office space", "Shop", "Showroom", "Warehouse / godown", "Commercial land", "Industrial land", "Agricultural land", "Factory", "Hotel / resort" ] } }, "minPrice": { "title": "💰 Min price (INR)", "minimum": 0, "type": "integer", "description": "Minimum price in Indian rupees (rent per month for rent searches). Listings without a price are left out when a price limit is set." }, "maxPrice": { "title": "💰 Max price (INR)", "minimum": 0, "type": "integer", "description": "Maximum price in Indian rupees (rent per month for rent searches)." }, "minArea": { "title": "📐 Min area (sq ft)", "minimum": 0, "type": "integer", "description": "Minimum area in square feet (the largest of carpet, built-up and super built-up area the listing states). Listings with no area in square feet are left out when an area limit is set." }, "maxArea": { "title": "📐 Max area (sq ft)", "minimum": 0, "type": "integer", "description": "Maximum area in square feet." }, "saleType": { "title": "🏷️ Sale type", "enum": [ "all", "resale", "new-booking" ], "type": "string", "description": "For buy searches: all listings, only resale, or only new booking. New-project cards (includeProjects) carry no sale type and are not excluded by this filter.", "default": "all" }, "includeProjects": { "title": "🏗️ Include new projects", "type": "boolean", "description": "Also return the new-project cards shown on the search page (builder, price range, possession status, location). They are marked resultType \"project\" and count toward Max Results. Off by default: only individual listings are returned.", "default": false }, "enrichEmails": { "title": "✉️ Find contact emails", "type": "boolean", "description": "Look for a public contact email on the website of each advertiser or builder. Billed per contact email found; rows where no email is found are free. Adds time to the run. Private owners are skipped.", "default": false }, "descriptionMaxLength": { "title": "✂️ Description Max Length", "minimum": 0, "type": "integer", "description": "Truncate description to N chars. 0 = no truncation.", "default": 0 }, "compact": { "title": "📦 Compact Output", "type": "boolean", "description": "Core fields only (for AI-agent/MCP workflows).", "default": false }, "descriptionFormat": { "title": "Description format", "enum": [ "all", "text" ], "type": "string", "description": "Pick a single description representation. 99acres serves the listing description as plain text only, so `all` and `text` both keep it.", "default": "all" }, "excludeEmptyFields": { "title": "Exclude empty fields from output", "type": "boolean", "description": "Drop null, empty-string, and empty-array fields from each record before push. Smaller payloads for AI agents and dashboards.", "default": false }, "incrementalMode": { "title": "♻️ Incremental Mode", "type": "boolean", "description": "Compare against previous run state. stateKey is optional — defaults to a value derived from search inputs (queries, locations, startUrls, country) so different filter sets never share state.", "default": false }, "stateKey": { "title": "🔑 State Key", "type": "string", "description": "Optional. Stable identifier for the tracked search universe. Leave empty to auto-generate from search inputs." }, "skipReposts": { "title": "🚫 Skip Reposts", "type": "boolean", "description": "When incremental, skip listings whose content matches an expired listing from a prior run (cross-run duplicate detection).", "default": false }, "emitUnchanged": { "title": "🔄 Emit Unchanged Listings", "type": "boolean", "description": "When incremental mode is on, also emit listings whose content has not changed since the last run.", "default": false }, "emitExpired": { "title": "⚰️ Emit Expired Listings", "type": "boolean", "description": "When incremental mode is on, also emit listings that were seen before but are no longer found.", "default": false }, "notifyOnlyChanges": { "title": "🔄 Notify Only New/Updated", "type": "boolean", "description": "When Incremental Mode is on, only send notifications for NEW and UPDATED listings. Has no effect outside incremental mode.", "default": false }, "notificationLimit": { "title": "📊 Max Listings Per Notification", "minimum": 1, "maximum": 20, "type": "integer", "description": "Maximum number of listings included in each notification message (1–20).", "default": 5 }, "telegramToken": { "title": "🔑 Telegram Bot Token", "type": "string", "description": "Telegram bot token (from @BotFather). Required for Telegram notifications." }, "telegramChatId": { "title": "💬 Telegram Chat ID", "type": "string", "description": "Telegram chat or channel ID (e.g. \"-100123456789\"). Required when telegramToken is set." }, "discordWebhookUrl": { "title": "🎮 Discord Webhook URL", "type": "string", "description": "Discord incoming webhook URL. Server Settings → Integrations → Webhooks → New Webhook." }, "slackWebhookUrl": { "title": "💼 Slack Webhook URL", "type": "string", "description": "Slack incoming webhook URL. api.slack.com/messaging/webhooks." }, "whatsappPhoneNumberId": { "title": "📞 WhatsApp Phone Number ID", "type": "string", "description": "Your WhatsApp Business phone-number ID (numeric, from Meta dashboard). Required when whatsappAccessToken is set." }, "whatsappAccessToken": { "title": "📱 WhatsApp Access Token", "type": "string", "description": "WhatsApp Cloud API permanent access token (System User token from Meta Business). Recipient must have messaged the business number within the last 24h (service-conversation window — free since Nov 2024)." }, "whatsappTo": { "title": "📲 WhatsApp Recipient", "type": "string", "description": "Recipient phone in E.164 format without + (e.g. \"436641234567\"). Recipient must have messaged your business number within last 24h." }, "webhookUrl": { "title": "🪝 Generic Webhook URL", "type": "string", "description": "Receives a JSON POST with {metadata, items} after each run. Universal escape hatch for n8n / Make / Zapier / custom backends." }, "webhookHeaders": { "title": "📋 Webhook Headers", "type": "object", "description": "Optional JSON object of custom headers (e.g. {\"Authorization\":\"Bearer ...\"})." }, "appConnector": { "title": "Send results to a connected app", "type": "string", "description": "Optional. Pick a connected app under Settings → API & Integrations to receive your results (including any contact details). Best-effort across MCP connectors as Apify expands its catalog." }, "mcpIssueTeam": { "title": "Issue tracker team", "type": "string", "description": "Only when the connected app is an issue tracker: the team (name or ID) the summary issue is created under, if that app requires one." }, "lat": { "title": "🌐 Latitude", "minimum": -90, "maximum": 90, "type": "number", "description": "Latitude of the centre point for the radius filter. Needs lon and radiusKm; without all three no radius filter applies. The search itself still runs per city; the radius then keeps only listings near this point." }, "lon": { "title": "🌐 Longitude", "minimum": -180, "maximum": 180, "type": "number", "description": "Longitude of the centre point for the radius filter. Needs lat and radiusKm." }, "radiusKm": { "title": "📏 Search Radius (km)", "minimum": 0, "maximum": 500, "type": "integer", "description": "Keep only listings within this many kilometres of the lat/lon point. Listings without coordinates cannot be placed and are left out. Needs lat and lon; empty means no radius filter." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }