{ "openapi": "3.0.1", "info": { "title": "New Business Licenses Feed: 12 US & Canada Cities", "description": "Daily feed of new business licences from official open data: Chicago, San Francisco, Los Angeles, Seattle, Philadelphia, New Orleans, Baton Rouge, Norfolk, Delaware, Marin County, Calgary and Edmonton. Companies only: name, activity/NAICS, address, dates. Filters + 'new since last run'.", "version": "0.2", "x-build-id": "WidrgEell8OW5zo45" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/moment-data~city-new-business-licenses-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-moment-data-city-new-business-licenses-feed", "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/moment-data~city-new-business-licenses-feed/runs": { "post": { "operationId": "runs-sync-moment-data-city-new-business-licenses-feed", "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/moment-data~city-new-business-licenses-feed/run-sync": { "post": { "operationId": "run-sync-moment-data-city-new-business-licenses-feed", "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": [ "window", "sinceLastRun" ], "type": "string", "description": "window (default): licences in the latest N days of each city's data, no saved state. sinceLastRun: only licences not delivered before for this State key; use for daily schedules.", "default": "window" }, "sources": { "title": "Cities", "type": "array", "description": "Official city/county/state datasets to read (default: all 12).", "items": { "type": "string", "enum": [ "chicago", "sanFrancisco", "losAngeles", "seattle", "norfolk", "newOrleans", "philadelphia", "batonRouge", "delaware", "marin", "calgary", "edmonton" ], "enumTitles": [ "Chicago, IL (new license issuances)", "San Francisco, CA (new registered business locations)", "Los Angeles, CA (new business tax registrations)", "Seattle, WA (business license tax certificates)", "Norfolk, VA (newly opened businesses)", "New Orleans, LA (occupational business licenses)", "Philadelphia, PA (new business licenses, initial issue)", "Baton Rouge / East Baton Rouge Parish, LA (newly opened businesses)", "Delaware, statewide (new state business licenses)", "Marin County, CA (unincorporated county business licenses)", "Calgary, AB, Canada (new business licences, trade names)", "Edmonton, AB, Canada (new business licences)" ] }, "default": [ "chicago", "sanFrancisco", "losAngeles", "seattle", "norfolk", "newOrleans", "philadelphia", "batonRouge", "delaware", "marin", "calgary", "edmonton" ] }, "daysBack": { "title": "Days", "minimum": 1, "maximum": 90, "type": "integer", "description": "Window length in calendar days, ending at the newest date published by each city (cities publish with 0-3 days lag). sinceLastRun uses 14 if not set.", "default": 7 }, "date": { "title": "End date", "pattern": "^(\\d{4}-\\d{2}-\\d{2})?$", "type": "string", "description": "Optional YYYY-MM-DD window end for backfills." }, "keywords": { "title": "Keywords", "type": "array", "description": "Any of these words in the business name, trade name, licence type or activity, e.g. restaurant, salon, construction, cannabis.", "default": [], "items": { "type": "string" } }, "naicsPrefixes": { "title": "NAICS prefixes", "type": "array", "description": "e.g. 722 (restaurants & bars), 238 (specialty trade contractors), 5415 (IT services). Only SF, LA, Seattle and Baton Rouge publish NAICS codes, so this filter skips the other cities' records.", "default": [], "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes", "type": "array", "description": "Only these 5-digit ZIP codes.", "default": [], "items": { "type": "string" } }, "entityTypes": { "title": "Entity types", "type": "array", "description": "Empty = all. Calgary and Edmonton publish only trade names, so their records without a legal-form suffix are typed trade-name; leave it out to get legal entities only.", "items": { "type": "string", "enum": [ "llc", "corporation", "partnership", "limited-company", "company", "public-or-nonprofit", "trade-name" ], "enumTitles": [ "LLC / PLLC", "Corporation / Inc / PC", "LP / LLP", "Ltd / limited company", "Company / Co", "Nonprofit / public body / association", "Trade name at commercial premises (Calgary/Edmonton: legal form not published)" ] }, "default": [] }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Maximum records per run (also caps your spend), split evenly between cities (default 36 = 3 per city).", "default": 36 }, "stateKey": { "title": "State key", "type": "string", "description": "Separate saved state per saved search in sinceLastRun mode.", "default": "default" } } }, "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 } } } } } } } } } }