{ "openapi": "3.0.1", "info": { "title": "US State Business Registrations Scraper", "description": "Newly registered and active businesses from the official Secretary of State registries of New York, Colorado and Oregon: name, entity type, status, formation date, address, registered agent. Filter by date, city, ZIP, name and type.", "version": "0.1", "x-build-id": "rKojxYC6XMvh9nGjP" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapyx~us-business-registrations-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapyx-us-business-registrations-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/scrapyx~us-business-registrations-scraper/runs": { "post": { "operationId": "runs-sync-scrapyx-us-business-registrations-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/scrapyx~us-business-registrations-scraper/run-sync": { "post": { "operationId": "run-sync-scrapyx-us-business-registrations-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": { "states": { "title": "States", "type": "array", "description": "One search per state.", "items": { "type": "string", "enum": [ "NY", "CO", "CT", "OR" ], "enumTitles": [ "New York", "Colorado", "Connecticut", "Oregon" ] }, "default": [ "NY" ] }, "formedFrom": { "title": "Formed / filed on or after", "type": "string", "description": "YYYY-MM-DD. Use it to list NEW businesses." }, "formedTo": { "title": "Formed / filed on or before", "type": "string", "description": "YYYY-MM-DD." }, "entityTypeContains": { "title": "Entity type contains", "type": "string", "description": "e.g. 'limited liability', 'nonprofit', 'corporation'. Colorado's type codes are expanded automatically." }, "nameContains": { "title": "Name contains", "type": "string", "description": "Any case." }, "cities": { "title": "Cities", "type": "array", "description": "Exact city names, any case (NY: business location city; CO: principal city; OR: any listed address city).", "items": { "type": "string" } }, "zipCodes": { "title": "ZIP codes or prefixes", "type": "array", "description": "3-5 digits, e.g. '10001' or '100'.", "items": { "type": "string" } }, "includeInactive": { "title": "Include inactive (Colorado, Connecticut)", "type": "boolean", "description": "Colorado and Connecticut publish ended entities too (dissolved, forfeited, withdrawn...); they are excluded by default. NY and OR files hold active entities only. Connecticut name reservations and rejected filings are never returned.", "default": false }, "includeAssumedNames": { "title": "Oregon: include assumed business names (DBAs)", "type": "boolean", "description": "Trade names, not legal entities.", "default": false }, "sortBy": { "title": "Sort by", "enum": [ "newest", "oldest" ], "type": "string", "description": "Formation / filing date.", "default": "newest" }, "maxItems": { "title": "Max businesses per state", "minimum": 0, "type": "integer", "description": "0 = every match.", "default": 200 }, "minRequestInterval": { "title": "Seconds between requests", "minimum": 1, "type": "number", "description": "Never below 1 (the portals' robots.txt Crawl-delay).", "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 } } } } } } } } } }