{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings", "description": "Official FSA food hygiene ratings for every UK food business. Search by council, postcode, business type or rating, and isolate businesses rated 2 or below.", "version": "0.1", "x-build-id": "hoJUqz0WarIiiWdMb" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/spookyweb~uk-food-hygiene-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-spookyweb-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/spookyweb~uk-food-hygiene-ratings/runs": { "post": { "operationId": "runs-sync-spookyweb-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/spookyweb~uk-food-hygiene-ratings/run-sync": { "post": { "operationId": "run-sync-spookyweb-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": { "localAuthorityId": { "title": "Local authority ID", "type": "integer", "description": "Numeric FSA local authority id, for example 1 for Cambridge City or 27 for Welwyn Hatfield. See https://api.ratings.food.gov.uk/Authorities for the full list." }, "postcodeOrAddress": { "title": "Postcode or address", "type": "string", "description": "Free text address or postcode search, for example CB1 or Cambridge." }, "latitude": { "title": "Latitude", "type": "string", "description": "Latitude for a radius search. Use with longitude and radius." }, "longitude": { "title": "Longitude", "type": "string", "description": "Longitude for a radius search. Use with latitude and radius." }, "radiusMiles": { "title": "Radius in miles", "minimum": 1, "maximum": 30, "type": "integer", "description": "Search radius around the given coordinates.", "default": 1 }, "name": { "title": "Business name contains", "type": "string", "description": "Search by business name, for example greggs." }, "businessTypeId": { "title": "Business type ID", "type": "integer", "description": "Numeric FSA business type id, for example 1 for Restaurant, Cafe or Canteen. See https://api.ratings.food.gov.uk/BusinessTypes for the list." }, "ratingValue": { "title": "Rating", "enum": [ "", "0", "1", "2", "3", "4", "5" ], "type": "string", "description": "Only return businesses with this exact rating, 0 to 5. Applies to the England, Wales and Northern Ireland scheme.", "default": "" }, "actionableOnly": { "title": "Only businesses rated 2 or below", "type": "boolean", "description": "Keep only businesses that have been told to improve. These are the ones actively in the market for hygiene consultancy, training, pest control or equipment.", "default": false }, "sortBy": { "title": "Sort order", "enum": [ "rating", "alpha", "distance" ], "type": "string", "description": "How the FSA should order results before paging.", "default": "rating" }, "maxResults": { "title": "Max establishments", "minimum": 1, "maximum": 20000, "type": "integer", "description": "Hard cap on results. Each establishment is one billable result.", "default": 500 }, "pageSize": { "title": "Page size", "minimum": 10, "maximum": 500, "type": "integer", "description": "Records per API call. Leave as default unless you have a reason.", "default": 200 } } }, "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 } } } } } } } } } }