{ "openapi": "3.0.1", "info": { "title": "Chicago & Cook County Contractor License Lookup & Leads Scraper", "description": "Contractors licensed by the City of Chicago Department of Buildings, registered with the Cook County Department of Building and Zoning (52 specialities) and with the City of Evanston (25 trades), with street address and phone. Export or look up.", "version": "0.0", "x-build-id": "c15aGaE2aKdLfG69e" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapebench~chicago-contractor-license-lookup/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapebench-chicago-contractor-license-lookup", "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/scrapebench~chicago-contractor-license-lookup/runs": { "post": { "operationId": "runs-sync-scrapebench-chicago-contractor-license-lookup", "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/scrapebench~chicago-contractor-license-lookup/run-sync": { "post": { "operationId": "run-sync-scrapebench-chicago-contractor-license-lookup", "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": [ "auto", "lookup", "verify", "export" ], "type": "string", "description": "export: no names, just filters; returns the whole matching list. lookup / verify: put company names (matched if contained in the company name) or licence numbers (exact) in 'queries'. auto picks the mode for you.", "default": "auto" }, "query": { "title": "Search name", "type": "string", "description": "A business name (or listing number) to look up live. Kept alongside 'queries' for saved tasks." }, "queries": { "title": "Search name (several)", "type": "array", "description": "A business name (or listing number) to look up live. Several values in one run; combined with 'query'.", "default": [], "items": { "type": "string" } }, "locality": { "title": "Locality", "type": "string", "description": "Only listings in this locality. Kept alongside 'localities' for saved tasks." }, "localities": { "title": "Locality (several)", "type": "array", "description": "Only listings in this locality. Several values in one run; combined with 'locality'.", "default": [], "items": { "type": "string" } }, "status": { "title": "Status", "type": "string", "description": "Only listings in this status. Kept alongside 'statuses' for saved tasks." }, "statuses": { "title": "Status (several)", "type": "array", "description": "Only listings in this status. Several values in one run; combined with 'status'.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Licence type", "type": "array", "description": "Only rows from this licence type (one or more). Available: Above Ground Pool, C3, CARPENTRY, CONCRETE, Carpentry, Cell Tower Erector, Concrete, Construction Manager, Crane Operator, DEMOLITION, DRAIN LAYER, Damp Proofing, Demolition, Drywall, EIFS - Stucco - Plaster, ELECTRICAL, ELEVATOR, EXCAVATION, Electrical, Electrical - Audio Visual, Electrical - Fire Alarm, Electrical - Other, Electrical - Power & Lighting, Electrical - Security, Electrical - Sign, … (88 in all; an unknown name returns the full list, free).", "default": [], "items": { "type": "string" } }, "licenseTypes": { "title": "Licence types", "type": "array", "description": "Same filter as 'Licence type', under the name every state licence actor takes; the two lists are combined.", "default": [], "items": { "type": "string" } }, "expiresAfter": { "title": "Expires on or after", "type": "string", "description": "Only licences expiring on or after this date (YYYY-MM-DD). Licences with no published expiry are left out when set." }, "expiresBefore": { "title": "Expires on or before", "type": "string", "description": "Only licences expiring on or before this date (YYYY-MM-DD): renewals coming due." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Per query in lookup mode; per run in export mode.", "default": 500 }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Used only for live lookups; exports read the stored snapshot.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }