{ "openapi": "3.0.1", "info": { "title": "NY Business Registry Scraper", "description": "Search active New York business entities by name or DOS ID using official NY Open Data. Returns entity type, jurisdiction, addresses, historical-name matches, and optional recent filings for due diligence. Not for ownership, name availability, legal advice, or certified records. $0.005 per entity.", "version": "1.0", "x-build-id": "TkYrb5sFqERMPuHLH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~ny-business-registry-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-ny-business-registry-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/muhammadafzal~ny-business-registry-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-ny-business-registry-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/muhammadafzal~ny-business-registry-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-ny-business-registry-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", "required": [ "searchTerms" ], "properties": { "searchTerms": { "title": "Business names or DOS IDs", "type": "array", "description": "Use this when looking up New York business entities by current or historical name, or by DOS ID when searchBy is set to dosId. Enter one value per line, for example 'ACME HOLDINGS' or '1234567'. Defaults to a small sample query. This is not a street address, owner lookup, or federal EIN search.", "items": { "type": "string", "minLength": 1, "maxLength": 120 }, "default": [ "WEWORK" ] }, "searchBy": { "title": "Search by", "enum": [ "name", "dosId" ], "type": "string", "description": "Use this to choose whether each search term is matched against an entity name or a New York Department of State ID. Name searches support contains, begins-with, and exact matching. DOS IDs are matched exactly and are not business names.", "default": "name" }, "matchMode": { "title": "Name match mode", "enum": [ "contains", "beginsWith", "exact" ], "type": "string", "description": "Use this to control name matching when searchBy is name: contains finds the term anywhere, beginsWith finds names starting with it, and exact requires the full current or historical name. Defaults to contains. This setting is ignored for DOS ID searches.", "default": "contains" }, "maxResultsPerSearch": { "title": "Maximum entities per search", "minimum": 1, "maximum": 100, "type": "integer", "description": "Use this to cap unique entity records returned for each search term. Enter a number from 1 to 100. Defaults to 25. This limit is applied before deduplication across multiple search terms.", "default": 25 }, "includeHistoricalNames": { "title": "Match historical and assumed names", "type": "boolean", "description": "Use this to include entities found through New York's name-status history dataset, then resolve them to current active entity records. Defaults to true for name searches. It does not expose private ownership information or inactive entities that have no current active record.", "default": true }, "includeFilings": { "title": "Include recent filings", "type": "boolean", "description": "Use this to attach recent filing records such as articles, amendments, biennial statements, or dissolutions. Defaults to false to keep agent output concise. Filings are public records and are not a substitute for certified copies.", "default": false }, "maxFilingsPerEntity": { "title": "Maximum filings per entity", "minimum": 1, "maximum": 20, "type": "integer", "description": "Use this to cap recent filings attached to each entity when includeFilings is true. Enter a number from 1 to 20. Defaults to 5. This is not a cap on the entity search results.", "default": 5 }, "requestDelayMs": { "title": "Delay between API requests (milliseconds)", "minimum": 100, "maximum": 5000, "type": "integer", "description": "Use this to pace requests to the official NY Open Data API. Enter 100 to 5000 milliseconds. Defaults to 250 milliseconds. This is a courtesy delay, not a run timeout or concurrency setting.", "default": 250 } } }, "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 } } } } } } } } } }