{ "openapi": "3.0.1", "info": { "title": "US Contractor License Lookup: WA, OR, CT, NY, CO, DE Data", "description": "Verify contractor licenses by number or list licensed businesses from six official state open data portals, in one schema: status, type, trade, issue and expiry dates, city and ZIP. Licence-checked sources only. No owner names, phones, emails or street addresses.", "version": "0.1", "x-build-id": "n4DEHcNrBKgQD0v7a" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/jp-data-lab~us-contractor-licenses-official-data/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-jp-data-lab-us-contractor-licenses-official-data", "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/jp-data-lab~us-contractor-licenses-official-data/runs": { "post": { "operationId": "runs-sync-jp-data-lab-us-contractor-licenses-official-data", "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/jp-data-lab~us-contractor-licenses-official-data/run-sync": { "post": { "operationId": "run-sync-jp-data-lab-us-contractor-licenses-official-data", "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": { "licenseNumbers": { "title": "License numbers to verify", "type": "array", "description": "Optional, up to 1,000. Exact license numbers to look up, such as HIC.0512411 (Connecticut) or UDREABI745PT (Washington). When set, the other filters below are ignored and each number is checked in the selected states. Numbers with no match are listed in RUN_SUMMARY and are not charged.", "default": [], "items": { "type": "string" } }, "states": { "title": "States", "type": "array", "description": "Which official state sources to read. Leave all selected for every source.", "items": { "type": "string", "enum": [ "washington", "oregon", "connecticut", "new-york", "colorado", "delaware" ], "enumTitles": [ "Washington", "Oregon", "Connecticut", "New York (public work contractor registry)", "Colorado (electrical and plumbing)", "Delaware (contractor business licenses)" ] }, "default": [ "washington", "oregon", "connecticut", "new-york", "colorado", "delaware" ] }, "keywords": { "title": "Business name keywords", "type": "array", "description": "Keep licenses whose business name contains any of these words, e.g. roofing, solar. Case-insensitive.", "default": [], "items": { "type": "string" } }, "categories": { "title": "Trade category", "type": "array", "description": "Optional. New York and Delaware do not publish a trade, so they only match Unclassified.", "items": { "type": "string", "enum": [ "general", "electrical", "plumbing", "hvac", "specialty", "unclassified" ], "enumTitles": [ "General", "Electrical", "Plumbing", "HVAC", "Specialty trades", "Unclassified" ] }, "default": [] }, "activeOnly": { "title": "Active licenses only", "type": "boolean", "description": "Leave out expired, suspended and revoked licenses. Oregon, New York and Delaware only publish current licenses.", "default": true }, "issuedWithinDays": { "title": "Issued within (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only licenses issued in the last N days, to find newly licensed contractors. 0 = no date limit. Delaware publishes no issue date, so it is skipped when this is set.", "default": 0 }, "expiringWithinDays": { "title": "Expiring within (days)", "minimum": 0, "maximum": 3650, "type": "integer", "description": "Only licenses that expire in the next N days. 0 = no limit.", "default": 0 }, "maxItems": { "title": "Max results", "minimum": 1, "maximum": 10000, "type": "integer", "description": "Total for the whole run, shared evenly across states, newest first within each state. You are charged per result.", "default": 100 } } }, "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 } } } } } } } } } }