{ "openapi": "3.0.1", "info": { "title": "Food Safety Inspection Scanner — Restaurant Health Inspections", "description": "Extract restaurant food-safety and health-inspection records from public government open-data portals. Ships with NYC DOHMH (updated daily); works with any Socrata open-data city by configuration. Normalized JSON, filters for borough, cuisine, grade, critical violations, and recency.", "version": "0.3", "x-build-id": "dq5nqrSQgea3RmEm8" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/mibedk~food-inspection-scanner/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-mibedk-food-inspection-scanner", "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/mibedk~food-inspection-scanner/runs": { "post": { "operationId": "runs-sync-mibedk-food-inspection-scanner", "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/mibedk~food-inspection-scanner/run-sync": { "post": { "operationId": "run-sync-mibedk-food-inspection-scanner", "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": { "socrata_domain": { "title": "Socrata domain", "type": "string", "description": "Open-data portal domain (default: data.cityofnewyork.us for NYC). Change to any Socrata city portal, e.g. data.cityofchicago.org.", "default": "data.cityofnewyork.us" }, "dataset_id": { "title": "Socrata dataset ID", "type": "string", "description": "Socrata dataset identifier (default: 43nn-pn8j = NYC DOHMH Restaurant Inspection Results).", "default": "43nn-pn8j" }, "boro": { "title": "Borough", "enum": [ "Any", "Manhattan", "Brooklyn", "Queens", "Bronx", "Staten Island" ], "type": "string", "description": "Filter by NYC borough (Any = no filter). Ignored for non-NYC datasets.", "default": "Any" }, "cuisine": { "title": "Cuisine keyword", "type": "string", "description": "Case-insensitive keyword matched against the cuisine description, e.g. 'Pizza', 'Chinese', 'Bakery'. Empty = no filter." }, "zipcode": { "title": "ZIP code", "type": "string", "description": "Filter by exact ZIP code. Empty = no filter." }, "grade": { "title": "Inspection grade", "enum": [ "Any", "A", "B", "C" ], "type": "string", "description": "Filter by letter grade (Any = no filter). Only inspections that received a grade match.", "default": "Any" }, "critical_only": { "title": "Critical violations only", "type": "boolean", "description": "If true, return only violation rows flagged as Critical.", "default": false }, "days_back": { "title": "Days back", "minimum": 1, "maximum": 3650, "type": "integer", "description": "Only include inspections from the last N days (default: 30).", "default": 30 }, "max_items": { "title": "Maximum items", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of records to return (default: 100, hard cap: 5000).", "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 } } }, "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 } } } } } } } } } }