{ "openapi": "3.0.1", "info": { "title": "US Professional License Data", "description": "Public professional-license records from US state licensing boards. Launch scope: New Jersey contractor boards (Electrical Contractors, Master Plumbers, HVACR) -- name, license number, license type, status, city, and state, one record per license.", "version": "0.1", "x-build-id": "ow1ze3UEUEMkFnKoR" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/wallman_3rd~us-professional-licenses/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-wallman_3rd-us-professional-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/wallman_3rd~us-professional-licenses/runs": { "post": { "operationId": "runs-sync-wallman_3rd-us-professional-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/wallman_3rd~us-professional-licenses/run-sync": { "post": { "operationId": "run-sync-wallman_3rd-us-professional-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": [ "NJ", "IN", "OR" ], "type": "string", "description": "Which state's licensing boards to scrape. New Jersey works out of the box. Indiana works too but its source (mylicense.in.gov) blocks datacenter IPs, so IN needs an Apify residential proxy (set Proxy configuration below) — without one, IN returns 0. (Oregon is listed but its source portal requires a CAPTCHA on every search, so it currently returns no data.) Each state has its own set of boards — see the README for the full per-state board list.", "default": "NJ" }, "boards": { "title": "Boards / professions", "type": "array", "description": "Which licensing boards to scrape for the selected state. Each is an individually-licensed profession (name, license number, license type, status, city, state). Board names must match the selected state's list exactly — see the README for the full per-state board list (e.g. NJ: 'Electrical Contractors', 'Accountancy'; IN: 'Plumbing Commission', 'Accountancy Board'). Pricing is per record and boards can hold thousands of licensees, so pick deliberately. Leave EMPTY to scrape that state's bounded default starter set (a few boards), not everything.", "items": { "type": "string" } }, "maxRecordsPerBoard": { "title": "Max records per board", "minimum": 0, "type": "integer", "description": "Stop each board after this many records (0 = unlimited / full board). Set a small number (e.g. 30) for a cheap test run before pulling a full board.", "default": 0 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Only needed for Indiana (IN), whose source blocks datacenter IPs — enable Apify Proxy with the RESIDENTIAL group. New Jersey does not need a proxy.", "default": { "useApifyProxy": false } } } }, "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 } } } } } } } } } }