latitude | STRING | Required | Enter latitude, longitude, and radius to make a square area search. |
longitude | STRING | Optional | Enter longitude. |
radius | STRING | Required | Enter a radius in `mile`. This is more of a distance from latitude,longitude point to each side making a square area. |
resultCount | NUMBER | Optional | **Number of results per page:** Specify how many properties to return in each call.
`Default: 100` ; `Maximum: 1000` ; Minimum: 1 |
page | NUMBER | Optional | **Page number for pagination**: Each request will return a `nextPage` value as True or False. Use pagination until `nextPage = False`
|
searchType | ENUM | Optional | **Select the type of property data you want to find.**
Values: For_Sale, For_Rent, Sold |
soldWithin | ENUM | Optional | > `(For Sold searches only)`
**Sold properties time filter** Filter recently sold properties by time period.
`Available options:`
- Last_7_Days (default)
- Last_1_Month
- Last_3_Months
- Last_6_Months
- Last_1_Year
- Last_2_Years
- Last_3_Years
- Last_5_Years Values: Last_7_Days, Last_1_Month, Last_3_Months, Last_6_Months, Last_1_Year, Last_2_Years, Last_3_Years, Last_5_Years |
sortOrder | ENUM | Optional | **Sort search results:** Select how you want to sort your search results.
`For Sale:`Recommended,Newest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft
`For Rent:` Recommended,Newest,Oldest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Beds,Baths
`Sold:`Recommend,Recently_Sold,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft Values: Recommended, Newest, Oldest, Most_Recently_Sold, Price_High_to_Low, Price_Low_to_High, Square_Feet, Lot_Size, Price_per_Sqft, Beds, Baths |
minPrice | STRING | Optional | **Minimum price filter**: Set the minimum price for properties in the search results.
- `Format:` Numeric value (e.g., 100000 for $100,000) |
maxPrice | STRING | Optional | **Maximum price filter**: Set the maximum price for properties in the search results.
- `Format:` Numeric value (e.g., 500000 for $500,000) |
minBeds | ENUM | Optional | **Minimum number of bedrooms**: Filter properties by minimum bedroom count.
`Available options:`
- `Any` - No minimum
- `Studio` - Studio apartments
- `One` - 1+ bedrooms
- `Two` - 2+ bedrooms
- `Three` - 3+ bedrooms
- `Four` - 4+ bedrooms
- `FivePlus` - 5+ bedrooms
- `SixPlus` - 6+ bedrooms Values: Any, Studio, One, Two, Three, Four, FivePlus, SixPlus |
maxBeds | ENUM | Optional | **Same as minBeds** Values: Any, Studio, One, Two, Three, Four, FivePlus, SixPlus |
baths | ENUM | Optional | **Number of bathrooms**: Filter properties by minimum bathroom count.
`Available options:`
- `Any` - No minimum
- `OnePlus` - 1+ bathrooms
- `OnePointFivePlus` - 1.5+ bathrooms
- `Two` - 2+ bathrooms
- `TwoPointFivePlus` - 2.5+ bathrooms
- `ThreePlus` - 3+ bathrooms
- `FourPlus` - 4+ bathrooms
- `FivePlus` - 5+ bathrooms
- `SixPlus` - 6+ bathrooms Values: Any, OnePlus, OnePointFivePlus, Two, TwoPointFivePlus, ThreePlus, FourPlus, FivePlus, SixPlus |
homeType | STRING | Optional | **Property types to include**: You can combine multiple types seprated by comma. `Example:` house,condo,townhouse
- `For Sale/Sold options:` House, condo, townhouse,Multi family,Land,Other,Mobile,Co-op
- `For Rent options:` House, Condo, Townhouse, Apartment
|
minSquareFeet | STRING | Optional | `Format:` Numeric value (e.g., 1000 for 1,000 sq ft) |
maxSquareFeet | STRING | Optional | **Maximum square footage**: Filter properties by maximum living space size.
`Format:` Numeric value (e.g., 3000 for 3,000 sq ft) |
minLotSize | STRING | Optional | > `(For Sale/Sold searches only)`
- **Minimum lot size**: Filter properties by minimum lot size in square feet. For acre-sqft calculation: `1 acre` = `43560 sqft`
- **Format**: Numeric value (e.g., 5000 for 5,000 sq ft) |
maxLotSize | STRING | Optional | > `(For Sale/Sold searches only)`
- **Maximum lot size**: Filter properties by maximum lot size in square feet. For acre-sqft calculation: `1 acre` = `43560 sqft`
- **Format**: Numeric value (e.g., 20000 for 20,000 sq ft) |
status | ENUM | Optional | > `(For Sale searches only)`
**Property listing status**: Filter by property listing status.
`Available options:`
- `Active_ComingSoon` - Active + Coming soon (default)
- `Active` - Active listings only
- `ComingSoon` - Coming soon only
- `UnderContractOrPending` - Under contract/pending only
- `Active_UnderContractOrPending` - Active + Under contract/pending
- `Active_ComingSoon_UnderContract` - All statuses Values: Active_ComingSoon, Active, ComingSoon, UnderContractOrPending, Active_UnderContractOrPending, Active_ComingSoon_UnderContract |
timeOnRedfin | ENUM | Optional | > `(For Sale searches only)`
**Time on market filter**: Filter properties by how long they've been on the market.
`Available options:`
- `Any` - No time filter
- `New_listings` - New listings only
- `Less_than_3d` - Less than 3 days
- `Less_than_7d` - Less than 7 days
- `Less_than_14d` - Less than 14 days
- `Less_than_30d` - Less than 30 days
- `More_than_7d` - More than 7 days
- `More_than_14d` - More than 14 days
- `More_than_30d` - More than 30 days
- `More_than_45d` - More than 45 days
- `More_than_60d` - More than 60 days
- `More_than_90d` - More than 90 days
- `More_than_180d` - More than 180 days Values: Any, New_listings, Less_than_3d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_7d, More_than_14d, More_than_30d, More_than_45d, More_than_60d, More_than_90d, More_than_180d |
minStories | STRING | Optional | > `(For Sale/Sold searches only)`
- **Default**: 1 |
maxStories | STRING | Optional | > `(For Sale/Sold searches only)`
- **Default**: 1 |
minYearBuilt | NUMBER | Optional | > `(For Sale/Sold searches only)`
- **Input year as number**: 1900 |
maxYearBuilt | STRING | Optional | > `(For Sale/Sold searches only)`
- **Input year as number**: 2025 |
minMonthlyPayment | STRING | Optional | > `(For Sale searches only)`
**Minimum monthly payment**: Filter by estimated minimum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.
`Format:` Numeric value (e.g., 2000 for $2,000/month)
`Note:` Based on 6.5% interest rate with 30-year fixed loan |
maxMonthlyPayment | STRING | Optional | > `(For Sale searches only)`
**Maximum monthly payment**: Filter by estimated maximum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.
`Format:` Numeric value (e.g., 5000 for $5,000/month)
`Note:` Based on 6.5% interest rate with 30-year fixed loan. |
hasFixerUpper | BOOLEAN | Optional | > `(For Sale/Sold searches only)` |
hide55plusComm | BOOLEAN | Optional | > `(For Sale/Sold searches only)`
Exclude 55+ communities |
poolTypes | ENUM | Optional | > `(For Sale/Sold searches only)`
**Pool type filter**: Filter properties by pool type availability.
`Available options:`
- `None` - Select none(Default)
- `Private` - Private pool only
- `Community` - Community pool only
- `Private_or_Community` - Either private or community pool
- `No_private_pool` - No private pool Values: None, Private, Community, Private_or_Community, No_private_pool |
garageSpots | ENUM | Optional | > `(For Sale/Sold searches only)`
**Garage spots**: Filter properties by minimum garage/parking spaces.
`Available options:`
- `No_Min` - No minimum garage requirement
- `1plus` - 1+ garage spots
- `2plus` - 2+ garage spots
- `3plus` - 3+ garage spots
- `4plus` - 4+ garage spots
- `5plus` - 5+ garage spots Values: No_Min, 1plus, 2plus, 3plus, 4plus, 5plus |
homeFeatures | STRING | Optional | > `(For Sale/Sold searches only)`
- For multiple inputs, separate each with comma. For example: `Air conditioning, Fireplace, Waterfront, Guest house`
**Available amenities**:
- Include outdoor parking
- RV parking
- Air conditioning
- Fireplace
- Primary bedroom on main floor
- Waterfront
- Has view
- Pets allowed
- Washer/dryer hookup
- Guest house
- Accessible home (includes wheelchari, elevator, ramp)
- Elevator
- Green home
|
basementTypes | STRING | Optional | > `(For Sale/Sold searches only)`
Enter numbers only. Available values:
- `0,1,3` : Finished+Unfinished
- `1` : Finished
- `3` : Unfinished |
HOAfees | ENUM | Optional | > `(Only available for sale/sold searches)`
- Each number shows `cost/month`. So, input 25, means $25/month. Available value ranges from 25/month to 5000/month.
- **Default**: No_max Values: No_max, 25, 50, 75, 100, 150, 200, 250, 300, 350, 400, 450, 500, 600, 700, 800, 900, 1000, 1250, 1500, 1750, 2000, 2500, 3000, 3500, 4000, 5000 |
minPricePerSQFT | ENUM | Optional | > `(Only available for sale/sold searches)`
- Each value is $ in number. $50 is 50. Values: No_min, 50, 100, 150, 200, 250, 300, 400, 500, 600, 800, 1000, 1400, 1800, 2200, 2600, 3000 |
maxPricePerSQFT | ENUM | Optional | > `(Only available for sale/sold searches)`
- Each value is $ in number. $50 is 50. Values: No_max, 50, 100, 150, 200, 250, 300, 400, 500, 600, 800, 1000, 1400, 1800, 2200, 2600, 3000 |
propertyTaxes | ENUM | Optional | > `(Only available for sale/sold searches)`
- Each number shows `cost/year`. So, input 250, means $250/year. Available value ranges from 250/year to 24,000/year.
- **Default**: No_max Values: No_max, 250, 500, 750, 1000, 1250, 1500, 1750, 2000, 2500, 3000, 3500, 4000, 4500, 5000, 5500, 6000, 6500, 7000, 8000, 10000, 12000, 14000, 16000, 20000, 24000 |
acceptedFinancing | ENUM | Optional | > `(Only available for sale/sold searches)`
**Available Values**:
- `Any` by default.
- `FHA`
- `VA` Values: Any, FHA, VA |
priceReduced | ENUM | Optional | > `(Only available for sale/Sold searches)`
**Available Values**:
- None by default.
- AnyTime, Less_than_1d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_30d,More_than_60d, More_than_120d Values: None, AnyTime, Less_than_1d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_30d, More_than_60d, More_than_120d |
excludeLandLeases | BOOLEAN | Optional | > `(Only available for sale/Sold searches)` |
listingType | STRING | Optional | > `(Only available for sale searches)`: Enter listing type.
- **Available values**: `New Constructions, By Agent, MLS listed Foreclosures, For Sale by owner, Foreclosures`
- **Example Input**: New Constructions, By Agent
- Keeping listingType empty sets all to true. |
excludeShortSales | BOOLEAN | Optional | > `(Only available for sale searches)` |
hasDeals | BOOLEAN | Optional | > `(For Rent searches only)`
**Show rental deals**: Filter to show only rental properties with special deals or promotions.
|
moveInDate | STRING | Optional | > `(For Rent searches only)`
**Move-in date**: Specify desired move-in date for rental properties.
`Format:` MM/DD/YYYY
`Example:` 12/15/2024 |
pets | STRING | Optional | > `(For Rent searches only)`
**Available options**:
- Cats allowed
- Dogs allowed
- Dogs allowed, Cats allowed |
amenitiesRentalProperties | STRING | Optional | > `(For Rent searches only)`
- For multiple inputs, separate each with comma. For example: `Air Conditioning, Laundry Facility, Dishwasher, Pool`
**Available amenities**:
- Air conditioning
- In-unit washer and dryer
- Laundry Facility
- Washer/dryer hookups
- Dishwasher
- Parking allowed
- Utilities included
- Furnished
- Pool
- Other: Income restricted
- Other: Senior living
- Other: Short term |
greatSchoolsRating | ENUM | Optional | **School rating filter**
Filter properties by GreatSchools rating for nearby schools.
`Available options:`
- `Any` - No school rating filter
- `1plus` - Rating 1+
- `2plus` - Rating 2+
- `3plus` - Rating 3+
- `4plus` - Rating 4+
- `5plus` - Rating 5+
- `6plus` - Rating 6+
- `7plus` - Rating 7+
- `8plus` - Rating 8+
- `9plus` - Rating 9+
- `10` - Rating 10 (highest) Values: Any, 1plus, 2plus, 3plus, 4plus, 5plus, 6plus, 7plus, 8plus, 9plus, 10 |
schoolTypes | STRING | Optional | Only applies when `greatSchoolsRating` is not 'Any'. For multi-select, separate with commas. `Example:` Elementary,High
**Available options**:
- `Elementary` - Elementary schools
- `Middle` - Middle schools
- `High` - High schools
|
walkScore | ENUM | Optional | **Walk Score filter**: Filter properties by Walk Score rating (walkability).
`Available options:`
- `Any` - No walk score filter
- `10plus` - Walk Score 10+
- `20plus` - Walk Score 20+
- `30plus` - Walk Score 30+
- `40plus` - Walk Score 40+
- `50plus` - Walk Score 50+
- `60plus` - Walk Score 60+
- `70plus` - Walk Score 70+
- `80plus` - Walk Score 80+
- `90plus` - Walk Score 90+ Values: Any, 10plus, 20plus, 30plus, 40plus, 50plus, 60plus, 70plus, 80plus, 90plus |
transitScore | ENUM | Optional | **Transit Score filter**: Filter properties by Transit Score rating (public transportation access).
`Available options:` **Same as walkScore**
Values: Any, 10plus, 20plus, 30plus, 40plus, 50plus, 60plus, 70plus, 80plus, 90plus |
bikeScore | ENUM | Optional | **Bike Score filter**
Filter properties by Bike Score rating (bike-friendliness).
`Available options:` **Same as walkScore** Values: Any, 10plus, 20plus, 30plus, 40plus, 50plus, 60plus, 70plus, 80plus, 90plus |
openHouse_Anytime | BOOLEAN | Optional | >`(For Sale searches only)`
**Open house anytime**: Filter properties with open house events (any time).
|
openHouse_ThisWeekend | BOOLEAN | Optional | > `(For Sale searches only)`
**Open house this weekend**: Filter properties with open house events this weekend.
|
3dVideoTour | BOOLEAN | Optional | > `(For Sale/Rent searches only)`
**3D/Video tour available**: Filter properties that have 3D virtual tours or video tours available.
|
keyword | STRING | Optional | > `(For Sale/Sold searches only)`
**Keyword search**: Search properties by specific keywords in property descriptions.
`Examples:` granite countertops, pool, updated kitchen |