{ "openapi": "3.0.1", "info": { "title": "North Carolina NCLBGC General Contractor License Scraper", "description": "Bulk-export North Carolina licensed general contractors: name, license #, classifications, status, expiration, address and phone. Filter by classification, city, company or name. Export to JSON, CSV or Excel.", "version": "0.1", "x-build-id": "RiyidvqZrQ3ESGelc" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapers_lat~north-carolina-nclbgc-contractors-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapers_lat-north-carolina-nclbgc-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/scrapers_lat~north-carolina-nclbgc-contractors-scraper/runs": { "post": { "operationId": "runs-sync-scrapers_lat-north-carolina-nclbgc-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/scrapers_lat~north-carolina-nclbgc-contractors-scraper/run-sync": { "post": { "operationId": "run-sync-scrapers_lat-north-carolina-nclbgc-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": { "classificationTypes": { "title": "Classification Types", "type": "array", "description": "License classifications to pull, by name (e.g. Building, Residential, Highway, Public Utilities) or numeric id. One search per item. Full population export by trade.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "North Carolina cities to pull licensed contractors from (e.g. Charlotte, Raleigh, Durham). One search per city.", "items": { "type": "string" } }, "companyNames": { "title": "Company Names", "type": "array", "description": "Company / business names to look up. Partial names match. One search per name.", "items": { "type": "string" } }, "lastNames": { "title": "Qualifier / Owner Last Names", "type": "array", "description": "Last names of the license qualifier or owner. One search per name. Use 'First Name' to narrow.", "items": { "type": "string" } }, "firstName": { "title": "First Name (optional)", "type": "string", "description": "Optional first name applied to the last-name searches." }, "licenseNumbers": { "title": "License Numbers", "type": "array", "description": "Specific NCLBGC license / account numbers to fetch (e.g. L.06263). One lookup per number.", "items": { "type": "string" } }, "phoneNumbers": { "title": "Phone Numbers", "type": "array", "description": "Reverse-lookup licensees by phone number. One search per number.", "items": { "type": "string" } }, "stateCode": { "title": "State Code (optional filter)", "type": "string", "description": "Optional 2-letter state filter for the licensee mailing address (e.g. NC)." }, "postalCode": { "title": "ZIP Code (optional filter)", "type": "string", "description": "Optional ZIP filter applied to city / classification searches." }, "streetAddress": { "title": "Street Address (optional filter)", "type": "string", "description": "Optional street address filter." }, "useSoundex": { "title": "Match like-sounding names", "type": "boolean", "description": "Include phonetically similar (soundex) name matches.", "default": false }, "activeOnly": { "title": "Active licensees only", "type": "boolean", "description": "Return only currently active / valid licenses and skip archived, expired or revoked records. Best for lead generation.", "default": false }, "withDetails": { "title": "Fetch full details (phone, address, classifications)", "type": "boolean", "description": "Fetch each licensee's detail record to capture phone, full address, expiration, license limitation and active classifications. Turn off for a faster name/license-only list.", "default": true }, "maxLicensees": { "title": "Max Licensees To Scrape", "minimum": 1, "type": "integer", "description": "Maximum number of licensee records to return across all searches.", "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 } } }, "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 } } } } } } } } } }