{"base_url":"https://tryroofrover.com","endpoints":[{"auth":"X-API-Key header (partner key)","body":{"address":"123 Main St, Lynchburg, VA 24501"},"description":"Full AI damage assessment for one address. Returns grade 1-5, damage boxes, and plain-language repair breakdown. Billed per successful scan: $0.50 \u2014 failed scans are never billed.","method":"POST","path":"/api/v1/partner/scan","response":{"amount_charged":0.5,"confidence":"high","grade":2,"issues":["Hail hits, south slope"],"leads_billed":1,"leads_returned":1,"ok":true}},{"auth":"X-API-Key header","body":{"address":"5330 Wedgmont Cir N, Fort Worth, TX 76133","trade":"roofing"},"description":"Instant single-address scan with the Full Roof Report, built for live calls (under 30 seconds). Roofing scans return report (verdict, findings, pinpoints, roof type, building, owner contact, estimated repair/replacement, measurements), report_url (PNG report card: roof outline, damage pinpoints, worst-area zoom, context aerial, QR) and report_pdf_url. $0.50 per successful scan; failed or unscannable scans are free. Staged variant: POST /api/v1/instant-scan/start then poll GET /api/v1/instant-scan/status/{scan_id}.","method":"POST","path":"/api/v1/instant-scan","response":{"duration_ms":18400,"findings":["Patch repairs across the field"],"grade":2,"grade_label":"moderate","ok":true,"price_cents":50,"report":{"estimated_repair":[58200,99800],"estimated_replacement":[133000,232800],"verdict":"REPAIR SOON"},"report_pdf_url":"https://tryroofrover.com/api/v1/instant-scan/report/is_0123456789ab.pdf","report_url":"https://tryroofrover.com/api/v1/instant-scan/report/is_0123456789ab.png","scan_id":"is_0123456789ab"}},{"auth":"X-API-Key header","description":"Fast roof intelligence lookup.","method":"GET","params":{"address":"123 Main St, Lynchburg, VA","zip":"24501"},"path":"/api/v1/roof-intel"},{"auth":"X-API-Key header (partner key)","body":{"count":5,"request_id":"optional idempotency key","zip":"77020"},"description":"Buy commercial leads by ZIP: $0.50 per lead delivered. A delivered lead is exclusive \u2014 sold to your account and removed from every other shelf, with the full report and street address. When the ZIP has no stored commercial inventory, a commercial scan starts for the ZIP automatically and the order stays open; you are charged only as leads land, never for the scan itself.","method":"POST","path":"/api/v1/commercial-leads","response":{"amount_charged":1.0,"delivered":2,"leads":["full lead reports, address included"],"ok":true,"order_id":"plo_0123456789ab","requested":5,"status":"partial","zip":"77020"}},{"auth":"X-API-Key header (partner key)","description":"Poll a commercial-lead order. Each poll delivers (and charges $0.50 for) any leads that have landed since the order was placed.","method":"GET","path":"/api/v1/commercial-leads/{order_id}"},{"auth":"X-API-Key header (partner key)","description":"The live leads feed: graded roof records your system pulls as they are produced, each with its address, grade and full graded report. Charge-on-pull guarantee: you pay when a record lands in your feed \u2014 never for promises. A record bills the partner rate ($0.25) the first time it is delivered to your account, and only then: re-pulls are always free, and records already held on your account never bill.","method":"GET","params":{"grade":"comma list, e.g. 1,2,3 (optional)","limit":"100 (max 500)","since":"serial cursor (optional)"},"path":"/api/v1/leads","response":{"count":2,"leads":["graded records with serial, address, grade and report (assay) URL"],"ok":true}},{"auth":"X-API-Key header (partner key)","description":"Your feed account as it stands right now: records held, production totals, exchange count, and the charge-on-pull totals \u2014 pulled_count, pulled_total (the pull bill) and last_pull_at.","method":"GET","path":"/api/v1/leads/account"}],"examples":{"curl":"curl -X POST https://tryroofrover.com/api/v1/partner/scan -H \"X-API-Key: rrp_YOUR_KEY\" -H \"Content-Type: application/json\" -d '{\"address\":\"123 Main St, Lynchburg, VA 24501\"}'","javascript":"const r = await fetch('https://tryroofrover.com/api/v1/partner/scan', {\n  method: 'POST',\n  headers: {'X-API-Key': 'rrp_YOUR_KEY',\n            'Content-Type': 'application/json'},\n  body: JSON.stringify({address:\n    '123 Main St, Lynchburg, VA 24501'})\n});\nconst data = await r.json();","python":"import requests\nr = requests.post(\n    'https://tryroofrover.com/api/v1/partner/scan',\n    headers={'X-API-Key': 'rrp_YOUR_KEY'},\n    json={'address': '123 Main St, Lynchburg, VA 24501'})\nprint(r.json())"},"ok":true,"pricing":{"base_fee_monthly":0.0,"billing_unit":"successful instant scan \u2014 one flat charge per completed scan, whatever grade it returns; failed scans bill $0","commercial_lead_unit":"per commercial lead delivered via /api/v1/commercial-leads; undelivered leads and the scans an order triggers bill $0, and the scan trial does not apply to lead purchases","feed_record_unit":"per record on its first delivery to your account (charge-on-pull) \u2014 re-pulls are free, records already held on your account never bill, empty pulls bill $0","per_commercial_lead":0.5,"per_feed_record":0.25,"per_scan":0.25,"trial":"first 10 successful scan jobs free"},"webhooks":{"events":["scan.completed","scan.failed"],"note":"Configure webhook URLs in the console under API & Integration. Each delivery is signed with your webhook secret (HMAC-SHA256).","payload":{"address":"...","event":"scan.completed","grade":2,"timestamp":1234567890}}}
