{ "openapi": "3.0.1", "info": { "title": "South Carolina Contractor Directory & Leads Scraper (LLR)", "description": "Every South Carolina commercial contractor licensed by SC LLR, with phone, street address, classification and owner. Filter by city, ZIP, classification and status.", "version": "0.0", "x-build-id": "q8EGAQok3FZAKf5SK" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapebench~south-carolina-contractor-directory-leads-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapebench-south-carolina-contractor-directory-leads-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/scrapebench~south-carolina-contractor-directory-leads-scraper/runs": { "post": { "operationId": "runs-sync-scrapebench-south-carolina-contractor-directory-leads-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/scrapebench~south-carolina-contractor-directory-leads-scraper/run-sync": { "post": { "operationId": "run-sync-scrapebench-south-carolina-contractor-directory-leads-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": { "listOptionsOnly": { "title": "Discovery Mode: list cities and classifications only", "type": "boolean", "description": "If true, return every city and every classification (with its code) on the roster, each with its count of licences. Free, not charged.", "default": false }, "city": { "title": "City (exact)", "type": "string", "description": "The city on the licence's address, e.g. 'Columbia', 'Greenville', 'Myrtle Beach'. Exact match; case and punctuation are ignored. A city with no matching licence returns a free row saying so." }, "cities": { "title": "Cities (batch)", "type": "array", "description": "Several cities in ONE run, each searched separately. Combined with 'City' if you fill both.", "default": [], "items": { "type": "string" } }, "zip": { "title": "ZIP code (exact)", "type": "string", "description": "A 5-digit ZIP code, matched against the licence's address ZIP, e.g. '29209'." }, "zips": { "title": "ZIP codes (batch)", "type": "array", "description": "Several ZIP codes in ONE run, each searched separately.", "default": [], "items": { "type": "string" } }, "classification": { "title": "Classification", "type": "string", "description": "An SC LLR classification, by code ('BD', 'AC', 'EL', 'PB') or by a word from its name ('Building', 'Air Conditioning', 'Electrical', 'plumb'). Leave empty for every classification. Discovery Mode lists them all." }, "classifications": { "title": "Classifications (batch)", "type": "array", "description": "Several classifications in ONE run. A contractor holding two of them is returned (and billed) once.", "default": [], "items": { "type": "string" } }, "licenseType": { "title": "Licence type", "type": "string", "description": "Filter by licence type, e.g. 'General Contractor', 'Mechanical Contractor', 'Construction Manager'. A word from the type is enough." }, "licenseTypes": { "title": "Licence types (batch)", "type": "array", "description": "Several licence types; a licence matching any of them is kept.", "default": [], "items": { "type": "string" } }, "statuses": { "title": "Statuses", "type": "array", "description": "Licence statuses to include, e.g. Active, Lapsed, Suspended, Closed. Default: Active only. Empty list = every status (the roster keeps every licence ever issued, and only about 45% are Active).", "default": [ "Active" ], "items": { "type": "string" } }, "statewide": { "title": "Statewide export", "type": "boolean", "description": "Return every licence that passes the status, licence-type and state filters, with no city, ZIP or classification. Without it, a run with no city, ZIP, classification or licence type returns the free Discovery lists instead.", "default": false }, "inSouthCarolinaOnly": { "title": "South Carolina addresses only", "type": "boolean", "description": "Keep only licences with a South Carolina address. Many commercial licences are held by out-of-state firms (most often North Carolina and Georgia); turn this off to include them.", "default": true }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Cap on the contractors returned PER city/ZIP + classification search, not per run. Leave empty to return every match." } } }, "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 } } } } } } } } } }