{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings Scraper: FSA & New Restaurant Leads", "description": "UK food hygiene ratings scraper using the official FSA ratings API: search restaurants, takeaways and shops by council, postcode or rating, with new business leads and rating change alerts. Export CSV or JSON. By RawTrader | UK Industry & Bills", "version": "0.1", "x-build-id": "e7ucCDNNUqhTCJaLI" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/seaf999ield~uk-food-hygiene-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-seaf999ield-uk-food-hygiene-ratings", "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/seaf999ield~uk-food-hygiene-ratings/runs": { "post": { "operationId": "runs-sync-seaf999ield-uk-food-hygiene-ratings", "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/seaf999ield~uk-food-hygiene-ratings/run-sync": { "post": { "operationId": "run-sync-seaf999ield-uk-food-hygiene-ratings", "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", "new_businesses", "rating_changes" ], "type": "string", "description": "new_businesses and rating_changes keep a snapshot in a named key-value store per monitor; the first run saves a baseline.", "default": "search" }, "localAuthorities": { "title": "Local authorities", "type": "array", "description": "Council names (e.g. 'Westminster', 'Manchester', 'Bristol') or FSA LocalAuthorityId numbers.", "items": { "type": "string" } }, "postcode": { "title": "Postcode", "type": "string", "description": "Centre of a radius search, e.g. 'SW1A 1AA' (geocoded with postcodes.io)." }, "radiusMiles": { "title": "Radius (miles)", "minimum": 0.1, "maximum": 50, "type": "number", "description": "Radius around the postcode.", "default": 1 }, "businessTypes": { "title": "Business types", "type": "array", "description": "e.g. restaurant, takeaway, pub, hotel, mobile caterer, other catering, supermarket, retailer, school, hospital, manufacturer. Leave empty for all.", "items": { "type": "string" } }, "name": { "title": "Business name contains", "type": "string", "description": "Name search, e.g. 'pizza'." }, "minRating": { "title": "Minimum rating (0-5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "FHRS numeric rating filter (England, Wales, NI). Excludes non-numeric ratings." }, "maxRating": { "title": "Maximum rating (0-5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "e.g. 2 to find poorly rated premises." }, "awaitingOnly": { "title": "Only 'awaiting inspection'", "type": "boolean", "description": "Only establishments awaiting their first inspection (usually new businesses).", "default": false }, "fhrsIds": { "title": "Watched FHRS IDs", "type": "array", "description": "rating_changes: FHRSID numbers to watch. If empty, the scope above (councils / postcode / types) is watched.", "items": { "type": "string" } }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Separate saved snapshot per name.", "default": "default" }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Maximum records per run. 0 = no limit.", "default": 0 } } }, "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 } } } } } } } } } }