A residential roof report is a home's roof measured by a technician from aerial imagery, delivered as a white-labeled PDF, an XML file, four diagrams and the numbers themselves on the order. It costs $10, takes about two hours, and you order it with one API call or from the dashboard.
Who is the residential report for?
Software companies and resellers that put roof measurements in front of their own users: roofing CRMs, estimating tools, insurance claims software and solar design platforms. The PDF carries your brand or the contractor's, so your users see a report from you. A contractor quoting a re-roof uses the squares, pitches and edge lengths; an adjuster takes the ESX into Xactimate; your software reads the same numbers from the order. Adding roof reports to a roofing CRM walks through one integration.
What do you get with each report?
Four kinds of output, all from the one measurement, and all included in the $10 except the ESX.
| Output | What it is |
|---|---|
| The report in the brand it was ordered with, rendered when you download it. PDF | |
| XML | The measurement document, with no branding. Every number on the order comes from it. XML |
| Diagrams | Outline, area, pitch and lengths, for the whole property and each building, as SVG or PNG from 200 to 4000 pixels. Diagrams |
| Data | Areas, squares, facets, pitches and edges on the webhook and the order. Report data |
| Xactimate ESX | +$5, on orders that include it. Downloads as <claim>.esx. ESX |
None of the file links needs an API key: the order id is the credential, so a link can go straight into an estimate or an email. What's in a roof measurement report goes through the PDF page by page.
Which measurements are in the data?
The whole roof and each building separately, in the same shape. Each carries sloped area and squares, facet count, the predominant pitch, area at each pitch, length and count for ten edge categories (eave, rake, ridge, hip, valley, step flashing, wall flashing, parapet, bend and other, always all ten), hips and ridges together, a complexity rating, an estimated attic area and every roof face with its own area, pitch and edges. Building 1 is always the largest. The PDF's tables print the same category names, so a number on the page can be found in the JSON without a lookup.
How much does it cost and how long does it take?
$10 per report, typically delivered in about two hours; the time is an estimate, not a commitment. The
Xactimate ESX adds $5, with "esx": true on the order or
added later, before or after delivery. Your account's
own prices are on GET /api/v1/reports/pricing. You prepay a balance;
there is no subscription and no minimum. If a property cannot be measured, the order is cancelled and refunded
as account credit.
How do you order one?
One POST with the address, its coordinates and a scope. In the dashboard it is Order a report, Roof report, report type Residential.
curl -X POST "https://api.roofquery.com/api/v1/reports/orders" \
-H "Authorization: Bearer rq_live_sk_..." \
-H "Content-Type: application/json" \
-d '{
"country": "US", "street": "6515 Turnbridge Pl", "city": "Prospect",
"state": "KY", "postalCode": "40059",
"latitude": 38.3526391, "longitude": -85.6208045,
"scope": "primary_and_garage",
"reportType": "residential",
"brand": "rq_brand_7f3a21c9d4e07b16",
"claim": "CLAIM12345",
"notes": "Detached garage at rear."
}'
scope is required and has no default: primary_only, primary_and_garage
or all_structures. brand names the contractor's
brand profile, and the report keeps that brand for good; leave it out and it
carries yours. claim goes on the ESX and notes go to the technician. A webhook fires on
every status change. Every field is in Place an order.
What happens if something in the report is wrong?
You request a revision, and it is free. A delivered report can have one open revision at a time; the old files
stay downloadable until the corrected ones replace them, and a revision_completed webhook says when.
Before going live, the sandbox runs the whole
lifecycle, revisions included, on recorded real roofs at no charge. See Revisions.
What does the residential report not do?
It measures geometry. It does not assess materials, condition or damage, and there is no site visit. For the weather history of the same address, order a Storm Report; for squares alone in under 30 minutes, Rapid Squares; for a commercial building, the commercial roof report.
Frequently asked questions
How much is a RoofQuery residential roof report?
$10, with the PDF, XML, diagrams and data included. The Xactimate ESX is $5 more.
How long does a residential roof report take?
Typically about two hours from the order. A completed webhook fires when the files are ready.
Does a residential report cover the detached garage?
When the scope includes it. Order primary_and_garage or all_structures, and each building comes back with its own totals and diagrams, plus a combined total, for the one price.
Can I put a contractor's brand on the report?
Yes. Save a brand profile for the contractor and send its id as brand when you order. The PDF carries that brand on every download.