{ "openapi": "3.0.1", "info": { "title": "US Restaurant Inspections Scraper", "description": "Restaurant & food health-inspection results from major US city open-data portals (NYC, Chicago, SF, Seattle, Austin). No key.", "version": "0.1", "x-build-id": "QtX8mM6yWT6SU9dVO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/straightforward_hydra~us-restaurant-inspections-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-straightforward_hydra-us-restaurant-inspections-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/straightforward_hydra~us-restaurant-inspections-scraper/runs": { "post": { "operationId": "runs-sync-straightforward_hydra-us-restaurant-inspections-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/straightforward_hydra~us-restaurant-inspections-scraper/run-sync": { "post": { "operationId": "run-sync-straightforward_hydra-us-restaurant-inspections-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": { "cities": { "title": "Cities", "type": "array", "description": "Which cities to pull inspections from. Leave empty for all supported cities.", "items": { "type": "string", "enum": [ "nyc", "chicago", "sf", "king", "austin" ], "enumTitles": [ "New York City (NY)", "Chicago (IL)", "San Francisco (CA)", "King County / Seattle (WA)", "Austin (TX)" ] }, "default": [ "nyc", "chicago", "sf", "king", "austin" ] }, "nameContains": { "title": "Business name contains", "type": "string", "description": "Filter by restaurant name, e.g. \"pizza\", \"starbucks\", \"taco\"." }, "keyword": { "title": "Keyword (full-text)", "type": "string", "description": "Full-text search across all columns, e.g. \"roach\", \"rodent\", \"vermin\", \"mice\". Works on every city — great for finding violations." }, "resultContains": { "title": "Result contains", "type": "string", "description": "Filter by inspection result/action text, e.g. \"fail\", \"closed\", \"unsatisfactory\". Applied where the city exposes a result column." }, "locality": { "title": "Borough / city", "type": "string", "description": "Filter by borough or locality, e.g. \"Brooklyn\", \"Chicago\". Applied where the city exposes a locality column." }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Restrict to these ZIP codes, e.g. [\"11231\", \"60602\"].", "items": { "type": "string" } }, "minScore": { "title": "Min score", "type": "integer", "description": "Minimum inspection score. NOTE: score meaning differs by city — NYC & Seattle: HIGHER = worse (violation points); SF & Austin: HIGHER = better (100 = perfect). Chicago has no numeric score." }, "maxScore": { "title": "Max score", "type": "integer", "description": "Maximum inspection score. See the score-meaning note on Min score." }, "inspectedAfter": { "title": "Inspected after", "type": "string", "description": "Only inspections on/after this date (YYYY-MM-DD). Set to recent dates for fresh results." }, "inspectedBefore": { "title": "Inspected before", "type": "string", "description": "Only inspections on/before this date (YYYY-MM-DD)." }, "maxResultsPerCity": { "title": "Max results per city", "minimum": 1, "maximum": 50000, "type": "integer", "description": "How many inspection records to fetch per selected city (newest first).", "default": 200 }, "includeRaw": { "title": "Include raw record", "type": "boolean", "description": "Add the full original city record under a \"raw\" field alongside the normalized fields.", "default": false }, "appToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional free Socrata app token (dev.socrata.com) to raise rate limits. Not required for normal runs." } } }, "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 } } } } } } } } } }