{ "openapi": "3.0.1", "info": { "title": "New Business License Feed: Fresh Openings by City", "description": "Every business, food, liquor and trade license newly issued in Chicago, Los Angeles, New York, Seattle and New Orleans, filtered to the trades you sell to, with only what you have not already seen. Official city open data, no key needed.", "version": "0.1", "x-build-id": "R8QYAWV7atsFMjbca" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/fayoussef~business-license-feed/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-fayoussef-business-license-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/fayoussef~business-license-feed/runs": { "post": { "operationId": "runs-sync-fayoussef-business-license-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/fayoussef~business-license-feed/run-sync": { "post": { "operationId": "run-sync-fayoussef-business-license-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": { "cities": { "title": "City registers to read", "type": "array", "description": "Which city business-license registers to pull from. Each one is an official municipal open-data file and needs no account or key.", "items": { "type": "string", "enum": [ "chicago", "la", "nyc", "seattle", "neworleans" ], "enumTitles": [ "Chicago, IL (about 2,200 new licenses a month)", "Los Angeles, CA (about 1,000 a month)", "New York City, NY (DCWP, published in batches)", "Seattle, WA (about 370 a month)", "New Orleans, LA (about 190 a month)" ] }, "default": [ "chicago", "la", "seattle", "neworleans" ] }, "lookbackDays": { "title": "Look back this many days", "minimum": 1, "maximum": 3650, "type": "integer", "description": "How far back to reach for newly issued licenses. Match it to how often you run this: 7 for a weekly schedule, 30 for a monthly one. The window is closed at today's date on purpose, because every one of these registers contains licenses pre-dated years into the future and they are not new businesses.", "default": 30 }, "keywords": { "title": "Only these kinds of business", "type": "array", "description": "Optional. Filter by what the license is for, matched against the license type, category or NAICS description. For example restaurant, food, liquor, tavern, retail, salon, tobacco, day care, contractor. Leave empty for every new license in the window.", "items": { "type": "string" } }, "onlyNewSinceLastRun": { "title": "Only return licenses not seen before", "type": "boolean", "description": "The point of running this on a schedule. Licenses already returned by an earlier run are skipped, so a weekly run gives you this week's openings rather than the same list again. The first run returns the whole window and remembers it.", "default": true }, "watchlistName": { "title": "Watchlist name", "type": "string", "description": "The name of the memory this run uses to skip licenses it has already sent you. Use a different name per feed, for example \"restaurants\" and \"contractors\", and each keeps its own history. Changing this name starts fresh, so the next run returns the whole window again.", "default": "default" }, "maxResults": { "title": "Maximum licenses per run", "minimum": 1, "maximum": 50000, "type": "integer", "description": "A cap on how many licenses one run returns. With several cities selected the budget is split evenly between them, so one busy city cannot crowd out the rest.", "default": 1000 }, "slackWebhookUrl": { "title": "Slack webhook URL", "type": "string", "description": "Optional. Post the new openings to a Slack channel. Nothing is sent when there are none, so a quiet channel means a quiet week." }, "discordWebhookUrl": { "title": "Discord webhook URL", "type": "string", "description": "Optional. Post the same digest to a Discord channel." }, "telegramChatId": { "title": "Telegram chat ID", "type": "string", "description": "Optional. The chat to send the digest to. Fill this in together with the bot token below." }, "telegramBotToken": { "title": "Telegram bot token", "type": "string", "description": "Optional. Your own bot's token, used only to deliver the digest to the chat above." }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "Optional. Receive the new licenses as JSON, for your CRM, Zapier, Make or n8n." } } }, "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 } } } } } } } } } }