{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings: Restaurants & Takeaways (FSA)", "description": "UK restaurants, cafes, takeaways, pubs, hotels and food shops from the official Food Standards Agency register: name, address, postcode, hygiene rating (0-5), inspection date, scores and GPS. Filter by type, council, rating and date; new-inspection alerts.", "version": "0.1", "x-build-id": "yedN2eCZ2AL3hr94A" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/frenchdatalab~uk-food-hygiene-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-frenchdatalab-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/frenchdatalab~uk-food-hygiene-ratings/runs": { "post": { "operationId": "runs-sync-frenchdatalab-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/frenchdatalab~uk-food-hygiene-ratings/run-sync": { "post": { "operationId": "run-sync-frenchdatalab-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", "properties": { "businessTypes": { "title": "Business types", "uniqueItems": true, "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "1", "7844", "7843", "7842", "7846", "7841", "4613", "7840", "7839", "7845", "5", "7", "14", "7838" ], "enumTitles": [ "Restaurant / cafe / canteen", "Takeaway / sandwich shop", "Pub / bar / nightclub", "Hotel / B&B / guest house", "Mobile caterer", "Other catering premises", "Retailers - other", "Supermarkets / hypermarkets", "Manufacturers / packers", "School / college / university", "Hospitals / childcare / caring premises", "Distributors / transporters", "Importers / exporters", "Farmers / growers" ] } }, "localAuthorities": { "title": "Local authorities (councils)", "type": "array", "description": "Council names, e.g. \"Westminster\", \"Manchester\", \"Leeds\", \"Edinburgh\" (partial names match all councils containing them).", "items": { "type": "string" } }, "address": { "title": "Town or postcode", "type": "string", "description": "Free text searched in the address, e.g. \"Brighton\" or \"SW1A\"." }, "businessName": { "title": "Business name contains", "type": "string", "description": "e.g. \"pizza\", \"costa\"." }, "minRating": { "title": "Minimum rating (0-5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "England, Wales and Northern Ireland ratings (Scotland uses Pass / Improvement Required)." }, "maxRating": { "title": "Maximum rating (0-5)", "minimum": 0, "maximum": 5, "type": "integer", "description": "e.g. 2 for poorly rated establishments." }, "inspectedSince": { "title": "Inspected on or after", "type": "string", "description": "YYYY-MM-DD" }, "newRatingPendingOnly": { "title": "New rating pending only", "type": "boolean", "description": "Establishments inspected recently whose new rating is not published yet.", "default": false }, "onlyNewInspectionsSinceLastRun": { "title": "Only new establishments or inspections since the last run", "type": "boolean", "description": "Monitoring: schedule the Actor (e.g. weekly) and receive only new businesses and new ratings.", "default": false }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Maximum number of establishments returned.", "default": 100 } } }, "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 } } } } } } } } } }