{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings & New Restaurant Leads", "description": "Every UK food business with its official FSA hygiene rating: restaurants, takeaways, pubs, cafés, hotels and shops in any council, postcode or town. Find new food businesses awaiting their first inspection, filter by rating and type, and get only new or re-rated ones on a schedule. No login.", "version": "1.0", "x-build-id": "m1pDt4k8LPF8dS6Fc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/digital_influx~uk-food-hygiene-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-digital_influx-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/digital_influx~uk-food-hygiene-ratings/runs": { "post": { "operationId": "runs-sync-digital_influx-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/digital_influx~uk-food-hygiene-ratings/run-sync": { "post": { "operationId": "run-sync-digital_influx-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": { "localAuthorities": { "title": "Local authorities (councils)", "type": "array", "description": "Councils whose food businesses to read, e.g. Manchester, Westminster, Birmingham, Edinburgh, Cardiff, Belfast. The FSA lists 363 across England, Wales, Scotland and Northern Ireland.", "items": { "type": "string" } }, "places": { "title": "Postcodes or places", "type": "array", "description": "Searched in the business address: a postcode (M1 1AE), an outward code (SW1A, M4) or a place name (Soho, Shoreditch). Can be combined with councils.", "items": { "type": "string" } }, "businessNames": { "title": "Business names", "type": "array", "description": "Keep businesses whose name contains one of these, e.g. Greggs, Nando's. Without councils or places, the name is searched across the whole UK.", "items": { "type": "string" } }, "businessTypes": { "title": "Business types", "type": "array", "description": "Keep only these types, as the council recorded them. Empty = all types.", "items": { "type": "string", "enum": [ "restaurant-cafe", "takeaway", "pub-bar", "hotel", "mobile-caterer", "other-catering", "supermarket", "retailer-other", "school", "care", "manufacturer", "distributor", "importer-exporter", "farmer" ], "enumTitles": [ "Restaurant / cafe / canteen", "Takeaway / sandwich shop", "Pub / bar / nightclub", "Hotel / B&B / guest house", "Mobile caterer", "Other catering premises", "Supermarket / hypermarket", "Other retailer", "School / college / university", "Hospital / childcare / care home", "Manufacturer / packer", "Distributor / transporter", "Importer / exporter", "Farmer / grower" ] } }, "onlyAwaitingInspection": { "title": "Only new businesses awaiting their first inspection", "type": "boolean", "description": "Food businesses that registered with the council and have not been rated yet: mostly new openings and new owners. A shortcut for the rating \"Awaiting inspection\".", "default": false }, "ratings": { "title": "Hygiene ratings", "type": "array", "description": "Keep only these ratings. England, Wales and Northern Ireland rate 0 to 5; Scotland rates Pass or Improvement Required. Empty = all.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1", "0", "pass", "pass-and-eat-safe", "improvement-required", "awaiting-inspection", "awaiting-publication", "exempt" ], "enumTitles": [ "5 - Very good", "4 - Good", "3 - Generally satisfactory", "2 - Improvement necessary", "1 - Major improvement necessary", "0 - Urgent improvement necessary", "Pass (Scotland)", "Pass and Eat Safe (Scotland)", "Improvement Required (Scotland)", "Awaiting inspection (new)", "Awaiting publication", "Exempt" ] } }, "ratedWithinDays": { "title": "Rated within (days)", "minimum": 1, "type": "integer", "description": "Keep only businesses whose rating was given in the last N days: recent inspections." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Newest first: businesses awaiting inspection, then the latest ratings. You also never pay more than the spending limit you set for the run.", "default": 1000 }, "onlyNew": { "title": "Only new or re-rated businesses (for scheduled runs)", "type": "boolean", "description": "Save only businesses that earlier runs of this same search did not save, or whose rating changed since (each row says which). Schedule it weekly to get the new food businesses of an area. The memory is kept for 400 days in a key-value store named \"uk-food-hygiene-ratings-state\" in your account.", "default": false }, "memoryName": { "title": "Memory name (optional)", "type": "string", "description": "By default each search has its own memory. Give a name to share one memory between tasks, or a new name to start over. Letters, digits, dot, dash and underscore." } } }, "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 } } } } } } } } } }