{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings - 614K Establishments (FSA)", "description": "Every food establishment on the FSA register across the UK: name, address, postcode, local authority, business type, inspection date, hygiene/structural/management scores and the published rating. Search by name, council, postcode, rating or business type; aggregate ratings.", "version": "0.0", "x-build-id": "tfY14QsgtOyMyYTJ1" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~uk-food-hygiene/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-uk-food-hygiene", "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/j0401~uk-food-hygiene/runs": { "post": { "operationId": "runs-sync-j0401-uk-food-hygiene", "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/j0401~uk-food-hygiene/run-sync": { "post": { "operationId": "run-sync-j0401-uk-food-hygiene", "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": { "mode": { "title": "Mode", "enum": [ "", "search", "aggregate", "warm" ], "type": "string", "description": "search = filter the register. aggregate = one row per group. warm = owner maintenance: rebuild the snapshot from the FSA source and upload it (no filters). Leave blank to auto-route: filters -> search, no filters -> aggregate." }, "name": { "title": "Business name", "type": "string", "description": "Business name substring, case-insensitive (e.g. \"Tesco\")." }, "address": { "title": "Address", "type": "string", "description": "Address substring, case-insensitive." }, "postcode": { "title": "Postcode", "type": "string", "description": "Postcode or prefix; spaces are ignored (e.g. \"SW1A\" or \"SW1A 1AA\")." }, "localAuthority": { "title": "Local authority", "type": "string", "description": "Exact council name, case-insensitive (e.g. \"Westminster\")." }, "businessType": { "title": "Business type", "type": "string", "description": "Exact category, e.g. \"Restaurant/Cafe/Canteen\", \"Takeaway/sandwich shop\", \"Retailers - other\"." }, "rating": { "title": "Rating", "type": "string", "description": "Exact rating: 0-5, Awaiting Inspection, Awaiting Publication, Pass, Pass and Eat Safe, Improvement Required or Exempt." }, "scheme": { "title": "Scheme", "enum": [ "", "FHRS", "FHIS" ], "type": "string", "description": "FHRS = England, Wales and NI; FHIS = Scotland." }, "ratingFrom": { "title": "Rating from", "minimum": 0, "maximum": 5, "type": "integer", "description": "Inclusive lower bound on numeric ratings 0-5. Rows with a non-numeric rating are excluded when a range is set." }, "ratingTo": { "title": "Rating to", "minimum": 0, "maximum": 5, "type": "integer", "description": "Inclusive upper bound on numeric ratings 0-5." }, "groupBy": { "title": "Aggregate by", "enum": [ "", "rating", "localAuthority", "businessType", "scheme", "postcodeArea" ], "type": "string", "description": "rating -> the published rating; localAuthority -> the 363 councils; businessType -> category; scheme -> FHRS vs FHIS; postcodeArea -> postal area. Blank defaults to rating." }, "maxResults": { "title": "Max records", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap the number of search records pushed (0 = the default 50, maximum 5000). Aggregate returns every group.", "default": 50 } } }, "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 } } } } } } } } } }