{ "openapi": "3.0.1", "info": { "title": "Arizona ROC Contractor License Scraper", "description": "Look up Arizona Registrar of Contractors licenses by number, company, qualifying party, or city. Get status, bond, classification, personnel, and complaint history. Export as JSON, CSV, or Excel.", "version": "1.0", "x-build-id": "0nCQt9m7YbxfWJFTt" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parsebird~az-roc-contractor-license-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parsebird-az-roc-contractor-license-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/parsebird~az-roc-contractor-license-scraper/runs": { "post": { "operationId": "runs-sync-parsebird-az-roc-contractor-license-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/parsebird~az-roc-contractor-license-scraper/run-sync": { "post": { "operationId": "run-sync-parsebird-az-roc-contractor-license-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 ROC license numbers to look up directly, e.g. 333318. Leading zeros are added automatically to make 6 digits. Fastest and most precise search mode.", "items": { "type": "string" } }, "companyNames": { "title": "Company names", "type": "array", "description": "Business names to search. Partial matches accepted (e.g. Acme Plumbing). Each name triggers its own search.", "items": { "type": "string" } }, "qualifyingPartyNames": { "title": "Qualifying party names", "type": "array", "description": "Full name of the qualifying party -- the individual legally responsible for the license. Format: First Last. Partial names allowed.", "items": { "type": "string" } }, "cities": { "title": "Cities", "type": "array", "description": "Arizona cities to search by mailing address (e.g. Phoenix, Tucson, Mesa, Scottsdale). Must match the exact spelling AZ ROC has on file. Large cities can return hundreds of records.", "items": { "type": "string" } }, "licenseClassification": { "title": "License classification", "type": "string", "description": "Optional classification code to filter by (e.g. B-1, R-11, C-37, CR-39). See the Classification Reference in the README for the full list. Leave blank to return all classifications. Applied together with Cities, or on its own if no other search field is set." }, "licenseType": { "title": "License type", "enum": [ "ALL", "RESIDENTIAL", "COMMERCIAL", "DUAL" ], "type": "string", "description": "Keep only licenses whose classification scope matches. Derived from the classification's own description (Residential / Commercial / Dual), since AZ ROC's search does not filter by type server-side.", "default": "ALL" }, "licenseStatus": { "title": "License status", "enum": [ "ALL", "ACTIVE", "SUSPENDED", "EXPIRED", "REVOKED", "CANCELLED" ], "type": "string", "description": "Keep only licenses in this status. Applied after fetching results, since AZ ROC's search does not filter by status server-side.", "default": "ALL" }, "maxResultsPerSearch": { "title": "Max results per search", "minimum": 0, "type": "integer", "description": "Cap records per individual search query (license number, company name, qualifying party, or city). 0 = unlimited.", "default": 0 }, "resultsPerPage": { "title": "Results per page (unused)", "enum": [ "10", "20", "50" ], "type": "string", "description": "Kept for compatibility with the AZ ROC site's own page-size control. This actor reads every matching record directly from AZ ROC's single search response instead of clicking through pages, so this value has no effect on what's collected.", "default": "50" }, "scrapeDetailPage": { "title": "Scrape detail page", "type": "boolean", "description": "If true, fetches each license's full detail record: bond, complaint counts, classification, and personnel data. Disable for a fast list-only crawl.", "default": true }, "scrapeComplaints": { "title": "Scrape complaints", "type": "boolean", "description": "If true (and Scrape detail page is enabled), captures the license's complaint history (open / disciplined / resolved counts, plus individual complaints). AZ ROC only displays the prior two years of complaints.", "default": true }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 10, "type": "integer", "description": "Maximum concurrent requests to AZ ROC's search API (1-10). This actor talks to AZ ROC's own backend directly rather than driving a browser, so this controls concurrent HTTP requests, not browser tabs. Higher values speed up bulk runs but increase load on AZ ROC's server.", "default": 3 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Standard Apify proxy config. AZ ROC's search API has responded to direct and datacenter requests in testing, but residential is recommended for larger production runs to reduce rate-limiting risk.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ] } } } }, "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 } } } } } } } } } }