Auction.com property details
Facts about one home on Auction.com: size, type, year built, parcel number, sale type, auction date and place, opening bid, bids and the result. Costs 2 credits.
GET
https://api.realtycrawl.com/v1/auction/propertyFacts about one home on Auction.com: size, type, year built, parcel number, sale type, auction date and place, opening bid, bids, the result once it has sold, and Auction.com's value estimate. Works for closed and canceled auctions too.
Cost: 2 credits when complete. Failed calls are free.
#Inputs
- lookup: Which home. Send exactly one of
address,urlorsource_id. None, or more than one, returns 422 withparamset tolookup.
| Parameter | Type | Default | Description |
|---|---|---|---|
address | string | Full street address with city and state or ZIP, like 2041 Samuel Dr, Denver, CO 80221. An address that matches several homes returns 422 address_ambiguous with up to 5 candidates in error. Send one of their source_ids. | |
url | string | The home's page URL on the source site. | |
source_id | string | The source's own ID for the home. On Zillow, the zpid; on Redfin, the number at the end of the home's URL (.../home/34056278). |
#Example
curl -G https://api.realtycrawl.com/v1/auction/property \ -H "Authorization: Bearer $REALTYCRAWL_KEY" \ -d source_id=2093622Try it
#Fields
| Field | Type | Description |
|---|---|---|
request_id | string | ID of this request. Poll it at /v1/jobs/{request_id}. |
status | string: pending, complete, failed | pending, complete or failed. Always check it, even on HTTP 200. |
credits | integer | Credits charged. The route's price when complete; 0 while pending, when failed, or for a page past the last one. |
cached | boolean | True when the result came from our cache. |
poll_url | string or null | Where to poll while pending. Null when complete. |
error | object or null | {code, message, param} when failed. On address_ambiguous, also candidates: up to 5 {address, source_id, source_url} to pick from. Null otherwise. |
result | object or null | The result when complete. Null otherwise. |
result.source | string | Source of the rows, like zillow. |
result.query | object | The inputs you sent, as we read them. |
result.count | integer | Rows in data. |
result.reported_total | integer or null | Total matches the source reported for the whole search, when it shows one. |
result.next_cursor | string or null | Send as cursor for the next page. Null on the last page and on lookups. |
result.collected_at | string | When we read the source (ISO 8601, UTC). |
result.schema_version | integer | Version of the row schema. Changes only with a new, opt-in version. |
result.completeness | string: complete, partial | complete, or partial when the source returned less than a full page for a reason other than reaching the end. |
result.summary | object or null | Maths over this page for area searches. Null on lookups. |
result.data | array | The rows. |
result.field_notes | array | Why a field is null: {field, reason, detail}. One note covers every row where it applies. |
result.data[].source | string | Which source the row came from. New sources may be added, so handle values you don't know. |
result.data[].source_id | string | The source's own ID for the home or building. On Zillow, a home's ID is its zpid; on Redfin, its property ID. |
result.data[].source_url | string | Page for this home or building on the source site. |
result.data[].collected_at | string | When we read the source (ISO 8601, UTC). |
result.data[].status | string: for_sale, pending, for_rent, sold, off_market | Current status. |
result.data[].address | Address | Address. |
result.data[].location | Location or null | Map point. |
result.data[].parcel | object or null | County parcel number as {county_fips, apn}. Null when the source does not give it. |
result.data[].property_type | string or null: single_family, condo, townhouse, multi_family, land, manufactured, apartment, other | Home type. |
result.data[].beds | number or null | Bedrooms. |
result.data[].baths | number or null | Bathrooms as the source counts them. |
result.data[].baths_full | integer or null | Full bathrooms, when the source splits them. |
result.data[].baths_half | integer or null | Half bathrooms, when the source splits them. |
result.data[].living_area_sqft | integer or null | Living area in square feet. |
result.data[].lot_area_sqft | integer or null | Lot area in square feet. |
result.data[].year_built | integer or null | Year built. |
result.data[].stories | number or null | Number of stories. |
result.data[].hoa_fee_monthly | Money or null | Monthly HOA fee. Null when there is none or the source does not say. |
result.data[].tax | object or null | Latest county tax record: {year, assessed_value (Money|null), amount (Money|null)}. Null when the source has none. |
result.data[].last_sale | object or null | Most recent sale: {date, price (Money|null), sale_price_disclosure}. Null when the home has no recorded sale. |
result.data[].list_price | Money or null | Current asking price when for sale. |
result.data[].rent_monthly | Money or null | Current rent when for rent. |
result.data[].list_date | string or null | Date the current listing started (YYYY-MM-DD). |
result.data[].days_on_market | integer or null | Days from list_date to the first pending date, or to the sale date when there was no pending date. For a home still listed, days since list_date. |
result.data[].broker_name | string or null | Listing brokerage. |
result.data[].agent_name | string or null | Listing agent. |
result.data[].mls_name | string or null | MLS the listing came from. |
result.data[].mls_id | string or null | Listing number in that MLS. |
result.data[].photo_count | integer or null | How many photos the source shows. We never return or store the photos. |
result.data[].price_history | array or null | Listing and sale events, newest first: {date, event, event_raw, price (Money|null), source_note}. event is one of listed, price_change, pending, sold, delisted, relisted, listed_for_rent, rent_change, rented, other. event_raw is the source's own wording. Empty when the source has none; null when it could not be read. |
result.data[].tax_history | array or null | County tax records, newest first: {year, assessed_value (Money|null), amount (Money|null)}. Empty when the source has none; null when it could not be read. |
result.data[].value_history | array or null | The source's monthly estimate for this home (on Zillow, the Zestimate), newest first: {date, value (Money)}. Up to about 10 years. Empty when the source has none; null when it could not be read. |
result.data[].extras | object | Fields only this source has. Each source lists its own on its docs page. {} when there are none. |
result.data[].extras.property_type_raw | string or null | Auction.com's own home type code, like SINGLE_FAMILY_HOME or CONDOMINIUM_UNIT. |
result.data[].extras.listing_status_raw | string or null | Auction.com's own status, like SALE_PENDING (an auction is scheduled), AUCTION_IN_PROGRESS, POSTPONED_PENDING_SCHEDULING or, after the sale, CLOSED. |
result.data[].extras.sale_type | string or null | What kind of sale, as Auction.com names it, like TRUSTEE (a foreclosure auction), REO or DAY_1_REO (bank-owned), REDEMPTION, or PRIVATE_SELLER. New kinds may appear. |
result.data[].extras.auction_start | string or null | When the auction starts, or started (ISO 8601, UTC). |
result.data[].extras.auction_end | string or null | When an online auction ends (ISO 8601, UTC). Null for auctions held in person. |
result.data[].extras.online_auction | boolean or null | True for an online auction, false for one held in person, like a courthouse sale. |
result.data[].extras.starting_bid | Money or null | The opening bid. Often published only shortly before the sale, so null on most foreclosure auctions until then. Some online auctions open at $1 with a reserve, so it is not a price. |
result.data[].extras.current_bid | Money or null | The highest bid so far, on an online auction. |
result.data[].extras.bid_count | integer or null | Bids so far, on an online auction. |
result.data[].extras.estimated_value | Money or null | Auction.com's estimate of the home's value. Auction.com's estimate, not ours. |
result.data[].extras.occupancy | string or null | Whether the home is lived in, as Auction.com says: OCCUPIED, VACANT or UNKNOWN. |
result.data[].extras.year_built | integer or null | Year built. |
result.data[].extras.lot_size_raw | number or null | Lot size as Auction.com gives it, with no unit. Mostly acres rounded to 2 decimals, but some rows hold another unit (a condo showed 777), so check it before use. |
result.data[].extras.first_listed_date | string or null | The day the home was first listed on Auction.com (YYYY-MM-DD). |
result.data[].extras.financing_available | boolean or null | True when the seller offers financing. |
result.data[].extras.buyer_premium | boolean or null | True when the buyer pays a buyer's premium on top of the winning bid. |
result.data[].extras.trustee_sale_number | string or null | The trustee's sale number for a foreclosure auction. |
result.data[].extras.venue_name | string or null | Where an auction held in person takes place, like a county courthouse. |
result.data[].extras.venue_address | string or null | Address of that place. |