{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings (FSA) Search", "description": "Search every UK food business rated by the Food Standards Agency by name, postcode radius, council, business type or rating. Find newly opened businesses awaiting inspection. Official FSA API, flat output.", "version": "1.0", "x-build-id": "xtW96wrYZ8eEAFSq3" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/onibaku~uk-food-hygiene-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-onibaku-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/onibaku~uk-food-hygiene-ratings/runs": { "post": { "operationId": "runs-sync-onibaku-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/onibaku~uk-food-hygiene-ratings/run-sync": { "post": { "operationId": "run-sync-onibaku-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": { "businessName": { "title": "Business name", "type": "string", "description": "Part of a business name, e.g. \"Greggs\" or \"pizza\"." }, "postcode": { "title": "Near this postcode", "type": "string", "description": "Finds businesses within the radius below, nearest first." }, "radiusMiles": { "title": "Radius (miles)", "minimum": 0.1, "maximum": 25, "type": "number", "description": "Used with the postcode. 0.1 to 25.", "default": 1 }, "address": { "title": "Address contains", "type": "string", "description": "Text that appears in the address, e.g. a street or town." }, "localAuthorities": { "title": "Local authorities", "type": "array", "description": "Council names, e.g. \"Leeds\" or \"Westminster\". Leave empty for all of the UK.", "items": { "type": "string" } }, "businessTypes": { "title": "Business types", "type": "array", "description": "Leave empty for all types.", "items": { "type": "string", "enum": [ "Distributors/Transporters", "Farmers/growers", "Hospitals/Childcare/Caring Premises", "Hotel/bed & breakfast/guest house", "Importers/Exporters", "Manufacturers/packers", "Mobile caterer", "Other catering premises", "Pub/bar/nightclub", "Restaurant/Cafe/Canteen", "Retailers - other", "Retailers - supermarkets/hypermarkets", "School/college/university", "Takeaway/sandwich shop" ] } }, "ratings": { "title": "Ratings", "type": "array", "description": "Only return these ratings. Pick \"Awaiting inspection\" to find newly opened food businesses.", "items": { "type": "string", "enum": [ "5", "4", "3", "2", "1", "0", "AwaitingInspection", "AwaitingPublication", "Exempt", "Pass", "ImprovementRequired" ], "enumTitles": [ "5 – Very good", "4 – Good", "3 – Generally satisfactory", "2 – Improvement necessary", "1 – Major improvement necessary", "0 – Urgent improvement necessary", "Awaiting inspection (often newly opened)", "Awaiting publication", "Exempt", "Pass (Scotland)", "Improvement required (Scotland)" ] } }, "ratedSince": { "title": "Rated on or after", "type": "string", "description": "Only businesses inspected on or after this date (YYYY-MM-DD)." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many establishments.", "default": 1000 } } }, "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 } } } } } } } } } }