Get Roof RWF

This endpoint uses Hover’s algorithm recommendation to return a roof waste percentage for input measurements.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Overview

This endpoint provides Hover's algorithmic recommendation for roof waste percentage, based on the input measurements of a given roof. This recommendation, referred to as the Roof Recommended Waste Factor (RWF), helps in estimating the necessary material quantities for roofing projects.

Usage

The RWF is calculated using specific roof measurements that can be extracted from the JSON artifact of a Hover model. It is recommended to utilize the following fields from the Hover JSON artifact to construct your request body:

  • Step Flashing (linear feet): step_flashing
  • Valleys (linear feet): valleys
  • Hips (linear feet): ridges_hips
  • Rakes (linear feet): rakes
  • Roof Square Feet: roof_facets.area

Request Body Example

Below is an example of the JSON request body required to calculate the RWF. Please ensure all linear measurements are provided in feet and the roof area in square feet.

{
  "step_flashing_linear_feet": 50.5,
  "valleys_linear_feet": 30.0,
  "hips_linear_feet": 25.0,
  "rakes_linear_feet": 40.0,
  "roof_square_feet": 1500.0
}

 

Response Body Example

The response body for this endpoint will contain a single numerical value, representing Hover's recommended waste factor for the provided roof measurements. This value is expressed as a percentage. In the example below, the recommended RWF is 7.2%.

{
   "predicted_roof_waste_factor": 7.2
}
Query Params
int32
Defaults to 1350

Required. The total square footage of the roof

int32
Defaults to 189

Required. The total area of the step_flashing of a roof.

int32
Defaults to 85

Required. The total area of the rakes of a roof.

int32
Defaults to 446

Required. The total area of the valleys of a roof.

int32
Defaults to 115

Required. The total area of the ridges_hips of a roof.

Response

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json