{ "openapi": "3.0.1", "info": { "title": "NC Licensing Board for General Contractors Scraper", "description": "Scrape NC Licensing Board (NCLBGC) general contractor licenses. Search by license number, company, qualifier, city or classification. Returns status, limitations, qualifiers, classifications and expiration data.", "version": "0.0", "x-build-id": "hjjEWqP0ZDu9I3wSU" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/haketa~nc-licensing-board-for-general-contractors-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-haketa-nc-licensing-board-for-general-contractors-scraper", "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/haketa~nc-licensing-board-for-general-contractors-scraper/runs": { "post": { "operationId": "runs-sync-haketa-nc-licensing-board-for-general-contractors-scraper", "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/haketa~nc-licensing-board-for-general-contractors-scraper/run-sync": { "post": { "operationId": "run-sync-haketa-nc-licensing-board-for-general-contractors-scraper", "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", "type": "array", "description": "One or more NCLBGC license numbers to look up directly (e.g. '76235'). Fastest and most precise search method — returns an exact match.", "items": { "type": "string" } }, "companyNames": { "title": "Company / Business Names", "type": "array", "description": "Business or company names to search. Partial matches are supported. Each entry triggers a separate search and may return multiple results.", "items": { "type": "string" } }, "qualifierFirstNames": { "title": "Qualifier First Names", "type": "array", "description": "First name(s) of the qualifier (the individual who passed the licensing exams on behalf of the license). Use together with Qualifier Last Names for best results.", "items": { "type": "string" } }, "qualifierLastNames": { "title": "Qualifier Last Names", "type": "array", "description": "Last name(s) of the qualifier. Can be used alone or paired with First Names. Pairing first + last names produces a more precise search.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "North Carolina city names to search by location (e.g. 'Raleigh', 'Charlotte', 'Durham'). Can be combined with classification type for targeted trade searches.", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP Codes", "type": "array", "description": "ZIP codes to search by location (e.g. '27601'). Useful for hyper-local contractor searches in a specific area.", "items": { "type": "string" } }, "classificationType": { "title": "Classification Type", "enum": [ "ALL", "Building", "Residential", "Highway", "Public Utilities", "H (Grading & Excavating)", "PU (Communications)", "PU (Fuel Distribution)", "PU (Sewage Disposal)", "PU (Sewer Lines)", "PU (Water Lines)", "PU(Electrical-Ahead of P.O.D.)", "PU(Water Lines & Sewer Lines)", "PU(Water Pur. & Sewage Disp.)", "PU(Water Purification)", "S (Asbestos)", "S (Boring & Tunneling)", "S (Concrete Construction)", "S (Insulation)", "S (Interior Construction)", "S (Marine Construction)", "S (Masonry Construction)", "S (Metal Erection)", "S (Railroad Construction)", "S (Roofing)", "S (Sidewalk Curb & Gutter)", "S (Sign/Billboard)", "S (Swimming Pools)", "S (Wind Turbine)", "Accredited Builder", "Accredited Master Builder", "Unclassified" ], "type": "string", "description": "Filter results by license classification type. 'ALL' returns all classifications. Select a specific classification to narrow results to a particular trade or project type.", "default": "ALL" }, "includeLikeSoundingNames": { "title": "Include Like-Sounding Names", "type": "boolean", "description": "When enabled, the NCLBGC portal expands name searches to include phonetically similar names (e.g. 'Smith' also returns 'Smyth'). Useful when the exact spelling is uncertain.", "default": false }, "maxResultsPerSearch": { "title": "Max Results per Search Query", "minimum": 0, "type": "integer", "description": "Maximum number of contractor records to collect per individual search query. Set to 0 for unlimited. For broad city or classification searches this can be very large.", "default": 100 }, "scrapeDetailPage": { "title": "Scrape Full Detail Page", "type": "boolean", "description": "When enabled, the scraper navigates to each contractor's detail page to collect complete information: all classifications, limitation level, qualifier details, expiration date, and any disciplinary actions. Increases run time but returns richer data.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for requests to the NCLBGC portal. Apify residential proxies are recommended for production bulk runs to avoid rate limiting." }, "maxConcurrency": { "title": "Max Concurrent Browsers", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum number of parallel browser tabs. Higher values speed up bulk runs but consume more memory. Recommended: 2–5.", "default": 3 } } }, "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 } } } } } } } } } }