{
  "openapi": "3.0.1",
  "info": {
    "title": "Sunbiz Scraper | Florida Companies and Officers",
    "description": "Sunbiz scraper for the Florida company register: search by name, document number, FEI/EIN, officer, ZIP code or address and get status, entity type, filing dates, addresses, registered agent, officers, annual reports and filing history. 100 companies in 22 seconds, 41 fields each. No login.",
    "version": "1.0",
    "x-build-id": "fxH5Q87PpnazDB0Pi"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/silentflow~sunbiz-scraper/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-silentflow-sunbiz-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/silentflow~sunbiz-scraper/runs": {
      "post": {
        "operationId": "runs-sync-silentflow-sunbiz-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/silentflow~sunbiz-scraper/run-sync": {
      "post": {
        "operationId": "run-sync-silentflow-sunbiz-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": {
          "searches": {
            "title": "🔎 Company names",
            "type": "array",
            "description": "The name of a Florida company or its first words: <code>coffee</code> returns every company whose name starts with Coffee, active or not, from Coffee Inc. to Coffee Zone LLC. Words like The, Company, Inc. and LLC are ignored, as on Sunbiz. A document number or an FEI/EIN typed here is looked up directly.",
            "items": {
              "type": "string"
            }
          },
          "companyIds": {
            "title": "🆔 Document or FEI/EIN numbers",
            "type": "array",
            "description": "Florida document numbers (<code>L11000136827</code>, <code>P21000012345</code>, <code>G43672</code>) or 9-digit FEI/EIN numbers (<code>45-3989054</code>, with or without the dash). One row per company found; a number Sunbiz does not know is skipped and named in the log.",
            "items": {
              "type": "string"
            }
          },
          "startUrls": {
            "title": "🔗 Sunbiz URLs",
            "type": "array",
            "description": "Paste a search.sunbiz.org result list (a name, officer, registered agent, ZIP code, street address or FEI/EIN search, first page or a later one) or a company page. Lists are read page after page until the matches end.",
            "items": {
              "type": "object",
              "required": [
                "url"
              ],
              "properties": {
                "url": {
                  "type": "string",
                  "title": "URL of a web page",
                  "format": "uri"
                }
              }
            }
          },
          "officerNames": {
            "title": "👤 Officer or registered agent names",
            "type": "array",
            "description": "Last name first, as Sunbiz lists them: <code>Smith, John</code>. Returns every company where this person or company is an officer, director, manager, partner or registered agent; the <code>matchedName</code> column shows the name it was found under. A last name alone works too, but returns many more companies.",
            "items": {
              "type": "string"
            }
          },
          "zipCodes": {
            "title": "📍 ZIP codes",
            "type": "array",
            "description": "5-digit ZIP codes: <code>33139</code>. Returns every company Sunbiz files under this ZIP code, active and inactive alike: a busy Miami ZIP holds tens of thousands. A ZIP+4 is searched by its first 5 digits.",
            "items": {
              "type": "string"
            }
          },
          "streetAddresses": {
            "title": "🏢 Street addresses",
            "type": "array",
            "description": "A street address as it is written on the filings: <code>10220 W State Road 84</code>. Returns every company registered at this address, every suite included: useful for a building, a coworking space or a registered agent's office.",
            "items": {
              "type": "string"
            }
          },
          "status": {
            "title": "✅ Status",
            "enum": [
              "all",
              "active",
              "inactive"
            ],
            "type": "string",
            "description": "<b>All</b> returns every company the search finds, the way Sunbiz lists them. <b>Active</b> keeps companies in good standing today, ready for outreach. <b>Inactive</b> keeps dissolved, revoked and withdrawn ones. Number lookups follow the filter too.",
            "default": "all"
          },
          "maxItems": {
            "title": "🔢 Max companies per input",
            "minimum": 1,
            "maximum": 100000,
            "type": "integer",
            "description": "The most companies each name, number, person, ZIP code, address or URL returns. The run stops reading as soon as it is reached, so a small number gives a quick sample: 100 companies take about 20 seconds.",
            "default": 100
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}