# Get Lead Value - Roof

Endpoint: GET /api/v1/roof-estimate
Version: 1.0.0

## Header parameters:

  - `Accept` (string)
    Example: "application/json"

  - `token` (string)
    Example: "{API Key}"

## Query parameters:

  - `streetNumber` (string, required)
    Lead's street number.

  - `streetAddress` (string, required)
    Lead's street address.

  - `city` (string, required)
    Lead’s city name.

  - `state` (string, required)
    Lead's state name (two-letter abbreviation, e.g., NY).

  - `zip` (string, required)
    Lead’s zip code (5 digit code).

  - `roofMaterial` (string)
    Type of roofing material used in the estimation. Default value is .
    Enum: "asphalt shingle", "slate", "tile", "metal", "other"

  - `installedPrice` (number)
    Client's all-in installation price (USD) per square, including materials, labor and gross profit, for asphalt shingle roofing material used in the estimation. Default value is .
    Example: 400

## Response 200 fields (application/json):

  - `timestamp` (string)
    The timestamp when the response was returned. It is provided in ISO 8601 format.
    Example: "2024-08-20T14:30:00Z"

  - `roofArea` (number,null)
    Total roof area in square feet, adjusted for pitch.
    Example: 1250.75

  - `squaresWithPitch` (number,null)
    Roof size in "squares" (1 square = 100 sq ft), adjusted for pitch.
    Example: 12.51

  - `averageRoofPitch` (number,null)
    Average roof pitch in degrees.
    Example: 6.5

  - `roofComplexityLevel` (string,null)
    Complexity level of the roof, determined based on the number of individual roof facets detected in the structure.
    Enum: "simple", "average", "complex"

  - `roofMaterial` (string,null)
    Roofing material used in the estimation and included in an API request. If parameter is not included in an API request, then default value is used.
    Example: "asphalt shingle"

  - `installedPrice` (number,null)
    Client's all-in installation price (USD) per square for asphalt shingle roofing material used in the estimation and included in an API request. If parameter is not included in an API request, then default value is used.
    Example: 400

  - `roofCostEstimate` (number,null)
    Final estimated total cost of the roofing project (USD).
    Example: 5318.19

  - `structurePresentConfidenceScore` (number,null)
    Confidence score that the structure matches the input address.
    Enum: 50, 100

  - `dataAccurcyAlerts` (object)

  - `dataAccurcyAlerts.roofPitchAlert` (string,null)
    Roof pitch alert indicating if the  is unusually low or high.
    Enum: "LOW_PITCH", "HIGH_PITCH", "NO_ALERTS"

  - `dataAccurcyAlerts.roofAreaAlert` (string,null)
    Roof area alert indicating if the  is unusually small or large.
    Enum: "LOW_AREA", "HIGH_AREA", "NO_ALERTS"

## Response 400 fields (application/json):

  - `error` (string)
    Example: "Bad Request"

  - `statusCode` (integer)
    Example: 400

  - `message` (array)
    Example: ["state must be a string","state should not be empty","installedPrice value must be a decimal greater than 0 with at most 2 decimal places"]

## Response 401 fields (application/json):

  - `error` (string)
    Example: "Unauthorized"

  - `statusCode` (integer)
    Example: 401

  - `message` (string)
    Example: "Invalid API Key"

## Response 404 fields (application/json):

  - `error` (string)
    Example: "Not Found"

  - `statusCode` (integer)
    Example: 404

  - `message` (string)
    Example: "Cannot GET /api/v1/roof-estimate"

## Response 500 fields (application/json):

  - `error` (string)
    Example: "Internal Server Error"

  - `statusCode` (integer)
    Example: 500

  - `message` (string)
    Example: "Unexpected server error occurred. Please try again later."