{ "openapi": "3.0.1", "info": { "title": "UK New Food Businesses (FSA Hygiene Ratings)", "description": "New UK food businesses awaiting first inspection (default) or recently rated, from the official FSA Food Hygiene Rating Scheme, by local authority or postcode radius.", "version": "0.1", "x-build-id": "PCdyWvDI39NeToUpj" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/secondshift-data~uk-new-food-businesses-fsa/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-secondshift-data-uk-new-food-businesses-fsa", "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/secondshift-data~uk-new-food-businesses-fsa/runs": { "post": { "operationId": "runs-sync-secondshift-data-uk-new-food-businesses-fsa", "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/secondshift-data~uk-new-food-businesses-fsa/run-sync": { "post": { "operationId": "run-sync-secondshift-data-uk-new-food-businesses-fsa", "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", "type": "array", "description": "Local authority names (e.g. \"Cambridge City\") or numeric FSA IDs (e.g. 1). Names are matched case-insensitively against the FSA list; an exact match is preferred, otherwise a unique partial match. Leave empty if using postcode + radius.", "items": { "type": "string" } }, "postcode": { "title": "Postcode (centre of search)", "type": "string", "description": "UK postcode, e.g. \"CB1 3NF\". Used with 'Radius'. Geocoded via postcodes.io." }, "radiusMiles": { "title": "Radius (miles)", "minimum": 1, "maximum": 100, "type": "integer", "description": "Search radius around the postcode.", "default": 5 }, "daysBack": { "title": "Rated in the last N days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Applies to rated businesses only (modes 'Recently rated' and 'Both'). Ignored for awaiting-inspection businesses, which have no rating date.", "default": 30 }, "businessTypes": { "title": "Business types (optional)", "type": "array", "description": "Restrict to these FSA business types. Empty = all types.", "items": { "type": "string", "enum": [ "Restaurant/Cafe/Canteen", "Takeaway/sandwich shop", "Pub/bar/nightclub", "Hotel/bed & breakfast/guest house", "Importers/Exporters", "Retailers - other", "Retailers - supermarkets/hypermarkets", "Manufacturers/packers", "Distributors/Transporters", "Hospitals/Childcare/Caring Premises", "School/college/university", "Mobile caterer", "Farmers/growers", "Other catering premises" ] } }, "resultMode": { "title": "What to return", "enum": [ "awaitingInspection", "recentlyRated", "both" ], "type": "string", "description": "'Awaiting first inspection' = registered with the council but not yet rated: the genuinely new businesses. These have no real rating date, so 'Rated in the last N days' does NOT apply to them; all current awaiting-inspection businesses in the area are returned. 'Recently rated' returns businesses whose latest rating date is within N days (may include re-inspected older businesses).", "default": "awaitingInspection" }, "includeAwaitingInspection": { "title": "Include awaiting inspection (deprecated)", "type": "boolean", "description": "Deprecated: use 'What to return' (resultMode). true = 'both', false = 'recentlyRated'. Ignored if resultMode is set." }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum businesses to return (you are charged per business returned).", "default": 100 } } }, "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 } } } } } } } } } }