{ "openapi": "3.0.1", "info": { "title": "Florida Sunbiz Registry Lookup by Name, Agent & FEI", "description": "Look up Florida business entities on the Sunbiz registry by entity name, officer, registered agent, FEI/EIN, document number, ZIP, or street address, and get status, addresses, officers, annual filings, and filed-document links for each match.", "version": "1.0", "x-build-id": "F4m9LT3xJs3dnKZtM" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dataspryva~florida-sunbiz-registry-lookup-by-name-agent/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dataspryva-florida-sunbiz-registry-lookup-by-name-agent", "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/dataspryva~florida-sunbiz-registry-lookup-by-name-agent/runs": { "post": { "operationId": "runs-sync-dataspryva-florida-sunbiz-registry-lookup-by-name-agent", "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/dataspryva~florida-sunbiz-registry-lookup-by-name-agent/run-sync": { "post": { "operationId": "run-sync-dataspryva-florida-sunbiz-registry-lookup-by-name-agent", "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": [ "searchType" ], "properties": { "searchType": { "title": "Search type", "enum": [ "entityName", "officerOrRegisteredAgent", "registeredAgentName", "feiEinNumber", "documentNumber", "zipCode", "address", "trademarkName", "trademarkOwnerName" ], "type": "string", "description": "Which Sunbiz index to search. Applies to the values in `searchTerms`; pasted `startUrls` are fetched directly.", "default": "entityName" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "One or more values for the selected `searchType` (entity names, officer/agent names, FEI/EIN digits, document numbers, ZIP codes, street addresses, or trademark terms). Sunbiz matches names/addresses from the start of its ordered index and returns the nearest entries when there is no exact match; `documentNumber` is the only exact lookup.", "items": { "type": "string" } }, "startUrls": { "title": "Sunbiz URLs", "type": "array", "description": "Optional Sunbiz detail or search-results URLs to fetch directly. You can mix URLs with `searchTerms` in one run.", "items": { "type": "object" } }, "entityStatus": { "title": "Filter by entity status", "enum": [ "any", "active", "inactive" ], "type": "string", "description": "Only emit entities with this status. Determined from each entity's detail page.", "default": "any" }, "entityType": { "title": "Filter by entity type", "enum": [ "any", "corporation", "llc", "trademark", "partnership", "nonprofit" ], "type": "string", "description": "Keep only this kind of filing. Useful for hiding trademarks and nearest-name neighbours.", "default": "any" }, "includeEventHistory": { "title": "Include event and name history", "type": "boolean", "description": "Fetch each entity's full filing-event trail (amendments, mergers, reinstatements, dissolutions, old names). Adds one request per entity that has events.", "default": true }, "mirrorFiledDocuments": { "title": "Filed document PDFs", "enum": [ "none", "newest", "all" ], "type": "string", "description": "Save copies of filed documents to Apify storage and add a permanent `pdfUrl` to each `filedDocuments` entry. `all` mirrors up to the 20 newest documents per entity.", "default": "none" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on emitted records across all search terms and URLs. Each record requires a detail-page fetch.", "default": 20 } } }, "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 } } } } } } } } } }