{ "openapi": "3.0.1", "info": { "title": "Chicago Building Permits & Contractor Leads Scraper", "description": "🏗️ Find newly issued Chicago permits and export official project, fee, property, owner, applicant, designer, and contractor details for leads and analysis.", "version": "0.1", "x-build-id": "Yk4kULwiB0IqOYOym" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/automation-lab~chicago-building-permits-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-automation-lab-chicago-building-permits-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/automation-lab~chicago-building-permits-scraper/runs": { "post": { "operationId": "runs-sync-automation-lab-chicago-building-permits-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/automation-lab~chicago-building-permits-scraper/run-sync": { "post": { "operationId": "run-sync-automation-lab-chicago-building-permits-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": { "permitNumber": { "title": "Permit number", "type": "string", "description": "Look up one exact Chicago permit number, for example B200477271. When set, date filters are ignored." }, "startDate": { "title": "Issued on or after", "type": "string", "description": "Include permits issued on or after this date (YYYY-MM-DD). If both dates are empty, the Actor searches the last 30 days." }, "endDate": { "title": "Issued on or before", "type": "string", "description": "Include permits issued on or before this date (YYYY-MM-DD)." }, "permitStatus": { "title": "Permit statuses", "type": "array", "description": "Keep exact official statuses, such as ACTIVE or INACTIVE. Leave empty for all statuses.", "items": { "type": "string" } }, "permitType": { "title": "Permit types", "type": "array", "description": "Keep exact official permit types, such as PERMIT – EXPRESS PERMIT PROGRAM.", "items": { "type": "string" } }, "workType": { "title": "Work types", "type": "array", "description": "Keep exact official work types, such as Small-Scale Solar PV System.", "items": { "type": "string" } }, "reviewType": { "title": "Review types", "type": "array", "description": "Keep exact official review types, such as EXPRESS PERMIT PROGRAM.", "items": { "type": "string" } }, "ward": { "title": "Wards", "type": "array", "description": "Keep Chicago ward numbers as strings, for example 21.", "items": { "type": "string" } }, "communityArea": { "title": "Community areas", "type": "array", "description": "Keep official Chicago community area numbers, for example 73.", "items": { "type": "string" } }, "addressText": { "title": "Address contains", "type": "string", "description": "Find permits whose street address contains this text, for example MARSHFIELD." }, "contactZip": { "title": "Contact ZIP codes", "type": "array", "description": "Keep permits where any owner, applicant, designer, or contractor contact has one of these ZIP codes.", "items": { "type": "string" } }, "contactName": { "title": "Contact or contractor name contains", "type": "string", "description": "Search all owner, applicant, design-professional, and contractor name slots case-insensitively." }, "minReportedCost": { "title": "Minimum reported project cost", "minimum": 0, "type": "number", "description": "Keep permits with a reported project cost at or above this USD amount." }, "maxReportedCost": { "title": "Maximum reported project cost", "minimum": 0, "type": "number", "description": "Keep permits with a reported project cost at or below this USD amount." }, "maxItems": { "title": "Maximum permits", "minimum": 1, "maximum": 50000, "type": "integer", "description": "Stop after saving this many permit records. Use a small value for a quick first run.", "default": 20 } } }, "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 } } } } } } } } } }