Roof measurement reports, by API

New here? Make a sandbox key and follow the Quick start: a free test order, delivered with its webhooks, in about a minute.

Method	Path	Purpose
—	Quick start	Keys, sandbox versus live, and your first order in three calls
GET	/api/v1/reports/sandbox/scenarios	Every test address, roof and storm, by report type, and what each does

One API key covers every product, every product draws on the same balance, and one set of webhook endpoints covers every report, Storm Reports included (they also answer in the response). These don't change as products are added.

Method	Path	Purpose
GET	/api/v1/identity	Who the key belongs to, and whether it can order
GET	/api/v1/balance	Available credit and per-product prices
GET	/api/v1/webhooks	List your endpoints
GET	/api/v1/branding/profiles	Saved brands for the contractors you order for
POST	/api/v1/branding/profiles	Create a profile
GET	/api/v1/branding/profiles/:id	One profile
PATCH	/api/v1/branding/profiles/:id	Change a profile
DELETE	/api/v1/branding/profiles/:id	Delete a profile and its logo
PUT	/api/v1/branding/profiles/:id/logo	Upload the profile's logo
DELETE	/api/v1/branding/profiles/:id/logo	Remove the logo, keep the profile

Your own defaults are not on this list. The account's company name, contact block, colours and logo are set in the portal under Branding. What the API takes is everything to do with the contractors you order for: a profile per contractor, logo included, named as brand when you place an order. That order keeps the brand for good. See White labeling.

Method	Path	Purpose
GET	/api/v1/reports/pricing	Report products and prices
POST	/api/v1/reports/orders	Place an order
GET	/api/v1/reports/orders/:id	Order status and measurements
GET	/api/v1/reports/orders/:id/status	The same order, plus a resolved statusDetail block
POST	/api/v1/reports/orders/:id/esx	Add the Xactimate ESX to an order already placed
GET	/api/v1/reports/orders/:id/pdf	Branded PDF (rendered per request)
GET	/api/v1/reports/orders/:id/xml	The measurement document as XML
GET	/api/v1/reports/orders/:id/esx	The same report as an Xactimate .esx, on orders that include it
GET	/api/v1/reports/orders/:id/diagrams	Every diagram available for the order, already addressed
GET	/api/v1/reports/orders/:id/diagrams/:structure/:type	One roof drawing, as SVG or PNG
POST	/api/v1/reports/orders/:id/revisions	Request a revision on a completed report
GET	/api/v1/reports/orders/:id/revisions	Revision history for one order
GET	/api/v1/reports/revision-options	Valid revision topics and rules

Method	Path	Purpose
POST	/api/v1/reports/orders	Order one, with "reportType": "rapid_squares"
GET	/api/v1/reports/orders/:id/photo	The photo the outlines were traced on (no key)

Method	Path	Purpose
—	Storm Reports	What a storm report is, its price and coverage
POST	/api/v1/reports/orders	Order one, with "reportType": "storm"; the response is the report
GET	/api/v1/reports/orders/:id	The report, with this read's date of loss and notes
—	Storm report data	Every field of a storm report, damage chance and confidence
GET	/api/v1/reports/orders/:id/pdf	One of the five PDFs, by template (no key)
GET	/api/v1/reports/orders/:id/map.png	The map on its own (no key)

Topic	What it covers
Sharing a report	The file routes take no key — what that means for a link
Order lifecycle	Every status and event, and which statuses are terminal
Report data	The totals and structures[] field reference
White labeling	Your brand, or a contractor's, on the PDF, chosen when ordering
Revisions	When a report can be corrected, and what it costs
Errors	Every error code the API returns