{ "openapi": "3.0.1", "info": { "title": "Chicago Business Licenses - Full History & Active", "description": "Chicago business licenses (public open data, 1.2M records, full history since 2002): every license event with licensee and DBA, address / ward / community area, class, business activity and the application-to-expiration lifecycle. Filter by class/status/name/ward/date or pull the live slice.", "version": "0.0", "x-build-id": "gP3rjfTS2AR5bxOVx" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~chicago-business-licenses/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-chicago-business-licenses", "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/j0401~chicago-business-licenses/runs": { "post": { "operationId": "runs-sync-j0401-chicago-business-licenses", "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/j0401~chicago-business-licenses/run-sync": { "post": { "operationId": "run-sync-j0401-chicago-business-licenses", "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": { "mode": { "title": "Mode", "enum": [ "rows", "active", "recent", "aggregate" ], "type": "string", "description": "rows = license rows matching your filters, most recent first (the default; includes past terms). active = only licenses live right now (status AAI/AAC with a future expiration). recent = issued in the last 30 days. aggregate = one count row per group (see groupBy).", "default": "rows" }, "licenseClass": { "title": "License class", "type": "string", "description": "The license class (fuzzy), e.g. 'Retail Food Establishment', 'Tavern', 'Package Goods', 'Peddler', 'Valet Parking', 'Tobacco', 'Limited Business'. Blank = every class.", "default": "" }, "status": { "title": "Status", "type": "string", "description": "Exact code: AAI (active), AAC (active, cancellation pending), REV (revoked), REA, INQ. Blank = any. Note the live split also needs the expiration date - use mode=active.", "default": "" }, "applicationType": { "title": "Application type", "type": "string", "description": "Exact: RENEW, ISSUE, C_LOC (location change), C_EXPA, C_SBA, C_CAPA. Blank = any.", "default": "" }, "licenseNumber": { "title": "License number", "type": "string", "description": "Exact license number - all events for that license.", "default": "" }, "name": { "title": "Business name", "type": "string", "description": "Fuzzy match on the legal name or the DBA name, e.g. 'PETSMART' or 'TAVERN'.", "default": "" }, "address": { "title": "Address", "type": "string", "description": "Street address (fuzzy), e.g. 'WACKER'.", "default": "" }, "ward": { "title": "Ward", "type": "string", "description": "Chicago ward number, exact (e.g. 42).", "default": "" }, "communityArea": { "title": "Community area", "type": "string", "description": "Community-area name (fuzzy), e.g. 'LOOP' or 'LAKE VIEW'.", "default": "" }, "issuedFrom": { "title": "Issued on or after", "type": "string", "description": "Only licenses issued on/after this date (YYYY-MM-DD).", "default": "" }, "issuedTo": { "title": "Issued before", "type": "string", "description": "Only licenses issued before this date. ISO date, YYYY-MM-DD (e.g. 2026-01-01).", "default": "" }, "expiresFrom": { "title": "Expires on or after", "type": "string", "description": "Only licenses expiring on/after this date - e.g. a renewal pipeline.", "default": "" }, "expiresTo": { "title": "Expires before", "type": "string", "description": "Only licenses expiring before this date. ISO date, YYYY-MM-DD (e.g. 2026-01-01).", "default": "" }, "groupBy": { "title": "Aggregate by", "enum": [ "licenseClass", "status", "applicationType", "ward", "communityArea", "issueYear" ], "type": "string", "description": "Which dimension to aggregate over. licenseClass -> the business mix; ward / communityArea -> where licensing clusters; applicationType -> new vs renewal; issueYear -> the pipeline over time.", "default": "licenseClass" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed (0 = up to ~10k per run; each record is metered individually, so there is no per-run charge cap). An aggregate has at most a few hundred groups.", "default": 50 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }