{ "openapi": "3.0.1", "info": { "title": "UK Funeral Director Directory Scraper (FuneralGuide)", "description": "Scrape funeralguide.co.uk - the UK's largest funeral director directory. Search by town, city or postcode, or fetch specific funeral home pages directly. Get address, phone, geo-coordinates, ratings, reviews, prices, services, professional associations and opening hours.", "version": "1.0", "x-build-id": "J9aKsJMBAQiezXrp0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/crawlerbros~funeralguide-uk-directory-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-crawlerbros-funeralguide-uk-directory-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~funeralguide-uk-directory-scraper/runs": { "post": { "operationId": "runs-sync-crawlerbros-funeralguide-uk-directory-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~funeralguide-uk-directory-scraper/run-sync": { "post": { "operationId": "run-sync-crawlerbros-funeralguide-uk-directory-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", "byUrl" ], "type": "string", "description": "What to fetch.", "default": "search" }, "location": { "title": "Town, city or postcode (mode=search)", "type": "string", "description": "A UK town, city, county or postcode to search near, e.g. `London`, `Manchester`, `SO45 1DD`.", "default": "" }, "sortBy": { "title": "Sort by (mode=search)", "enum": [ "relevance", "price", "distance" ], "type": "string", "description": "Order search results are fetched in.", "default": "relevance" }, "minRating": { "title": "Minimum rating", "enum": [ "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Only keep funeral directors with an average review rating at or above this value (1-5). Businesses with no reviews yet are excluded once this is set above 0.", "default": "0" }, "memberOnly": { "title": "FuneralGuide members only", "type": "boolean", "description": "Only keep funeral directors that hold a paid FuneralGuide membership listing (badge shown on the search-results page). Directors fetched via `startUrls` (mode=byUrl) always pass through, since membership status isn't shown on their own profile page.", "default": false }, "includeNearbyVenues": { "title": "Include nearby crematoriums/cemeteries (mode=search)", "type": "boolean", "description": "Also emit separate records (recordType=`committalVenue`) for the crematoriums and cemeteries FuneralGuide lists as near the searched `location`, with their own estimated fee. These don't count against `maxItems` and aren't funeral-director listings.", "default": false }, "startUrls": { "title": "Funeral director page URLs (mode=byUrl)", "type": "array", "description": "Direct funeralguide.co.uk funeral-director page URLs to scrape, e.g. `https://www.funeralguide.co.uk/funeral-directors/hampshire/southampton/new-forest-funerals`.", "default": [], "items": { "type": "string" } }, "fetchFullDetails": { "title": "Fetch full profile details", "type": "boolean", "description": "For mode=search: visit each funeral director's own profile page to also collect phone, geo-coordinates, opening hours, services offered and professional associations. Turn off for a faster run with only the search-result summary fields.", "default": true }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 500, "type": "integer", "description": "Hard cap on the number of funeral director records returned.", "default": 20 } } }, "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 } } } } } } } } } }