{ "openapi": "3.0.1", "info": { "title": "Florida Sunbiz Business Extractor", "description": "Florida Sunbiz business scraper that pulls company records from the state registry by business name, officer, FEI/EIN or document number, so you get filing details, addresses, registered agents, officers and annual reports as JSON, CSV or Excel.", "version": "0.0", "x-build-id": "Ur5NTmMJ05KRzVUgg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/kawsar~florida-sunbiz-business-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-kawsar-florida-sunbiz-business-extractor", "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/kawsar~florida-sunbiz-business-extractor/runs": { "post": { "operationId": "runs-sync-kawsar-florida-sunbiz-business-extractor", "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/kawsar~florida-sunbiz-business-extractor/run-sync": { "post": { "operationId": "run-sync-kawsar-florida-sunbiz-business-extractor", "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": { "searchType": { "title": "Search by", "enum": [ "entityName", "officerOrAgentName", "feiEinNumber", "documentNumber" ], "type": "string", "description": "How the values in Search terms should be looked up in the Florida business registry.", "default": "entityName" }, "searchTerms": { "title": "Search terms", "type": "array", "description": "Business names, officer names, FEI/EIN numbers or document numbers to look up. Each value runs as its own search.", "items": { "type": "string" } }, "nameMatchMode": { "title": "Name match mode", "enum": [ "startsWith", "exact", "any" ], "type": "string", "description": "Applies to business name and officer name searches. The registry returns an alphabetical window of names around your term, so 'Starts with' keeps only the names that begin with it, 'Exact' keeps only a full match, and 'Any' keeps every returned row. Punctuation and spacing are ignored when matching. FEI/EIN searches always require an exact number match.", "default": "startsWith" }, "statusFilter": { "title": "Registration status", "enum": [ "all", "active", "inactive" ], "type": "string", "description": "Keep only active businesses, only inactive ones, or everything.", "default": "all" }, "includeEntityDetails": { "title": "Open each record", "type": "boolean", "description": "Open the full registry record for every hit to collect addresses, officers, agent details and filings. Turn this off for a fast name, document number and status list.", "default": false }, "includeOfficers": { "title": "Include officers and managers", "type": "boolean", "description": "Collect officers, directors, managers, authorized persons or general partners with their titles and addresses.", "default": false }, "includeAnnualReports": { "title": "Include annual reports", "type": "boolean", "description": "Collect the annual report years and the date each one was filed.", "default": false }, "includeFilingHistory": { "title": "Include filed document list", "type": "boolean", "description": "Collect the filed document history with dates and direct PDF links.", "default": false }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Maximum number of records to save per run. Result pages hold 20 rows each and the actor keeps paging on its own until this limit is filled or the results run out.", "default": 20 }, "requestTimeoutSecs": { "title": "Request timeout (seconds)", "minimum": 5, "maximum": 120, "type": "integer", "description": "Per-request timeout in seconds.", "default": 30 } } }, "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 } } } } } } } } } }