{ "openapi": "3.0.1", "info": { "title": "City Business License Monitor — New-Opening Leads", "description": "Monitor city business-license registries for newly-licensed, soon-to-open businesses — a hyperlocal lead feed for merchant services, insurance, CRE & local sales. Covers Chicago, Seattle & San Francisco: name, license type, address, neighborhood, date. Alerts via Slack/email/webhook. $4 per 1,000.", "version": "0.1", "x-build-id": "43KRywBWlI1uYzQwQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapersdelight~city-business-license-monitor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapersdelight-city-business-license-monitor", "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/scrapersdelight~city-business-license-monitor/runs": { "post": { "operationId": "runs-sync-scrapersdelight-city-business-license-monitor", "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/scrapersdelight~city-business-license-monitor/run-sync": { "post": { "operationId": "run-sync-scrapersdelight-city-business-license-monitor", "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' business-license feeds to pull. Supported: chicago, seattle, sf. More cities are being added.", "default": [ "chicago", "seattle", "sf" ], "items": { "type": "string" } }, "dateFrom": { "title": "Date from (YYYY-MM-DD)", "type": "string", "description": "Start of the issue/start-date window. Leave empty to use today minus 'Lookback days'." }, "dateTo": { "title": "Date to (YYYY-MM-DD)", "type": "string", "description": "End of the window. Leave empty for today plus 'Future days' (to catch soon-to-open businesses)." }, "lookbackDays": { "title": "Lookback days", "minimum": 1, "type": "integer", "description": "Include businesses issued/started within the last N days.", "default": 90 }, "futureDays": { "title": "Future days (opening soon)", "minimum": 0, "type": "integer", "description": "Also include businesses whose start date is up to N days in the future ('opening soon'). Set 0 to exclude future-dated.", "default": 180 }, "keyword": { "title": "Keyword filter", "type": "string", "description": "Optional. Keep only records whose business name, license type, or area contains this text." }, "licenseTypeFilter": { "title": "License type filter", "type": "string", "description": "Optional. Keep only records whose license type contains this text, e.g. 'Restaurant', 'Retail Food', 'Limousine'." }, "socrataAppToken": { "title": "Socrata app token (optional)", "type": "string", "description": "Optional Socrata token to raise rate limits across the city open-data APIs. Works fine without one for normal volumes." }, "maxRecords": { "title": "Max records per run", "minimum": 0, "type": "integer", "description": "Hard cap on records per run (0 = no cap).", "default": 0 }, "monitorMode": { "title": "Monitor mode (new-business watcher)", "type": "boolean", "description": "Recurring watcher: diff against the prior run (per city+filter scope) and output/alert ONLY newly-appearing licenses. Pair with an Apify Schedule.", "default": false }, "alertOnNewBusiness": { "title": "Alert on new businesses", "type": "boolean", "description": "In monitor mode, send an alert for each new license.", "default": true }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "POST endpoint for new-business alerts." }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Slack incoming-webhook URL." }, "emailRecipients": { "title": "Email recipients", "type": "array", "description": "Emails for the new-business digest (via apify/send-mail).", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Proxy settings. Public city open data; datacenter rotation is plenty.", "default": { "useApifyProxy": true } }, "diagnose": { "title": "Diagnostic mode (dev)", "type": "boolean", "description": "Dev only. Pulls one city for the window and logs the first parsed record, then exits.", "default": 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 } } }, "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 } } } } } } } } } }