{ "openapi": "3.0.1", "info": { "title": "US Secretary of State Business Search – 11 States, LLC & Corp", "description": "Search US business entities (LLCs, corporations, nonprofits, partnerships) across 11 states incl. Florida, New York and Virginia, from official Secretary of State open data: entity number, status, formation date, registered agent, address, officers and source links.", "version": "1.0", "x-build-id": "7d2kChK3gXbuQBL1R" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/exuberantly_inventiveness~us-sos-business-entities/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-exuberantly_inventiveness-us-sos-business-entities", "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/exuberantly_inventiveness~us-sos-business-entities/runs": { "post": { "operationId": "runs-sync-exuberantly_inventiveness-us-sos-business-entities", "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/exuberantly_inventiveness~us-sos-business-entities/run-sync": { "post": { "operationId": "run-sync-exuberantly_inventiveness-us-sos-business-entities", "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": { "businessName": { "title": "Business name", "type": "string", "description": "Name (or part of a name) to search for, e.g. \"Blue Ridge\". Leave empty to use list mode with the filters below." }, "states": { "title": "States", "type": "array", "description": "Leave empty for the default: all entity states except Florida (entities mode), CO/CT/OR (liens mode), or all license sources (licenses mode). FL is opt-in: it scans the State's 1.8 GB official bulk file (about 1.5-5 minutes). IL, DE, WA, LA and CA are only available in licenses mode.", "items": { "type": "string", "enum": [ "NY", "CO", "CT", "OR", "PA", "TX", "VA", "DC", "AK", "IA", "FL", "IL", "DE", "WA", "LA", "CA" ], "enumTitles": [ "New York", "Colorado", "Connecticut", "Oregon", "Pennsylvania", "Texas", "Virginia", "District of Columbia", "Alaska", "Iowa", "Florida (opt-in, slow)", "Illinois (licenses mode: Chicago)", "Delaware (licenses mode)", "Washington (licenses mode: Seattle)", "Louisiana (licenses mode: New Orleans)", "California (licenses mode: Berkeley, Marin County)" ] } }, "status": { "title": "Status", "enum": [ "any", "active", "active_or_delinquent", "inactive" ], "type": "string", "description": "Filter by normalized status (status_std). Note: NY, OR, PA, TX and IA publish active entities only.", "default": "any" }, "mode": { "title": "Mode", "enum": [ "entities", "liens", "licenses" ], "type": "string", "description": "\"liens\" searches official UCC/lien open data by business debtor name in CO, CT and OR and returns one record per lien.", "default": "entities" }, "outputMode": { "title": "Output mode", "enum": [ "human", "agent" ], "type": "string", "description": "Agent mode returns every field and appends one record_type \"coverage\" item (states queried, results per state, skipped states, completed/no_match/failed per query). The same coverage object is always saved to the key-value store as COVERAGE.", "default": "human" }, "businessNames": { "title": "More business names", "type": "array", "description": "Search several names in one run (each matched with the same match mode).", "items": { "type": "string" } }, "entityNumbers": { "title": "Entity numbers", "type": "array", "description": "State file / entity / registry numbers (e.g. NY DOS ID, CO entity ID, VA SCC ID, TX SOS file number or taxpayer number). Leading zeros are optional.", "items": { "type": "string" } }, "matchMode": { "title": "Name match", "enum": [ "contains", "startsWith", "exact" ], "type": "string", "description": "How business names are matched.", "default": "contains" }, "entityTypes": { "title": "Entity types", "type": "array", "description": "Filter by normalized type (entity_type_std). Empty = all.", "items": { "type": "string", "enum": [ "llc", "corporation", "nonprofit", "partnership", "llp", "cooperative", "trust", "name_registration", "other" ], "enumTitles": [ "LLC", "Corporation", "Nonprofit", "Limited/general partnership", "LLP / LLLP", "Cooperative", "Trust", "Name registration / reservation", "Other" ] } }, "formedAfter": { "title": "Formed on/after", "type": "string", "description": "YYYY-MM-DD. With no name this gives a list of newly formed businesses (lead lists)." }, "formedBefore": { "title": "Formed on/before", "type": "string", "description": "YYYY-MM-DD." }, "city": { "title": "City", "type": "string", "description": "Principal / mailing city (exact, case-insensitive)." }, "zip": { "title": "ZIP code (prefix)", "type": "string", "description": "ZIP or ZIP prefix, e.g. 80202 or 802." }, "includeOfficers": { "title": "Include officers / principals (names and titles only)", "type": "boolean", "description": "CT, VA, PA, OR and NY publish officer names. Addresses of people are never output.", "default": true }, "includeHistory": { "title": "Include filing / name history (CT, CO)", "type": "boolean", "description": "CT: filing history and former names; CO: filing history and trade names.", "default": true }, "includeLiens": { "title": "Attach UCC liens (CO, CT, OR)", "type": "boolean", "description": "Attach ucc_filings and ucc_summary to CO, CT and OR entities whose exact name matches a business debtor in official UCC open data.", "default": false }, "includeLicenses": { "title": "Attach business licenses (CO Denver, OR OLCC)", "type": "boolean", "description": "Attach official license records whose licensee or trade name exactly matches the entity name.", "default": false }, "includeEmails": { "title": "Include business email (CT)", "type": "boolean", "description": "Connecticut publishes a business email address on its business master file.", "default": false }, "maxResultsPerState": { "title": "Max results per state", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Maximum number of entities returned per state.", "default": 100 }, "maxItems": { "title": "Max results in total", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "Max results in total", "default": 1000 }, "maxScanRowsPerState": { "title": "Max source rows scanned per state", "minimum": 1000, "maximum": 2000000, "type": "integer", "description": "Safety cap for broad queries (rows read from the state's API before filters like status/type).", "default": 20000 }, "maxConcurrency": { "title": "States searched in parallel", "minimum": 1, "maximum": 12, "type": "integer", "description": "States searched in parallel", "default": 10 }, "refreshCache": { "title": "Force refresh of AK/IA index", "type": "boolean", "description": "Alaska and Iowa are served from a prebuilt index of their official bulk files, rebuilt automatically when older than 7 days. Tick to rebuild now (adds about 70 s).", "default": false }, "stateTimeoutSecs": { "title": "Time limit per state (s)", "minimum": 0, "type": "integer", "description": "A state that takes longer returns what it has so far with status \"partial\". 0 = no limit. Florida and cache rebuilds are exempt.", "default": 30 }, "maxRunSecs": { "title": "Time limit for the whole run (seconds)", "minimum": 0, "type": "integer", "description": "The run stops searching after this many seconds and returns the results found so far, marked partial in COVERAGE. It also always stops ~45 s before the run's own timeout. 0 = no limit (only the run timeout applies).", "default": 300 } } }, "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 } } } } } } } } } }