{ "openapi": "3.0.1", "info": { "title": "Sunbiz Florida Business Record Scraper", "description": "Read-only Florida Sunbiz business scraper. Search by company name, FEI/EIN, officer, registered agent, address, or ZIP and return structured public registry records.", "version": "1.0", "x-build-id": "oXzmrXy7tV6A4rmpX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/muhammadafzal~sunbiz-florida-business-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-muhammadafzal-sunbiz-florida-business-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~sunbiz-florida-business-scraper/runs": { "post": { "operationId": "runs-sync-muhammadafzal-sunbiz-florida-business-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~sunbiz-florida-business-scraper/run-sync": { "post": { "operationId": "run-sync-muhammadafzal-sunbiz-florida-business-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": { "searchTerms": { "title": "Search terms", "type": "array", "description": "Use this for one or more Florida registry lookups. Enter a business name such as 'Disney', an FEI/EIN, an officer or agent name, a street address, or a ZIP code depending on searchType. Each term is trimmed to Sunbiz's 45-character limit. Defaults to 'Disney'. This is not a general web search.", "items": { "type": "string", "minLength": 1, "maxLength": 200 }, "default": [ "Disney" ] }, "searchType": { "title": "Search type", "enum": [ "entityName", "officerOrRegisteredAgent", "registeredAgent", "feiNumber", "address", "zipCode" ], "type": "string", "description": "Use entityName for company names, officerOrRegisteredAgent or registeredAgent for people and agents, feiNumber for FEI/EIN, address for street address, or zipCode for ZIP. The selected type applies to every searchTerms value and is not a detail-page filter.", "default": "entityName" }, "startUrls": { "title": "Sunbiz URLs", "type": "array", "description": "Use this when you already have an official Sunbiz search-results or business-detail URL. URLs must begin with https://search.sunbiz.org/Inquiry/CorporationSearch/. This is not a filing or payment URL; the actor never submits state-changing forms.", "items": { "type": "object", "properties": { "url": { "type": "string", "title": "Sunbiz URL", "description": "An official Sunbiz search-results or SearchResultDetail URL." } }, "required": [ "url" ] }, "default": [] }, "maxResults": { "title": "Maximum business records", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Use this to cap stored business records and result-event charges. Enter 1 to 1,000; the fast default is 1. Request more records explicitly for larger batches. This is a record limit, not a page limit.", "default": 1 }, "includeFilingHistory": { "title": "Include annual reports", "type": "boolean", "description": "Use true when you need the annualReports array from each detail page. Set false for smaller records when you only need identity, status, address, agent, and officer fields. This does not download document images or submit filings.", "default": false }, "requestDelayMs": { "title": "Delay between requests (ms)", "minimum": 500, "maximum": 5000, "type": "integer", "description": "Use this to pace read-only requests to the public registry. Allowed values are 500 to 5,000 milliseconds; the default is 1,000. This is not a run-timeout setting.", "default": 500 } } }, "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 } } } } } } } } } }