{ "openapi": "3.0.1", "info": { "title": "OpenSoon USA - Verified Pre-Opening Business Leads", "description": "Find restaurants, bars, and liquor stores before or around opening from official US licensing records.", "version": "0.1", "x-build-id": "Urlxfe4UaYO2d5wOp" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nobler_voyager~opensoon-usa/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nobler_voyager-opensoon-usa", "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/nobler_voyager~opensoon-usa/runs": { "post": { "operationId": "runs-sync-nobler_voyager-opensoon-usa", "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/nobler_voyager~opensoon-usa/run-sync": { "post": { "operationId": "run-sync-nobler_voyager-opensoon-usa", "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", "required": [ "sources", "lookbackDays", "businessTypes", "maxItems" ], "properties": { "sources": { "title": "Official data sources", "type": "array", "description": "Texas provides pending alcohol applications, California provides daily alcohol applications, and Chicago provides newly issued first-time business licenses.", "items": { "type": "string", "enum": [ "texas_tabc", "california_abc", "chicago_business_licenses" ], "enumTitles": [ "Texas TABC pending applications", "California ABC daily applications", "Chicago first-time business licenses" ] }, "default": [ "texas_tabc", "california_abc", "chicago_business_licenses" ] }, "lookbackDays": { "title": "Lookback period", "minimum": 1, "maximum": 60, "type": "integer", "description": "Return licensing signals published during the last N calendar days.", "default": 14 }, "businessTypes": { "title": "Business types", "type": "array", "description": "Filter records using license types and business activity descriptions published by each authority.", "items": { "type": "string", "enum": [ "restaurant", "bar", "liquor_store", "other" ], "enumTitles": [ "Restaurants and food service", "Bars and nightlife", "Liquor and package stores", "Other licensed businesses" ] }, "default": [ "restaurant", "bar", "liquor_store" ] }, "cities": { "title": "Cities", "type": "array", "description": "Optional city filter. Leave empty to include every city covered by the selected sources.", "items": { "type": "string", "maxLength": 80 }, "default": [] }, "keywords": { "title": "Business keywords", "type": "array", "description": "Optional case-insensitive terms matched against the business name, owner, address, license description, and activity.", "items": { "type": "string", "maxLength": 80 }, "default": [] }, "includeTransfers": { "title": "Include California transfers", "type": "boolean", "description": "Include California ownership and premises transfer applications in addition to original applications.", "default": false }, "monitorMode": { "title": "Only return newly discovered records", "type": "boolean", "description": "Persist delivered IDs in a named key-value store. Scheduled runs with the same monitor key then emit only records not returned before.", "default": false }, "monitorKey": { "title": "Monitor key", "pattern": "^[A-Za-z0-9._-]+$", "minLength": 1, "maxLength": 80, "type": "string", "description": "Use a different key for each independent client, territory, or workflow.", "default": "default" }, "maxItems": { "title": "Maximum leads", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum number of normalized leads written to the dataset.", "default": 1000 } } }, "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 } } } } } } } } } }