{ "openapi": "3.0.1", "info": { "title": "Secretary of State Business Entity Search Scraper (multi-state)", "description": "Secretary of State Business Entity Search Scraper (multi-state) SD - Secretary of State Business Entity Search Scraper (multi-state) is a KYB tool that extracts US business entities from official state registries: status, type, filing date, agent, addresses, officers. No login.", "version": "1.0", "x-build-id": "csjGOwmkaDM7hdSSd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/neuro-scraper~secretary-of-state-business-entity-search-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-neuro-scraper-secretary-of-state-business-entity-search-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/neuro-scraper~secretary-of-state-business-entity-search-scraper/runs": { "post": { "operationId": "runs-sync-neuro-scraper-secretary-of-state-business-entity-search-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/neuro-scraper~secretary-of-state-business-entity-search-scraper/run-sync": { "post": { "operationId": "run-sync-neuro-scraper-secretary-of-state-business-entity-search-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": { "searchQueries": { "title": "Company names (bulk)", "type": "array", "description": "Business names to look up, one per line, e.g. \"Tesla\", \"Blue Bottle Coffee\". With \"Search by\" = entity number, give registry numbers instead (CO 19871596762, NY 5954532, OR 49442890, CT 2787880, TX taxpayer number 32072955472, FL document number F09000002525).", "items": { "type": "string" } }, "companyName": { "title": "Company name (single)", "type": "string", "description": "Optional single company name, e.g. \"Stripe\" - added to the list above (same field name as other SOS Actors, for easy switching)." }, "states": { "title": "States to search", "type": "array", "description": "Registries to search. CO, NY, OR, CT and TX are the state's official business-entity file on its open-data portal (NY, OR and TX publish active entities only); FL is Sunbiz.", "items": { "type": "string", "enum": [ "CO", "NY", "OR", "CT", "TX", "FL" ], "enumTitles": [ "Colorado (Secretary of State)", "New York (Department of State, active corporations)", "Oregon (Secretary of State, active businesses)", "Connecticut (Secretary of the State)", "Texas (Comptroller franchise taxpayers with SOS file number, active)", "Florida (Sunbiz)" ] }, "default": [ "CO", "NY", "FL" ] }, "searchBy": { "title": "Search by", "enum": [ "name", "id" ], "type": "string", "description": "Look up by business name, or by the registry's own entity number.", "default": "name" }, "matchMode": { "title": "Name match mode", "enum": [ "contains", "starts", "exact" ], "type": "string", "description": "How the name is matched (case-insensitive, run by the registry). Florida Sunbiz is an alphabetical index, so \"contains\" works as \"starts with\" there.", "default": "contains" }, "entityStatus": { "title": "Status", "enum": [ "all", "active", "delinquent", "inactive" ], "type": "string", "description": "Keep entities with this normalised standing (output field standing). Registries that publish active entities only (NY, OR, TX) are skipped for delinquent / inactive.", "default": "all" }, "filedFrom": { "title": "Filing date - start", "type": "string", "description": "Only entities formed / registered on or after this date (YYYY-MM-DD), e.g. 2024-01-01. Server-side on the portals; Florida needs the detail page for the date (fetched automatically)." }, "filedTo": { "title": "Filing date - end", "type": "string", "description": "Only entities formed / registered on or before this date (YYYY-MM-DD)." }, "fetchDetails": { "title": "Fetch full details (Florida)", "type": "boolean", "description": "Florida: open each entity's Sunbiz detail page (one extra request): type, filing date, FEI/EIN, addresses, registered agent, officers, annual reports and filing documents. The portal states return full records without it.", "default": true }, "includeOfficers": { "title": "Include officers / principals", "type": "boolean", "description": "Officers, directors, principals and authorized representatives where the registry publishes them (FL officers, CT principals, OR authorized representatives, NY chairman/CEO).", "default": true }, "maxResultsPerState": { "title": "Max results per state (per name)", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop each name x state search after this many entities. Pages are followed (portals 50 per page, Sunbiz 20) until this number or the registry's last match.", "default": 25 }, "maxItems": { "title": "Max results in total", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Stop the whole run after this many entities.", "default": 100 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "The registries answered logged-out requests without a challenge in tests; a US residential proxy is the default for steady runs on the Apify platform.", "default": { "useApifyProxy": true, "apifyProxyGroups": [ "RESIDENTIAL" ], "apifyProxyCountry": "US" } } } }, "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 } } } } } } } } } }