{ "openapi": "3.0.1", "info": { "title": "New York Cosmetology & Barber Licenses - NYS DOS Registry", "description": "New York State appearance-enhancement and barber licenses from NYS DOS (public open data): cosmetologists, barbers, nail specialists, estheticians, waxers and natural-hair stylists, plus the licensed shops and area renters. Verify a license or screen by type, name or expiry.", "version": "0.0", "x-build-id": "L3CadszQQGpQG4kJu" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/j0401~ny-appearance-barber/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-j0401-ny-appearance-barber", "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/j0401~ny-appearance-barber/runs": { "post": { "operationId": "runs-sync-j0401-ny-appearance-barber", "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/j0401~ny-appearance-barber/run-sync": { "post": { "operationId": "run-sync-j0401-ny-appearance-barber", "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": { "corpus": { "title": "Register", "enum": [ "individual", "business" ], "type": "string", "description": "individual = licensed operators, apprentices and trainees (221k, default). business = licensed shops and area renters, with business name, address and city (32.5k).", "default": "individual" }, "name": { "title": "Name (contains)", "type": "string", "description": "Substring match on the holder name (and, on the business register, the business name too). e.g. 'GOLDSMITH'. Blank = any.", "default": "" }, "licenseType": { "title": "License type", "enum": [ "", "Appearance Enhancement Operator - Cosmetology", "Appearance Enhancement Operator - Nail Specialty", "Appearance Enhancement Operator - Esthetics", "Barber - Operator", "Appearance Enhancement Operator - Waxing", "Barber - Apprentice", "Appearance Enhancement Operator - Cosmetology (Temporary)", "Appearance Enhancement Operator - Esthetics (Temporary)", "Appearance Enhancement Operator - Nail Specialty (Temporary)", "Appearance Enhancement - Nail Specialty Trainee", "Appearance Enhancement Operator - Natural Hair Styling", "Appearance Enhancement Operator - Waxing (Temporary)", "Appearance Enhancement Operator - Natural Hair Styling (Temporary)", "DOSAEBUSINESS", "DOSAERENTER", "DOSBARSHOPOWNER", "DOSBARRENTER" ], "type": "string", "description": "The license type. The individual register uses readable labels ('Barber - Operator'); the business register uses four DOS codes. Matched exactly, so pick the values that belong to your corpus. Blank = any.", "default": "" }, "licenseNumber": { "title": "License number", "type": "string", "description": "Exact license number, e.g. 'BO-15-00043', 'AEB-26-01999'. Blank = any.", "default": "" }, "city": { "title": "Business city (contains)", "type": "string", "description": "Substring match on the business city (business register only), e.g. 'Brooklyn', 'Buffalo', 'Rochester'. Blank = any.", "default": "" }, "zip": { "title": "Business ZIP", "type": "string", "description": "Exact business ZIP code (business register only), e.g. '11206'. Blank = any.", "default": "" }, "state": { "title": "Business state", "type": "string", "description": "Exact business state (business register only), e.g. 'NY'. Blank = any.", "default": "" }, "expiresFrom": { "title": "Expires on or after", "type": "string", "description": "Earliest expiration date, YYYY-MM-DD. Blank = any.", "default": "" }, "expiresTo": { "title": "Expires on or before", "type": "string", "description": "Latest expiration date, YYYY-MM-DD. Blank = any.", "default": "" }, "mode": { "title": "Mode", "enum": [ "rows", "aggregate" ], "type": "string", "description": "rows = license records matching your filters (default). aggregate = one count row per group (see groupBy).", "default": "rows" }, "groupBy": { "title": "Aggregate by", "enum": [ "", "licenseType", "businessState" ], "type": "string", "description": "Which dimension to aggregate over (mode=aggregate). Blank = licenseType. businessState is business-register only - clear it when switching corpus. Every group is returned.", "default": "" }, "maxResults": { "title": "Max records", "minimum": 0, "type": "integer", "description": "Cap the number of records pushed in rows mode (0 = default 50; up to 2,000 per run). Each record is metered individually, so there is no per-run charge cap. Aggregate mode returns every group.", "default": 50 } } }, "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 } } } } } } } } } }