v1

latestOpenAPI 3.1.02026-07-24100171.6 KB

Sale Listings

Search for sale listings in a geographical area, or by a specific address.

get/listings/sale

Query parameters

addressstring

The full address of the property, in the format Street, City, State, Zip. Used to retrieve data for a specific property, or together with the radius parameter to search for listings in a circular area

citystring

The name of the city, used to search for listings in a specific city. This parameter is case-sensitive

statestring

The 2-character state abbreviation, used to search for listings in a specific state. This parameter is case-sensitive

zipCodestring

The 5-digit zip code, used to search for listings in a specific zip code

latitudenumber float

The latitude of the search area. Use the latitude/longitude and radius parameters to search for listings in a circular area

longitudenumber float

The longitude of the search area. Use the latitude/longitude and radius parameters to search for listings in a circular area

radiusnumber float

The radius of the search area in miles, with a maximum of 100. Use in combination with the latitude/longitude or address parameters to search for listings in a circular area

propertyType'Single Family' | 'Condo' | 'Townhouse' | 'Manufactured' | 'Multi-Family' | 'Apartment' | 'Land'

The type of the property, used to search for listings matching this criteria. See explanation of property types. Supports multiple values

bedroomsstring

The number of bedrooms, used to search for listings matching this criteria. Use 0 to indicate a studio layout. Supports numeric ranges and multiple values

bathroomsstring

The number of bathrooms, used to search for listings matching this criteria. Supports fractions to indicate partial bathrooms, numeric ranges and multiple values

squareFootagestring

The total living area size in square feet, used to search for listings matching this criteria. Supports numeric ranges and multiple values

lotSizestring

The total lot size in square feet, used to search for listings matching this criteria. Supports numeric ranges and multiple values

yearBuiltstring

The year of construction, used to search for listings matching this criteria. Supports numeric ranges and multiple values

status'Active' | 'Inactive'

The current listing status, used to search for listings matching this criteria. See explanation of listing statuses

pricestring

The listed price of the property, used to search for listings matching this criteria. Supports numeric ranges and multiple values

daysOldstring

The number of days since a property was listed on the market, with a minimum of 1. Supports numeric ranges

limitinteger

The maximum number of listing records to return, between 1 and 500. Defaults to 50 if not provided. Learn more about pagination

offsetinteger

The index of the first listing record to return, used to paginate through large lists of results. Defaults to 0 if not provided. Learn more about pagination

includeTotalCountboolean

When enabled, will return the total number of results matching the current query in the X-Total-Count response header. Defaults to false if not provided

Response

Success

idstring
formattedAddressstring
addressLine1string
addressLine2string
citystring
statestring
stateFipsstring
zipCodestring
countystring
countyFipsstring
latitudenumber
longitudenumber
propertyTypestring
bedroomsnumber
bathroomsnumber
squareFootagenumber
lotSizenumber
yearBuiltnumber
statusstring
pricenumber
listingTypestring
listedDatestring date-time
removedDatestring date-time
createdDatestring date-time
lastSeenDatestring date-time
daysOnMarketnumber
mlsNamestring
mlsNumberstring

Example response

[
  {
    "id": "3821-Hargis-St,-Austin,-TX-78723",
    "formattedAddress": "3821 Hargis St, Austin, TX 78723",
    "addressLine1": "3821 Hargis St",
    "city": "Austin",
    "state": "TX",
    "stateFips": "48",
    "zipCode": "78723",
    "county": "Travis",
    "countyFips": "453",
    "latitude": 30.290643,
    "longitude": -97.701547,
    "propertyType": "Single Family",
    "bedrooms": 4,
    "bathrooms": 2.5,
    "squareFootage": 2345,
    "lotSize": 3284,
    "yearBuilt": 2008,
    "hoa": {
      "fee": 65
    },
    "status": "Active",
    "price": 899000,
    "listingType": "Standard",
    "listedDate": "2024-06-24T00:00:00.000Z",
    "createdDate": "2021-06-25T00:00:00.000Z",
    "lastSeenDate": "2024-09-30T13:11:47.157Z",
    "daysOnMarket": 99,
    "mlsName": "UnlockMLS",
    "mlsNumber": "5519228",
    "listingAgent": {
      "name": "Jennifer Welch",
      "phone": "5124313110",
      "email": "jennifer@gottesmanresidential.com",
      "website": "https://www.gottesmanresidential.com"
    },
    "listingOffice": {
      "name": "Gottesman Residential R.E.",
      "phone": "5124512422",
      "email": "nataliem@gottesmanresidential.com",
      "website": "https://www.gottesmanresidential.com"
    },
    "history": {
      "2024-06-24": {
        "event": "Sale Listing",
        "price": 899000,
        "listingType": "Standard",
        "listedDate": "2024-06-24T00:00:00.000Z",
        "daysOnMarket": 99
      }
    }
  }
]