{ "openapi": "3.0.1", "info": { "title": "State trade licence records, with change detection", "description": "Normalised trade-licence records built from the licensing authority's own published data file, with per-run change flags (new, renewed, expired, status-changed, removed). Official downloads only — no lookup-form automation. Street addresses and telephone numbers are never emitted.", "version": "0.2", "x-build-id": "ZlULgg2rdNTpMQeYh" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/quietfetch~state-license-records/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-quietfetch-state-license-records", "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/quietfetch~state-license-records/runs": { "post": { "operationId": "runs-sync-quietfetch-state-license-records", "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/quietfetch~state-license-records/run-sync": { "post": { "operationId": "run-sync-quietfetch-state-license-records", "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": { "programs": { "title": "Licence programmes", "type": "array", "description": "Which licence programmes to read. Leave empty for all supported programmes. Each is one licence type in the authority's own published licence list, read from the state's official open-data API — this actor never automates a lookup form.", "items": { "type": "string", "enum": [ "tx-ac-contractors", "tx-electrical-contractors", "tx-electrical-sign-contractors", "tx-elevator-contractors", "tx-water-well-drillers" ], "enumTitles": [ "Texas — A/C and refrigeration contractors", "Texas — electrical contractors", "Texas — electrical sign contractors", "Texas — elevator contractors", "Texas — water well drillers and pump installers" ] }, "default": [ "tx-ac-contractors" ] }, "onlyChanged": { "title": "Only changed records", "type": "boolean", "description": "Write (and charge for) only records whose status, expiry, name or town moved since your last run, plus records that appeared or disappeared. First run writes everything.", "default": false }, "includeRemoved": { "title": "Report licences that dropped out of the file", "type": "boolean", "description": "Emit a row (change = 'removed') for a licence that was in the previous published file and is absent from this one. Only possible on a complete read.", "default": true }, "licenseTypes": { "title": "Licence type filter", "type": "array", "description": "Optional. Keep only these licence types (as they appear in the dataset's LICENSE TYPE column, e.g. \"A/C Contractor\"). Each programme is already one licence type, so this is rarely needed. Note: filtering makes the run a partial read, so no snapshot is written and removals are not reported.", "default": [], "items": { "type": "string" } }, "snapshotStoreName": { "title": "Snapshot store name", "type": "string", "description": "Named key-value store, in your account, holding the previous run's index for change detection. Keep the same name between runs.", "default": "state-license-snapshots" }, "maxRecordsPerProgram": { "title": "Max records per programme", "minimum": 1, "type": "integer", "description": "Safety cap. Hitting it makes the run a partial read: no snapshot is written and removals are not reported.", "default": 200000 }, "pageSize": { "title": "Rows per request", "minimum": 1, "maximum": 50000, "type": "integer", "description": "How many licences to ask the open-data API for in each request while paging through a programme. The default suits almost everyone.", "default": 1000 }, "requestDelaySecs": { "title": "Delay between requests (seconds)", "minimum": 1, "type": "integer", "description": "Minimum gap between two requests to the data portal. Never goes below 1 second, and the portal's own robots.txt Crawl-delay wins whenever it is longer.", "default": 1 } } }, "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 } } } } } } } } } }