{ "openapi": "3.0.1", "info": { "title": "CA DIR Registrations: Car Wash, Janitorial, Garment, Farm Labor", "description": "Every California DIR labor registration in one deduplicated dataset: car wash, farm labor contractor, garment, janitorial, talent agency, and entertainment permits for minors, one record per registrant with all registrations, statuses, dates, addresses, and workers' comp carriers.", "version": "0.5", "x-build-id": "Udb4xQPPlLDw4ZMNz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/overlookdata~ca-dir-registration-search/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-overlookdata-ca-dir-registration-search", "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/overlookdata~ca-dir-registration-search/runs": { "post": { "operationId": "runs-sync-overlookdata-ca-dir-registration-search", "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/overlookdata~ca-dir-registration-search/run-sync": { "post": { "operationId": "run-sync-overlookdata-ca-dir-registration-search", "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": { "registrationTypes": { "title": "Registration types", "type": "array", "description": "Pick the registration programs to sweep. Leave empty to sweep all six.", "items": { "type": "string", "enum": [ "Car Wash", "Farm Labor Contractor", "Garment Manufacturers and Contractors", "Janitorial", "Talent Agency", "Permit to Employ Minors" ], "enumTitles": [ "Car Wash", "Farm Labor Contractor", "Garment Manufacturers and Contractors", "Janitorial", "Talent Agency", "Entertainment Permit to Employ Minors" ] }, "default": [] }, "statuses": { "title": "Registration statuses", "type": "array", "description": "Keep only registrations with these statuses. Leave empty to keep every status, including expired and closed history. These are DIR's own stored status values.", "items": { "type": "string", "enum": [ "Approved", "Renewed", "Temporary Approved", "Expired", "Closed - Renewed", "Closed - Denied", "Closed - Revoked", "Closed - Suspended", "Closed_Suspended" ], "enumTitles": [ "Approved", "Renewed", "Temporary Approved", "Expired", "Closed - Renewed", "Closed - Denied", "Closed - Revoked", "Closed - Suspended", "Closed_Suspended" ] }, "default": [] }, "outputMode": { "title": "Output mode", "enum": [ "registrants", "registrations" ], "type": "string", "description": "One record per registrant with all of its registrations attached, or one flat record per individual registration.", "default": "registrants" }, "includeDetails": { "title": "Include detail pages (DBAs, branch locations, bonds)", "type": "boolean", "description": "Fetch the DIR detail page for the newest registration of every registrant (or for every registration in registrations mode). This multiplies the request count by roughly the number of output records and makes a full sweep much slower, so leave it off unless you need DBA names, branch addresses, or bond history.", "default": false }, "verifyCoverage": { "title": "Verify coverage with a second sweep", "type": "boolean", "description": "Sweep a second time by expiration date and compare the record IDs against the effective-date sweep. The comparison is written to the VERIFICATION record in the default key-value store.", "default": true }, "firstYear": { "title": "First year to sweep", "minimum": 1990, "maximum": 2030, "type": "integer", "description": "Lower bound of the date slices. DIR's oldest registrations start in 1990; raise this to sweep only recent years.", "default": 1990 }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 0, "type": "integer", "description": "Politeness delay each worker waits after a request.", "default": 250 }, "maxConcurrency": { "title": "Max concurrency", "minimum": 1, "maximum": 6, "type": "integer", "description": "Maximum number of simultaneous requests to DIR.", "default": 2 } } }, "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 } } } } } } } } } }