{"openapi":"3.0.3","info":{"title":"Homefairly API","version":"1.0.0","description":"Check whether a US home or rental listing is fairly priced. Send a listing link or a street address and get an independent price verdict, a fair value range, a suggested offer range and the recent comparable sales behind it. Requires a paid Homefairly license key: buy checks or a plan at https://homefairly.com/#pricing. Each new property uses one check; checking the same property again within 60 days is free. Unlimited plans are not charged per check. Homefairly verdicts are independent estimates for informational purposes only. They are not an appraisal and not financial, legal or real estate advice. Homefairly is not affiliated with Zillow®, Redfin®, Realtor.com®, Homes.com®, Apartments.com®, Rent.com®, Zumper® or HotPads®. Verify with a licensed local professional before making an offer.","contact":{"name":"Homefairly","url":"https://homefairly.com/developers","email":"hello@homefairly.com"}},"servers":[{"url":"https://api.homefairly.com"}],"security":[{"licenseKey":[]}],"paths":{"/v1/check":{"post":{"operationId":"checkListing","summary":"Get a price verdict for a US listing","description":"Send either a listing link (Zillow®, Redfin®, Realtor.com®, Homes.com®, Apartments.com®, Rent.com®, Zumper®, HotPads®) or a US street address. If the asking price cannot be found, the response asks for it; resend the same request with asking_price (or asking_rent) added, which does not use another check.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string","description":"Listing link."},"address":{"type":"string","description":"Full US street address (number, street, city and state or ZIP), used when there is no link.","example":"123 Main St, Austin, TX 78701"},"listing_type":{"type":"string","enum":["sale","rental"],"description":"Set to rental for a rental listing typed as an address. Links are detected automatically."},"asking_price":{"type":"number","description":"Asking price in USD, for a sale."},"asking_rent":{"type":"number","description":"Asking monthly rent in USD, for a rental."},"sqft":{"type":"number"},"beds":{"type":"number"},"baths":{"type":"number"}}}}}},"responses":{"200":{"description":"Verdict","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean"},"address":{"type":"string"},"listing_type":{"type":"string","enum":["sale","rental"]},"property_type":{"type":"string","enum":["home","land","rental"]},"verdict":{"type":"string","enum":["GOOD DEAL","FAIRLY PRICED","A BIT HIGH","OVERPRICED","UNKNOWN"],"description":"UNKNOWN means there was not enough reliable data for a confident verdict."},"confidence_note":{"type":"string","nullable":true,"description":"Plain-English note on how much weight to give this verdict."},"difference_pct":{"type":"number","nullable":true,"description":"How far the asking figure sits above (positive) or below (negative) fair value, in percent."},"asking_price":{"type":"integer","nullable":true},"fair_value":{"type":"integer","nullable":true},"fair_value_range":{"type":"array","items":{"type":"integer"},"minItems":2,"maxItems":2,"nullable":true},"suggested_offer_range":{"type":"array","items":{"type":"integer"},"minItems":2,"maxItems":2,"nullable":true,"description":"Suggested offer range, low to high. Guidance for negotiation, not advice."},"asking_rent":{"type":"integer","nullable":true},"fair_rent":{"type":"integer","nullable":true},"fair_rent_range":{"type":"array","items":{"type":"integer"},"minItems":2,"maxItems":2,"nullable":true},"days_on_market":{"type":"integer","nullable":true},"price_cuts":{"type":"integer"},"comps_used":{"type":"integer"},"comparable_sales":{"type":"array","items":{"type":"object","properties":{"address":{"type":"string","nullable":true},"sold_price":{"type":"integer","nullable":true},"sold_date":{"type":"string","nullable":true},"beds":{"type":"number","nullable":true},"baths":{"type":"number","nullable":true},"sqft":{"type":"integer","nullable":true},"distance_miles":{"type":"number","nullable":true}}}},"account":{"type":"object","properties":{"unlimited":{"type":"boolean"},"checks_left":{"type":"integer","nullable":true}}},"charged":{"type":"boolean","description":"True when this request used one check."},"disclaimer":{"type":"string"}}}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"error":{"type":"string"},"message":{"type":"string"}}}}}},"401":{"description":"Missing, unknown or inactive license key","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"error":{"type":"string"},"message":{"type":"string"}}}}}},"402":{"description":"No checks left on this key","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"error":{"type":"string"},"message":{"type":"string"}}}}}},"422":{"description":"Address not recognized, unsupported link or location, or more information needed (see needs)","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"error":{"type":"string"},"message":{"type":"string"},"needs":{"type":"array","items":{"type":"string","enum":["asking_price","asking_rent","sqft"]}}}}}}},"429":{"description":"Temporarily at capacity for new properties. Try again later.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","example":false},"error":{"type":"string"},"message":{"type":"string"}}}}}}}}}},"components":{"securitySchemes":{"licenseKey":{"type":"http","scheme":"bearer","description":"Your Homefairly license key, for example HFC-XXXXXXXXXXXX."}}}}