{
  "openapi": "3.1.0",
  "info": {
    "title": "FLGovData API",
    "version": "0.1.0",
    "description": "Orlando, Miami-Dade County and City of Miami permits, Orlando code cases and Florida contractor licenses. Free and keyless during early access. Independent service, not affiliated with any government agency."
  },
  "servers": [
    {
      "url": "https://flgovdata.com"
    }
  ],
  "paths": {
    "/api/v1/parcel-history": {
      "get": {
        "operationId": "parcelHistory",
        "summary": "Permits and code cases for an address or parcel",
        "parameters": [
          {
            "name": "q",
            "in": "query",
            "required": true,
            "description": "Street address in Orlando, Orange County or Miami-Dade County; 15-digit Orange County parcel id; or 13-digit Miami-Dade folio",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/api/v1/permits": {
      "get": {
        "operationId": "searchPermits",
        "summary": "Search permits",
        "parameters": [
          {
            "name": "trade",
            "in": "query",
            "required": false,
            "description": "One of: roofing, hvac, plumbing, electrical, solar, ev-charging, low-voltage, pool, fence, new-construction, remodel, signs, fire-protection, gas, irrigation, demolition",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "application_type",
            "in": "query",
            "required": false,
            "description": "e.g. Building Permit",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "worktype",
            "in": "query",
            "required": false,
            "description": "e.g. Roof",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "date_from",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "date_to",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "contractor",
            "in": "query",
            "required": false,
            "description": "Name substring",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "license_number",
            "in": "query",
            "required": false,
            "description": "DBPR license",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "license_check",
            "in": "query",
            "required": false,
            "description": "matched|possible_match|ambiguous|not_found|no_contractor|outside_extract",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "1-100",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "description": "Offset",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/api/v1/licenses": {
      "get": {
        "operationId": "verifyContractorLicense",
        "summary": "Florida DBPR construction and electrical contractor license lookup, with CILB discipline history",
        "parameters": [
          {
            "name": "name",
            "in": "query",
            "required": false,
            "description": "Person or business",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "number",
            "in": "query",
            "required": false,
            "description": "License number",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/api/v1/code-cases": {
      "get": {
        "operationId": "newCodeCases",
        "summary": "Code cases opened since a date",
        "parameters": [
          {
            "name": "since",
            "in": "query",
            "required": true,
            "description": "YYYY-MM-DD",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "until",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "case_type",
            "in": "query",
            "required": false,
            "description": "e.g. Housing",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "status",
            "in": "query",
            "required": false,
            "description": "Open/Closed",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "neighborhood",
            "in": "query",
            "required": false,
            "description": "Name",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/api/v1/new-businesses": {
      "get": {
        "operationId": "newFloridaBusinesses",
        "summary": "New Florida corporations, LLCs and partnerships by filing date (Florida Division of Corporations daily file; business fields only)",
        "parameters": [
          {
            "name": "since",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD (default: 7 days before latest file)",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "until",
            "in": "query",
            "required": false,
            "description": "YYYY-MM-DD",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "city",
            "in": "query",
            "required": false,
            "description": "Principal city, e.g. ORLANDO",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "zip",
            "in": "query",
            "required": false,
            "description": "5-digit ZIP",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "entity_type",
            "in": "query",
            "required": false,
            "description": "FLAL, DOMP, DOMNP, FORL, FORP, FORNP, DOMLP, FORLP",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name_contains",
            "in": "query",
            "required": false,
            "description": "Name substring",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "florida_only",
            "in": "query",
            "required": false,
            "description": "true to exclude out-of-state principal addresses",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "in": "query",
            "required": false,
            "description": "1-200",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "description": "Offset",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/api/v1/leads/miami-dade": {
      "get": {
        "operationId": "miamiDadeLeads",
        "summary": "Last 7 days of Miami-Dade County and City of Miami permits by trade (street numbers masked)",
        "parameters": [
          {
            "name": "source",
            "in": "query",
            "required": false,
            "description": "miami-dade | miami",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    },
    "/api/v1/leads/orlando": {
      "get": {
        "operationId": "orlandoLeads",
        "summary": "Last 7 days of permits by trade (street numbers masked) and code cases",
        "parameters": [
          {
            "name": "trade",
            "in": "query",
            "required": false,
            "description": "Trade slug",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          },
          "429": {
            "description": "Rate limited"
          }
        }
      }
    }
  }
}