{ "openapi": "3.0.1", "info": { "title": "US Contractor Licenses - 9 State Boards", "description": "Contractor and trade licences from nine state boards: California CSLB, Washington L&I, New Jersey DCA, Florida DBPR, Minnesota DLI, Ohio OCILB, Oregon CCB, Virginia DPOR and Texas TDLR. One schema; filter by name, licence number, licence type, classification, status, city, county or ZIP.", "version": "0.0", "x-build-id": "nxlgHw7Rs5xrOg1U0" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~us-contractor-licenses/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-us-contractor-licenses", "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/j0401~us-contractor-licenses/runs": { "post": { "operationId": "runs-sync-j0401-us-contractor-licenses", "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/j0401~us-contractor-licenses/run-sync": { "post": { "operationId": "run-sync-j0401-us-contractor-licenses", "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": { "state": { "title": "State", "enum": [ "CA", "WA", "NJ", "FL", "MN", "OH", "OR", "VA", "TX" ], "type": "string", "description": "CA = CSLB / WA = L&I / NJ = DCA contractor boards / FL = DBPR / MN = DLI / OH = OCILB / OR = CCB / VA = DPOR / TX = TDLR contractor types.", "default": "CA" }, "mode": { "title": "Mode", "enum": [ "rows", "aggregate" ], "type": "string", "description": "rows = matching licences. aggregate = one count row per group (see groupBy).", "default": "rows" }, "name": { "title": "Holder or business name", "type": "string", "description": "Substring match across the holder name and the business name. Not every state fills both - see the coverage table in the README." }, "licenseNumber": { "title": "Licence number", "type": "string", "description": "Exact licence number." }, "licenseType": { "title": "Licence type", "type": "string", "description": "The board's own licence type label, exact (e.g. \"Certified Building Contractor\", \"CONSTRUCTION CONTRACTOR\", \"Master Plumber\"). Availability differs per state." }, "classification": { "title": "Classification", "type": "string", "description": "California CSLB class (A, B, C-10, C-20, C-36 ), matched as a whole class token; hyphens are ignored so C10 and C-10 are the same. Other states match this as a substring of their classification/specialty text." }, "status": { "title": "Status", "type": "string", "description": "active / inactive / unknown (normalised), or the board's own status word (case-insensitive). OR, VA and TX publish no status, so every row there is blank." }, "city": { "title": "City", "type": "string", "description": "Substring match." }, "county": { "title": "County", "type": "string", "description": "Substring match. MN, VA and WA publish no county." }, "zip": { "title": "ZIP", "type": "string", "description": "Exact ZIP as published (TX has no ZIP in the corpus)." }, "groupBy": { "title": "Aggregate by", "enum": [ "", "licenseType", "classification", "status", "county", "city", "state" ], "type": "string", "description": "mode=aggregate only (blank = licenseType).", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "maximum": 5000, "type": "integer", "description": "Cap on records delivered (0 = default 50; up to 5,000 per run). In aggregate mode it caps the number of GROUP rows returned. Each delivered record is metered individually.", "default": 50 } } }, "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 } } } } } } } } } }