Properties (Search and Detail)
One endpoint for US homes of every status: for sale, pending, for rent, sold in the last 12 months and off the market. Search a place with filters, or look up one home by property ID or by address.
Search mode: give at least one of zip, city, county or state. With no location at all the whole US is searched from a fixed sample, and the answer is marked approximate: true (counts are estimates). Very large areas are answered the same way. Detail mode: give property_id or address. All other parameters are optional filters. Not available with demo keys.
Request
- Base URL: https://api.dataporium.io
- URL: https://api.dataporium.io/properties
- Auth: API key in query parameter apikey
Query parameters
Search mode: ZIP code, or several separated by commas (up to 25)
Search mode: city name. Add state when the name is used in more than one state
Search mode: county name, with or without the word County
State as a 2-letter code or full name, for example CA or California. Alone, it searches the whole state
for_sale (default), pending, rent, sold (last 12 months) or off_market. Use commas for several. In detail mode it picks which record of the home to show
Minimum price (monthly rent for rentals, sold price for sold homes, estimated value for off-market homes)
Maximum price
Minimum bedrooms
Maximum bedrooms
Minimum bathrooms (a half bath counts as 0.5)
Maximum bathrooms
Minimum living area in square feet
Maximum living area in square feet
Minimum lot size in square feet
Maximum lot size in square feet
Built in this year or later
Built in this year or earlier
Home style, or several separated by commas: single_family, condos, townhomes, multi_family, land, mobile, farm, duplex_triplex, condo_townhome
true for new construction only, false to leave it out
Maximum HOA fee per month (homes without an HOA count as 0)
Minimum days on market of the current listing (the real listed date, not a date that resets on every relist)
Maximum days on market of the current listing
Minimum true days on market: the whole selling effort, earlier listings of the same home included and days off the market left out
Maximum true days on market
Only homes whose current listing started within this many days
true: only homes with a price cut. false: only homes without one
Only homes whose latest price cut was within this many days
Total price cut since the home was first listed, at least this many dollars
Total price cut since the home was first listed, at least this percent
true: only relisted homes. false: only homes that were not relisted in this selling effort
Sold homes: sold within this many days
true: price per square foot is below the ZIP code median of the same status. false: at or above it
Price per square foot is at least this percent below the ZIP code median of the same status
newest (default), oldest, price_asc, price_desc, ppsf_asc, ppsf_desc, dom_asc, dom_desc (true days on market), biggest_cut, recent_cut, best_value (lowest price per square foot compared with the ZIP code median), sqft_desc, beds_desc, lot_desc, year_built_desc
Homes per page, 1 to 5000 (default 100)
Number of homes to skip, for the next page (default 0). The answer gives next_offset when there are more
standard (all search fields, default) or compact (fewer fields per home)
Search mode: add an estimated monthly payment to each home. Uses the payment inputs below, or the defaults
Detail mode: one home by its property ID (from a search answer)
Detail mode: a street address in any common spelling, for example 41 Carpenteria, Irvine CA or just 41 Carpenteria. ZIP code, city and state are optional. If more than one home is a close match, the answer lists the best matches with a match score
With address: return only the best matching homes (useful for a search box), not the full detail
Detail mode: radius for the comparison with nearby homes, up to 50 miles (default 2)
Detail mode: compare only with nearby homes that have the same number of bedrooms
Detail mode: compare only with nearby homes of the same style
Detail mode: compare only with nearby homes of at least this many square feet
Detail mode: compare only with nearby homes of at most this many square feet
Payment: down payment in percent (default 20)
Payment: down payment in dollars, instead of percent
Payment: yearly interest rate in percent (default: the latest average 30-year fixed rate)
Payment: loan term in years (default 30)
Payment: yearly property tax in percent of the price (default: the rate from the last tax bill of the home when known, else the median rate of its ZIP code, city or county, else 1.25)
Payment: home insurance per year in dollars (default 0.35 percent of the price)
Payment: HOA fee per month in dollars (default: the HOA fee of the home)
Payment: yearly mortgage insurance (PMI) in percent of the loan, used when the down payment is below 20 percent (default 0.7)
Payment: maintenance per year in dollars. Added to the monthly payment only when you give it (default none)
Response
Successful response (JSON).
Changes
No recorded changes to this operation across all 1 revision of this API.