{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings - FSA Business Data", "description": "Search official UK food hygiene ratings by business name, area, council or business type. Export flat business records with inspection dates, scores, coordinates and source links. No source account or API key required.", "version": "0.0", "x-build-id": "h5X9p8FYTV7mXhqUx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/onescriptfix~uk-food-hygiene-ratings/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-onescriptfix-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/onescriptfix~uk-food-hygiene-ratings/runs": { "post": { "operationId": "runs-sync-onescriptfix-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/onescriptfix~uk-food-hygiene-ratings/run-sync": { "post": { "operationId": "run-sync-onescriptfix-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": { "name": { "title": "Business name", "type": "string", "description": "Name to search; clear this for all businesses in your selected area.", "default": "Pret A Manger" }, "address": { "title": "Town, address or postcode", "type": "string", "description": "Address search sent to the FSA. Clear this to search all areas.", "default": "London" }, "localAuthorityId": { "title": "Local authority ID", "minimum": 0, "maximum": 10000, "type": "integer", "description": "Optional numeric FSA API local authority ID; 0 means no filter. This is not localAuthorityCode.", "default": 0 }, "businessTypeId": { "title": "Business type ID", "minimum": 0, "maximum": 100000, "type": "integer", "description": "Optional numeric FSA business type ID; 0 means no filter. Restaurant/Cafe/Canteen is 1.", "default": 0 }, "maxItems": { "title": "Maximum results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum unique records saved and billed across this run.", "default": 20 }, "pageSize": { "title": "Source page size", "minimum": 1, "maximum": 100, "type": "integer", "description": "At most 100 source records per request; also capped by maxItems.", "default": 100 }, "maxPages": { "title": "Maximum source pages", "minimum": 1, "maximum": 500, "type": "integer", "description": "Stop after this many pages, even if filters find fewer results. Includes empty pages.", "default": 100 }, "requestDelaySeconds": { "title": "Request interval (seconds)", "minimum": 1, "maximum": 60, "type": "number", "description": "Minimum interval between all requests. A longer robots.txt delay takes precedence.", "default": 1.2 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Off by default. Optional Apify Proxy requires your Apify account configuration. Proxies never override robots.txt or access restrictions.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }