{ "openapi": "3.0.1", "info": { "title": "Hotfrog India Scraper", "description": "Scrape Hotfrog India's local-business directory. Search by city + category/keyword, or fetch full details for known business URLs. Get name, address, phone, website, and description for restaurants, doctors, plumbers, salons, and any other business category across India.", "version": "1.0", "x-build-id": "46HWV6XMyTeUDB1bq" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~hotfrog-india-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-hotfrog-india-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~hotfrog-india-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-hotfrog-india-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~hotfrog-india-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-hotfrog-india-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", "byUrls" ], "type": "string", "description": "What to fetch.", "default": "search" }, "city": { "title": "City (mode=search, optional)", "type": "string", "description": "Indian city or town name, e.g. `Mumbai`, `Delhi`, `Bangalore`, `Pune`, `Chennai`. Leave blank to search nationwide across all of India instead of one city (requires `query` in that case).", "default": "Mumbai" }, "query": { "title": "Category / keyword (mode=search, optional)", "type": "string", "description": "Business category or free-text keyword, e.g. `restaurants`, `plumbers`, `dentists`, `wedding photographers`. Leave blank (with `city` set) to browse every category of business in that city instead of one category. At least one of `city`/`query` must be set.", "default": "restaurants" }, "businessUrls": { "title": "Business URLs (mode=byUrls)", "type": "array", "description": "Full Hotfrog India business/company detail page URLs (e.g. `https://www.hotfrog.in/company////`).", "default": [], "items": { "type": "string" } }, "fetchFullDetails": { "title": "Fetch full details per listing (mode=search)", "type": "boolean", "description": "For each search result, also visit its detail page to add `website` and a longer `description`. Slower (one extra request per listing) but richer output.", "default": false }, "keywordFilter": { "title": "Keyword filter", "type": "string", "description": "Only keep businesses whose name, description, or address contains this text (case-insensitive)." }, "requireWebsite": { "title": "Require website", "type": "boolean", "description": "Only keep businesses that have a website URL populated. Only effective with `fetchFullDetails` enabled or mode=byUrls.", "default": false }, "requirePhone": { "title": "Require phone", "type": "boolean", "description": "Only keep businesses with a listed phone number.", "default": false }, "requireVerified": { "title": "Require verified listing", "type": "boolean", "description": "Only keep businesses showing Hotfrog's \"Verified on Hotfrog\" badge. Only effective with `fetchFullDetails` enabled or mode=byUrls (verification status is only shown on the detail page, not search results).", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on emitted records.", "default": 30 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Hotfrog India rate-limits Apify's shared datacenter IP range, so Apify Proxy is enabled by default for reliability. You may turn it off, in which case requests go direct and simply retry with backoff.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }