{ "openapi": "3.0.1", "info": { "title": "NYC Licensed Business Search - DCWP Contractors & Licenses", "description": "Search NYC Department of Consumer and Worker Protection (DCWP) licenses: 19k home improvement contractors, tobacco and secondhand dealers, locksmiths, tow trucks, debt collectors and more. Get phone, address, status and dates.", "version": "0.1", "x-build-id": "uAHbpAU4IGm0bp2vr" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/pink_comic~nyc-licensed-business-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-pink_comic-nyc-licensed-business-search", "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/pink_comic~nyc-licensed-business-search/runs": { "post": { "operationId": "runs-sync-pink_comic-nyc-licensed-business-search", "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/pink_comic~nyc-licensed-business-search/run-sync": { "post": { "operationId": "run-sync-pink_comic-nyc-licensed-business-search", "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": { "query": { "title": "Business Name (quick)", "type": "string", "description": "Quick single business or DBA name search (contains match). Leave blank to browse.", "default": "" }, "names": { "title": "Business Names", "type": "array", "description": "Business names or DBA trade names, contains match, case-insensitive.", "default": [], "items": { "type": "string" } }, "businessCategories": { "title": "Business Categories", "type": "array", "description": "Contains match, e.g. 'Home Improvement Contractor', 'Locksmith', 'Tow Truck Company', 'Debt Collection Agency', 'Tobacco Retail Dealer', 'Employment Agency', 'Garage & Parking Lot'.", "default": [], "items": { "type": "string" } }, "boroughs": { "title": "Boroughs", "type": "array", "description": "Manhattan, Brooklyn, Queens, Bronx, Staten Island.", "default": [], "items": { "type": "string" } }, "zipCodes": { "title": "ZIP Codes", "type": "array", "description": "ZIP code or prefix, e.g. '11201' or '112'.", "default": [], "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Address city as listed, e.g. 'BROOKLYN', 'NEW YORK', or out-of-city addresses like 'YONKERS'.", "default": [], "items": { "type": "string" } }, "createdAfter": { "title": "License Created On or After", "type": "string", "description": "Optional YYYY-MM-DD. Use a recent date for newly licensed businesses.", "default": "" }, "licenseStatuses": { "title": "License Statuses", "type": "array", "description": "Only used when Active Only is off, e.g. 'Expired', 'Ready for Renewal', 'Revoked', 'Suspended'.", "default": [], "items": { "type": "string" } }, "licenseNumbers": { "title": "License Numbers", "type": "array", "description": "Exact DCWP license numbers, e.g. '0016371-DCA' (ignores Active Only).", "default": [], "items": { "type": "string" } }, "activeOnly": { "title": "Active Licenses Only", "type": "boolean", "description": "Return only Active licenses (ignored for license number lookups).", "default": true }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Maximum total paid dataset items, split across search terms. The default returns 10 licenses (about $0.0201 including the start event).", "default": 10 } } }, "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 } } } } } } } } } }