Generate Estimate Step 1
Default: POST /api/estimate/simple — pass a USPS-style address; response includes a slug for PDF export.
Toggle comps, details, rent to enrich the response.
Expand Advanced options to use /api/estimate/advanced.
Simple (default)
POST {base}/api/estimate/simple
Query parameters
comps=true— comparable listingsdetails=true— Zillow detail (zDetail)rent=true— ZIP rental statisticsexcludeRentFinderEstimate=true— omit AI estimate
Body (JSON)
Only address is required.
Advanced
POST {base}/api/estimate/advanced — same query flags; body may include bedrooms, compCount, maxRadius, bias, detailsAboutProperty, etc.
Advanced options — /api/estimate/advanced
When open, requests use the advanced endpoint and include any fields below.
Export Branded PDF Step 2
POST /api/estimate/export/{slug} or …/{slug}/true for a presigned URL.
Pass optional logo file and designs JSON string for colors.
Paths
/export/{slug}— rawapplication/pdf/export/{slug}/true— JSON{ pdfUrl, expiry, fileName }
Branding priority
- Uploaded logo file
designs.logoURL (HTTPS)- Saved branding in RentFinder
- Default logo
Custom branding always regenerates (skips cache).
PDF opens in a new tab
After export, the PDF opens in a new tab automatically. Download and re-open links appear below.
Quick reference — errors & OpenAPI
| HTTP | Meaning |
|---|---|
| 400 | Bad request, invalid slug, bad logo URL, malformed designs |
| 401 | Missing or invalid Bearer token |
| 404 | Estimate slug not found |
| 429 | Rate limit exceeded |
| 500 | Server or PDF generation error |
OpenAPI JSON:
Swagger UI: