{ "openapi": "3.0.1", "info": { "title": "UK Food Hygiene Ratings Scraper", "description": "Export the UK's Food Hygiene Rating Scheme. 500k+ inspected food businesses across England, Wales, Scotland and Northern Ireland. Filter by name, council, business type, or rating. Pull address, hygiene/structural/management scores, geocodes, and last inspection date.", "version": "1.0", "x-build-id": "sgfWzQ36LfDDuBnyK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~fsa-uk-food-hygiene-ratings-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-fsa-uk-food-hygiene-ratings-scraper", "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/parseforge~fsa-uk-food-hygiene-ratings-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-fsa-uk-food-hygiene-ratings-scraper", "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/parseforge~fsa-uk-food-hygiene-ratings-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-fsa-uk-food-hygiene-ratings-scraper", "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": { "maxItems": { "title": "Max Items", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Free users: Limited to 10 items (preview). Paid users: Optional, max 1,000,000" }, "name": { "title": "Business Name", "type": "string", "description": "Filter by business name (free text, partial match supported by the source). Examples: 'Tesco', 'Pizza Express', 'KFC'." }, "localAuthorityId": { "title": "Local Authority", "enum": [ "any", "197", "198", "277", "48", "334", "199", "132", "133", "200", "134", "278", "77", "249", "35", "88", "89", "392", "6", "238", "78", "326", "42", "138", "90", "374", "56", "195", "196", "335", "49", "176", "63", "328", "289", "393", "7", "28", "91", "8", "336", "286", "324", "29", "92", "355", "18", "79", "229", "164", "177", "338", "394", "1", "93", "361", "250", "339", "341", "9", "136", "43", "340", "57", "10", "310", "261", "191", "192", "50", "279", "165", "95", "205", "11", "228", "333", "322", "311", "375", "280", "94", "158", "19", "131", "251", "342", "84", "55", "144", "395", "305", "252", "376", "207", "209", "126", "96", "201", "2", "296", "208", "239", "20", "64", "218", "224", "402", "362", "40", "233", "240", "210", "266", "97", "12", "267", "51", "297", "211", "241", "3", "147", "212", "343", "256", "312", "166", "121", "80", "213", "313", "242", "253", "30", "98", "268", "337", "99", "193", "100", "58", "101", "13", "102", "243", "128", "234", "244", "103", "383", "21", "52", "214", "104", "59", "281", "105", "409", "405", "4", "167", "215", "37", "284", "321", "106", "107", "31", "108", "396", "178", "109", "168", "397", "85", "235", "110", "363", "65", "140", "179", "44", "254", "14", "356", "180", "81", "295", "60", "344", "111", "135", "298", "38", "282", "142", "401", "220", "285", "269", "345", "221", "346", "245", "82", "122", "364", "112", "347", "145", "202", "299", "53", "404", "22", "66", "216", "403", "32", "70", "327", "123", "369", "61", "385", "127", "33", "87", "370", "62", "181", "222", "262", "348", "169", "223", "45", "331", "287", "349", "170", "291", "113", "129", "357", "270", "225", "350", "171", "114", "408", "182", "15", "172", "236", "398", "371", "271", "83", "246", "86", "184", "377", "204", "185", "255", "399", "226", "381", "292", "378", "316", "203", "5", "54", "325", "300", "67", "68", "217", "34", "263", "173", "365", "124", "288", "46", "115", "272", "23", "183", "366", "367", "24", "227", "186", "130", "382", "372", "314", "125", "273", "116", "257", "351", "330", "187", "368", "274", "301", "384", "16", "247", "315", "258", "25", "47", "259", "332", "352", "302", "117", "188", "260", "17", "353", "264", "400", "379", "118", "119", "194", "373", "26", "275", "237", "27", "290", "303", "206", "174", "69", "219", "71", "265", "36", "120", "159", "189", "323", "248", "293", "190", "276", "294", "380", "358", "283", "354", "359", "175", "360", "406" ], "type": "string", "description": "Filter by issuing local authority (council). Pick 'any' to scan without an authority filter — note the source requires at least one filter so use this with a business name or business type." }, "businessTypeId": { "title": "Business Type", "enum": [ "any", "7", "7838", "5", "7842", "14", "7839", "7846", "7841", "7843", "1", "4613", "7840", "7845", "7844" ], "type": "string", "description": "Filter by business category." }, "ratingKey": { "title": "Hygiene Rating", "enum": [ "any", "fhrs_0_en-gb", "fhrs_1_en-gb", "fhrs_2_en-gb", "fhrs_3_en-gb", "fhrs_4_en-gb", "fhrs_5_en-gb", "fhrs_awaitinginspection_en-gb", "fhrs_exempt_en-gb", "fhis_pass_en-gb", "fhis_improvementrequired_en-gb", "fhis_awaitinginspection_en-gb", "fhis_exempt_en-gb" ], "type": "string", "description": "Filter by hygiene rating. England, Wales & Northern Ireland use 0-5. Scotland uses Pass / Improvement Required / Awaiting Inspection / Exempt." } } }, "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 } } }, "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 } } } } } } } } } }