{ "openapi": "3.0.1", "info": { "title": "Chicago Building Violations Scraper", "description": "Query the official City of Chicago Building Violations dataset by address, status, violation code, inspection, date range, or advanced SoQL filters. Returns one normalized record per building violation.", "version": "1.0", "x-build-id": "RGStw9cWmCAHvVJeQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~chicago-building-violations-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-chicago-building-violations-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/muhammadafzal~chicago-building-violations-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-chicago-building-violations-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/muhammadafzal~chicago-building-violations-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-chicago-building-violations-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": { "address": { "title": "Address Contains", "type": "string", "description": "Return violations whose Chicago address contains this text, for example \"121 N LA SALLE\". Matching is case-insensitive.", "default": "" }, "propertyGroup": { "title": "Property Group", "type": "string", "description": "Exact Chicago Property Group identifier.", "default": "" }, "violationStatus": { "title": "Violation Status", "enum": [ "OPEN", "COMPLIED", "NO ENTRY" ], "type": "string", "description": "Filter by current violation status. OPEN is prefilled for a useful default query.", "default": "OPEN" }, "violationCode": { "title": "Violation Code", "type": "string", "description": "Exact Department of Buildings violation code, such as CN138106.", "default": "" }, "inspectionNumber": { "title": "Inspection Number", "type": "string", "description": "Exact Chicago building inspection number.", "default": "" }, "inspectionCategory": { "title": "Inspection Category", "enum": [ "", "COMPLAINT", "PERIODIC", "PERMIT", "REGISTRATION" ], "type": "string", "description": "Filter by COMPLAINT, PERIODIC, PERMIT, or REGISTRATION. Leave blank to include all categories.", "default": "" }, "violationDateFrom": { "title": "Violation Date From", "type": "string", "description": "Inclusive start date in YYYY-MM-DD format.", "default": "" }, "violationDateTo": { "title": "Violation Date To", "type": "string", "description": "Inclusive end date in YYYY-MM-DD format.", "default": "" }, "where": { "title": "Advanced SoQL Where", "type": "string", "description": "Optional advanced Socrata $where expression using official field names. Do not include $where=.", "default": "" }, "order": { "title": "Sort Order", "enum": [ "newest", "oldest" ], "type": "string", "description": "Sort by newest or oldest violation date.", "default": "newest" }, "maxResults": { "title": "Maximum Results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of violation records to return.", "default": 100 }, "pageSize": { "title": "Page Size", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Number of records requested per Socrata API page.", "default": 500 } } }, "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 } } } } } } } } } }