{ "openapi": "3.0.1", "info": { "title": "Sunbiz Florida & Multi-State Business Registry Scraper", "description": "Search US state business registries for company records. Florida (Sunbiz) with all nine search types, plus Arkansas, Colorado, Delaware, Idaho, Iowa, Maryland, New Jersey, New York, North Dakota, Rhode Island and South Carolina.", "version": "0.1", "x-build-id": "wgSHzd0DdoEQ0TELH" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/parseforge~sunbiz-florida-business-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-parseforge-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/parseforge~sunbiz-florida-business-scraper/runs": { "post": { "operationId": "runs-sync-parseforge-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/parseforge~sunbiz-florida-business-scraper/run-sync": { "post": { "operationId": "run-sync-parseforge-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", "required": [ "searchTerm" ], "properties": { "searchType": { "title": "Search Type", "enum": [ "EntityName", "DocumentNumber", "RegisteredAgent", "OfficerOrRegisteredAgent", "FeiNumber", "Trademark", "TrademarkOwner", "ZipCode", "StreetAddress" ], "type": "string", "description": "The type of search to run. 'EntityName' is the only one every covered state offers; the others are supported by Florida and by some of the other registries.", "default": "EntityName" }, "states": { "title": "States", "uniqueItems": true, "type": "array", "description": "Which state registries to search, as two-letter codes. Defaults to Florida only, so an existing task keeps behaving exactly as before. Covered today: AL, AR, CO, DE, FL, GA, IA, ID, MD, MN, ND, NJ, NY, RI, SC, SD, TX, WI, WY. A code that is not covered yet is reported in the log with the measured reason, instead of failing the run.", "default": [ "FL" ], "items": { "type": "string" } }, "searchTerm": { "title": "Business name or keyword", "type": "string", "description": "The search query. For EntityName, a company name (e.g. 'Meta'). For DocumentNumber, the document or file number. For ZipCode, a 5-digit zip. For StreetAddress, a street address. Not every state offers every search type; the log says which ones were skipped." }, "maxItems": { "title": "Maximum businesses", "minimum": 1, "type": "integer", "description": "Maximum number of businesses to collect per run.", "default": 10 }, "includeDetails": { "title": "Include Full Details", "type": "boolean", "description": "Fetch the full detail page for each result, including addresses, registered agent, officers, annual reports, and document images. Slower but more comprehensive.", "default": true }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy used for every registry request. Several state registries block datacenter ranges outright; switch to residential if a state reports HTTP 403 in the log.", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }