Raw schema
{
"type": "object",
"properties": {
"keyword": {
"type": "string",
"description": "The location to search for listings. Accepts a zipcode (`33321`), a city (`Austin` or `Austin, TX`), a neighborhood (`East Austin`), a school (`BASIS Austin`), a school district (`Austin Independent School District`), an apartment building by its name (`Maizon Brickell`), or a full street address (`5805 Woodview Ave, Austin, TX 78756`), including a single unit (`221 SW 12th St Unit 1716, Miami, FL`). An address or a building returns a single property card instead of a list of listings, and the `type` parameter does not apply to it."
},
"type": {
"type": "string",
"enum": [
"forSale",
"forRent",
"sold"
],
"description": "The type of listing."
},
"sort": {
"type": "string",
"enum": [
"recommended",
"newest",
"oldest",
"priceLowToHigh",
"priceHighToLow",
"minSquareFeet",
"maxSquareFeet",
"bedrooms",
"bathrooms",
"lotSize",
"squareFeetPrice",
"mostRecentlySold"
],
"description": "The sorting option for the search results."
},
"price_min_": {
"type": "number",
"description": "The minimum price of the listing."
},
"price_max_": {
"type": "number",
"description": "The maximum price of the listing."
},
"monthlyPayment_min_": {
"type": "number",
"description": "The minimum monthly payment."
},
"monthlyPayment_max_": {
"type": "number",
"description": "The maximum monthly payment."
},
"monthlyPayment_interestRate_": {
"type": "number",
"description": "The mortgage interest rate (percent) used to calculate the monthly payment."
},
"monthlyPayment_insuranceRate_": {
"type": "number",
"description": "The home insurance rate (percent) used to calculate the monthly payment."
},
"monthlyPayment_downPaymentPercent_": {
"type": "number",
"description": "The down payment as a percentage of the home price."
},
"monthlyPayment_downPaymentAmount_": {
"type": "number",
"description": "The down payment as an absolute amount."
},
"monthlyPayment_mortgageTerm_": {
"type": "string",
"enum": [
"fixed15Years",
"fixed20Years",
"fixed30Years",
"fixed30YearsFha",
"fixed30YearsVa",
"fixed30YearsJumbo"
],
"description": "The mortgage term used to calculate the monthly payment."
},
"cost_hoa_": {
"type": "number",
"description": "The maximum monthly Homeowners Association (HOA) fee."
},
"cost_pricePerSqft__min_": {
"type": "string",
"enum": [
"50",
"100",
"150",
"200",
"250",
"300",
"400",
"500",
"600",
"800",
"1000",
"1400",
"1800",
"2200",
"2600",
"3000"
],
"description": "The minimum price per square foot."
},
"cost_pricePerSqft__max_": {
"type": "string",
"enum": [
"50",
"100",
"150",
"200",
"250",
"300",
"400",
"500",
"600",
"800",
"1000",
"1400",
"1800",
"2200",
"2600",
"3000"
],
"description": "The maximum price per square foot."
},
"cost_excludeLandLeases_": {
"type": "boolean",
"description": "If set to true, listings with land leases will be excluded."
},
"cost_maxPropertyTaxPerYear_": {
"type": "number",
"description": "The maximum property tax per year."
},
"cost_acceptedFinancing_": {
"type": "string",
"enum": [
"FHA",
"VA"
],
"description": "The accepted financing type."
},
"cost_priceReduced_": {
"type": "string",
"enum": [
"inTheLastDay",
"inTheLast3Days",
"inTheLast7Days",
"inTheLast14Days",
"inTheLast30Days",
"moreThan30Days",
"moreThan60Days",
"moreThan120Days"
],
"description": "Filter listings by when the price was reduced."
},
"homeTypes__": {
"type": "array",
"items": {
"type": "string",
"enum": [
"house",
"townhouse",
"townhome",
"condo",
"land",
"multiFamily",
"mobile",
"coOp",
"other",
"apartment"
]
},
"description": "An array of home types to filter the listings. Allowed values depend on the listing `type`."
},
"beds_min_": {
"type": "number",
"description": "The minimum number of bedrooms."
},
"beds_max_": {
"type": "number",
"description": "The maximum number of bedrooms."
},
"baths": {
"type": "string",
"enum": [
"one",
"oneAndHalf",
"two",
"twoAndHalf",
"three",
"four"
],
"description": "The minimum number of bathrooms."
},
"forSaleSquareFeet_min_": {
"type": "string",
"enum": [
"750",
"1000",
"1100",
"1200",
"1300",
"1400",
"1500",
"1600",
"1700",
"1800",
"1900",
"2000",
"2250",
"2500",
"2750",
"3000",
"4000",
"5000",
"7500",
"10000"
],
"description": "The minimum square footage for for-sale listings."
},
"forSaleSquareFeet_max_": {
"type": "string",
"enum": [
"750",
"1000",
"1100",
"1200",
"1300",
"1400",
"1500",
"1600",
"1700",
"1800",
"1900",
"2000",
"2250",
"2500",
"2750",
"3000",
"4000",
"5000",
"7500",
"10000"
],
"description": "The maximum square footage for for-sale listings."
},
"forRentSquareFootage_min_": {
"type": "number",
"description": "The minimum square footage for for-rent listings."
},
"forRentSquareFootage_max_": {
"type": "number",
"description": "The maximum square footage for for-rent listings."
},
"lotSize_min_": {
"type": "string",
"enum": [
"2000 sqft",
"4500 sqft",
"6500 sqft",
"8000 sqft",
"9500 sqft",
"0.25 acres",
"0.5 acres",
"1 acres",
"2 acres",
"3 acres",
"4 acres",
"5 acres",
"10 acres",
"20 acres",
"40 acres",
"100 acres"
],
"description": "The minimum lot size."
},
"lotSize_max_": {
"type": "string",
"enum": [
"2000 sqft",
"4500 sqft",
"6500 sqft",
"8000 sqft",
"9500 sqft",
"0.25 acres",
"0.5 acres",
"1 acres",
"2 acres",
"3 acres",
"4 acres",
"5 acres",
"10 acres",
"20 acres",
"40 acres",
"100 acres"
],
"description": "The maximum lot size."
},
"yearBuilt_min_": {
"type": "string",
"enum": [
"2026",
"2025",
"2024",
"2023",
"2022",
"2021",
"2020",
"2019",
"2018",
"2017",
"2016",
"2015",
"2010",
"2005",
"2000",
"1990",
"1980",
"1970",
"1960",
"1950",
"1940",
"1920",
"1900"
],
"description": "The minimum year the property was built."
},
"yearBuilt_max_": {
"type": "string",
"enum": [
"2026",
"2025",
"2024",
"2023",
"2022",
"2021",
"2020",
"2019",
"2018",
"2017",
"2016",
"2015",
"2010",
"2005",
"2000",
"1990",
"1980",
"1970",
"1960",
"1950",
"1940",
"1920",
"1900"
],
"description": "The maximum year the property was built."
},
"stories_min_": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"10",
"15",
"20"
],
"description": "The minimum number of stories."
},
"stories_max_": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5",
"10",
"15",
"20"
],
"description": "The maximum number of stories."
},
"listingType_category___": {
"type": "array",
"items": {
"type": "string",
"enum": [
"byAgent",
"byOwnerFsbo",
"newConstruction",
"foreclosures"
]
},
"description": "An array of listing categories."
},
"listingType_excludeShortSales_": {
"type": "boolean",
"description": "If set to true, short sales will be excluded."
},
"listingType_redfinListingsOnly_": {
"type": "boolean",
"description": "If set to true, only Redfin-listed properties will be included."
},
"statusOptions__": {
"type": "array",
"items": {
"type": "string",
"enum": [
"active",
"comingSoon",
"contingentPending"
]
},
"description": "An array of listing statuses."
},
"onlyWithDealOrPromotion": {
"type": "boolean",
"description": "If set to true, only listings with a deal or promotion will be included."
},
"exclude55PlusCommunities": {
"type": "boolean",
"description": "If set to true, 55+ communities will be excluded."
},
"timeOnRedfin": {
"type": "string",
"enum": [
"newListing",
"lessThan3Days",
"lessThan7Days",
"lessThan14Days",
"lessThan30Days",
"moreThan7Days",
"moreThan14Days",
"moreThan30Days",
"moreThan45Days",
"moreThan60Days",
"moreThan90Days",
"moreThan180Days"
],
"description": "How long the listing has been on Redfin."
},
"soldWithinOption": {
"type": "string",
"enum": [
"lastOneWeek",
"lastOneMonth",
"lastThreeMonth",
"lastSixMonth",
"lastYear",
"lastTwoYear",
"lastThreeYear",
"lastFiveYear"
],
"description": "Filter sold listings by how recently they were sold."
},
"moveInDate": {
"type": "string",
"description": "The desired move-in date in MM/DD/YYYY format."
},
"openHouseAndTour_openHouse_": {
"type": "string",
"enum": [
"thisWeekend",
"anytime"
],
"description": "Filter listings with an open house."
},
"openHouseAndTour_videoTour_": {
"type": "boolean",
"description": "If set to true, only listings with a video tour will be included."
},
"homeFeatures_options___": {
"type": "array",
"items": {
"type": "string",
"enum": [
"airConditioning",
"waterfront",
"hasAView",
"fireplace",
"fixerUpper",
"guestHouse",
"elevator",
"washerDryerHookup",
"petsAllowed",
"primaryBedroomOnMainFloor",
"rvparking",
"greenHome",
"accessibleHome",
"includeOutdoorParking"
]
},
"description": "An array of home feature flags to filter the listings."
},
"homeFeatures_garageSpotsMin_": {
"type": "string",
"enum": [
"1",
"2",
"3",
"4",
"5"
],
"description": "The minimum number of garage spots."
},
"homeFeatures_poolType_": {
"type": "string",
"enum": [
"privatePool",
"communityPool",
"privateOrCommunityPool",
"noPrivatePool"
],
"description": "The type of pool."
},
"homeFeatures_basement_": {
"type": "string",
"enum": [
"finished",
"unfinished"
],
"description": "The basement type."
},
"homeFeatures_keywordSearch_": {
"type": "string",
"description": "A free-text keyword search applied to listing descriptions."
},
"rentalAmenities__": {
"type": "array",
"items": {
"type": "string",
"enum": [
"airConditioning",
"dishwasher",
"inUnitWasherDryer",
"parkingAllowed",
"utilitiesIncluded",
"attFiber",
"furnished",
"laundryFacility",
"pool",
"washerDryerHookup"
]
},
"description": "An array of rental amenities to filter the listings."
},
"rentalOtherTerms__": {
"type": "array",
"items": {
"type": "string",
"enum": [
"incomeRestricted",
"student",
"shortTerm",
"seniorLiving",
"military"
]
},
"description": "An array of additional rental terms."
},
"pets__": {
"type": "array",
"items": {
"type": "string",
"enum": [
"dogsAllowed",
"catsAllowed"
]
},
"description": "An array of pet types allowed."
},
"schools_greatSchoolRating_": {
"type": "number",
"description": "The minimum GreatSchools rating (1-10)."
},
"schools_schoolType___": {
"type": "array",
"items": {
"type": "string",
"enum": [
"elementary",
"middle",
"high"
]
},
"description": "An array of school types."
},
"schools_includeUnratedSchools_": {
"type": "boolean",
"description": "If set to true, unrated schools will be included."
},
"transportScores_walkScore_": {
"type": "number",
"description": "The minimum walk score (1-100)."
},
"transportScores_transitScore_": {
"type": "number",
"description": "The minimum transit score (1-100)."
},
"transportScores_bikeScore_": {
"type": "number",
"description": "The minimum bike score (1-100)."
},
"page": {
"type": "number",
"description": "The page number of the results to retrieve."
}
},
"required": [
"keyword",
"type"
],
"additionalProperties": false,
"$schema": "http://json-schema.org/draft-07/schema#"
}