{"openapi":"3.1.0","info":{"title":"Redfin API — RealtyAPI","version":"1.0.0","description":"Redfin API endpoints All endpoints require an API key sent in the `x-realtyapi-key` header. Get a key and try every endpoint interactively at https://www.realtyapi.io/api/redfin.","contact":{"name":"RealtyAPI","url":"https://www.realtyapi.io","email":"support@realtyapi.io"}},"externalDocs":{"description":"Interactive API playground and docs","url":"https://www.realtyapi.io/api/redfin"},"servers":[{"url":"https://redfin.realtyapi.io"}],"security":[{"ApiKeyAuth":[]}],"tags":[{"name":"Property Search","description":"Property Search endpoints"},{"name":"Property Details","description":"Property Details endpoints"},{"name":"Individual Details","description":"Individual Details endpoints"},{"name":"Market & Region Data","description":"Market & Region Data endpoints"}],"paths":{"/autocomplete":{"get":{"operationId":"get_autocomplete","summary":"autocomplete","tags":["Property Search"],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string"},"description":"Enter location/query to get autocompleted results. Ex. `New York`, `Austin`,`Texas`.","example":"Texas"},{"name":"listingStatus","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale_or_Sold","For_Rent"]},"description":"Note: `Sale/Sold` → shows standard sale response. `Rent` → shows matching rental listings."}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get Autocomplete results from query/location."}},"/detailsbyaddress":{"get":{"operationId":"get_detailsbyaddress","summary":"detailsByAddress","tags":["Property Details"],"parameters":[{"name":"property_address","in":"query","required":true,"schema":{"type":"string"},"description":"Example: `161 W 15th St Unit 4C, New York, NY 10011`.\n\n##### Note*: \n**This endpoint costs** `2 requests/call` **and it's 2x slower than the /detailsByID endpoint**","example":"166 W 22nd St Unit 1D, New York, NY 10011"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get details by property address."}},"/agentInfo":{"get":{"operationId":"get_agentInfo","summary":"agentInfo","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)**  endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"20739181"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"192575318"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get agent details"}},"/housingMarketTrends":{"get":{"operationId":"get_housingMarketTrends","summary":"housingMarketTrends","tags":["Market & Region Data"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Free-form location string. Accepts:\n- ZIP code — `27522`\n- City — `Cary, NC`\n- County or neighborhood\n- A direct `region_id` in the form `4_10960`\n\nThe backend resolves free-text inputs via Redfin's autocomplete.","example":"27522"},{"name":"propertyType","in":"query","required":false,"schema":{"type":"string","enum":["All","Houses","Condos","Townhouses"]},"description":"Filter the trend series by property type. Default: `All`.","example":"All"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Time-series housing market trends for a ZIP, city, county, neighborhood, or `region_id`. Returns:\n\n- **Median Sale Price**\n- **# Homes Sold**\n- **Days on Market** + **Sale-to-List**, **Above-list**, **Price Drops**\n\nFor US-national figures use [/usHousingMarketTrends](https://realtyapi.io/dashboard?tab=playground&api=redfin&endpoint=ushousingmarkettrends) instead."}},"/search/bycoordinates":{"get":{"operationId":"get_search_bycoordinates","summary":"search/bycoordinates","tags":["Property Search"],"parameters":[{"name":"latitude","in":"query","required":true,"schema":{"type":"string"},"description":"Enter latitude, longitude, and radius to make a square area search.","example":"40.748817"},{"name":"longitude","in":"query","required":false,"schema":{"type":"string"},"description":"Enter longitude.","example":"-73.985428"},{"name":"radius","in":"query","required":true,"schema":{"type":"string"},"description":"Enter a radius in `mile`. This is more of a distance from latitude,longitude point to each side making a square area.","example":"1.5"},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"**Number of results per page:** Specify how many properties to return in each call.\n`Default: 100` ; `Maximum: 1000` ; Minimum: 1","example":100},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"**Page number for pagination**: Each request will return a `nextPage` value as True or False. Use pagination until `nextPage = False`\n","example":1},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"**Select the type of property data you want to find.**\n"},{"name":"soldWithin","in":"query","required":false,"schema":{"type":"string","enum":["Last_7_Days"," Last_1_Month","Last_3_Months","Last_6_Months","Last_1_Year","Last_2_Years","Last_3_Years","Last_5_Years"]},"description":"> `(For Sold searches only)`\n\n**Sold properties time filter**  Filter recently sold properties by time period.\n\n`Available options:`\n- Last_7_Days (default)\n- Last_1_Month\n- Last_3_Months\n- Last_6_Months\n- Last_1_Year\n- Last_2_Years\n- Last_3_Years\n- Last_5_Years"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Most_Recently_Sold","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Price_per_Sqft","Beds","Baths"]},"description":"**Sort search results:** Select how you want to sort your search results.\n\n`For Sale:`Recommended,Newest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft\n\n`For Rent:` Recommended,Newest,Oldest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Beds,Baths\n\n`Sold:`Recommend,Recently_Sold,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft"},{"name":"minPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Minimum price filter**: Set the minimum price for properties in the search results.\n- `Format:` Numeric value (e.g., 100000 for $100,000)"},{"name":"maxPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum price filter**: Set the maximum price for properties in the search results.\n- `Format:` Numeric value (e.g., 500000 for $500,000)"},{"name":"minBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Minimum number of bedrooms**: Filter properties by minimum bedroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `Studio` - Studio apartments\n- `One` - 1+ bedrooms\n- `Two` - 2+ bedrooms\n- `Three` - 3+ bedrooms\n- `Four` - 4+ bedrooms\n- `FivePlus` - 5+ bedrooms\n- `SixPlus` - 6+ bedrooms"},{"name":"maxBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Same as minBeds**"},{"name":"baths","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OnePointFivePlus","Two","TwoPointFivePlus","ThreePlus","FourPlus","FivePlus","SixPlus"]},"description":"**Number of bathrooms**: Filter properties by minimum bathroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `OnePlus` - 1+ bathrooms\n- `OnePointFivePlus` - 1.5+ bathrooms\n- `Two` - 2+ bathrooms\n- `TwoPointFivePlus` - 2.5+ bathrooms\n- `ThreePlus` - 3+ bathrooms\n- `FourPlus` - 4+ bathrooms\n- `FivePlus` - 5+ bathrooms\n- `SixPlus` - 6+ bathrooms"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"**Property types to include**: You can combine multiple types seprated by comma. `Example:` house,condo,townhouse\n\n- `For Sale/Sold options:` House, condo, townhouse,Multi family,Land,Other,Mobile,Co-op\n\n- `For Rent options:` House, Condo, Townhouse, Apartment\n","example":"House,Condo,Townhouse,Multi family,Land,Other,Mobile,Co-op, Apartment"},{"name":"minSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"`Format:` Numeric value (e.g., 1000 for 1,000 sq ft)"},{"name":"maxSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum square footage**: Filter properties by maximum living space size.\n\n`Format:` Numeric value (e.g., 3000 for 3,000 sq ft)"},{"name":"minLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Minimum lot size**:  Filter properties by minimum lot size in square feet. For acre-sqft calculation:  `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 5000 for 5,000 sq ft)"},{"name":"maxLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n\n- **Maximum lot size**: Filter properties by maximum lot size in square feet. For acre-sqft calculation: `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 20000 for 20,000 sq ft)"},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["Active_ComingSoon","Active","ComingSoon","UnderContractOrPending","Active_UnderContractOrPending","Active_ComingSoon_UnderContract"]},"description":"> `(For Sale searches only)`\n\n\n**Property listing status**:  Filter by property listing status.\n\n`Available options:`\n- `Active_ComingSoon` - Active + Coming soon (default)\n- `Active` - Active listings only\n- `ComingSoon` - Coming soon only\n- `UnderContractOrPending` - Under contract/pending only\n- `Active_UnderContractOrPending` - Active + Under contract/pending\n- `Active_ComingSoon_UnderContract` - All statuses"},{"name":"timeOnRedfin","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(For Sale searches only)`\n\n\n**Time on market filter**: Filter properties by how long they've been on the market.\n\n`Available options:`\n- `Any` - No time filter\n- `New_listings` - New listings only\n- `Less_than_3d` - Less than 3 days\n- `Less_than_7d` - Less than 7 days\n- `Less_than_14d` - Less than 14 days\n- `Less_than_30d` - Less than 30 days\n- `More_than_7d` - More than 7 days\n- `More_than_14d` - More than 14 days\n- `More_than_30d` - More than 30 days\n- `More_than_45d` - More than 45 days\n- `More_than_60d` - More than 60 days\n- `More_than_90d` - More than 90 days\n- `More_than_180d` - More than 180 days"},{"name":"minStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`  \n- **Default**:  1"},{"name":"maxStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Default**:  1"},{"name":"minYearBuilt","in":"query","required":false,"schema":{"type":"number"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 1900"},{"name":"maxYearBuilt","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 2025"},{"name":"minMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Minimum monthly payment**: Filter by estimated minimum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 2000 for $2,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan"},{"name":"maxMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Maximum monthly payment**: Filter by estimated maximum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 5000 for $5,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan."},{"name":"hasFixerUpper","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`"},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`\nExclude 55+ communities"},{"name":"poolTypes","in":"query","required":false,"schema":{"type":"string","enum":["None","Private","Community","Private_or_Community","No_private_pool"]},"description":"> `(For Sale/Sold searches only)`\n**Pool type filter**: Filter properties by pool type availability.\n\n`Available options:`\n- `None` - Select none(Default)\n- `Private` - Private pool only\n- `Community` - Community pool only\n- `Private_or_Community` - Either private or community pool\n- `No_private_pool` - No private pool"},{"name":"garageSpots","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","1plus","2plus","3plus","4plus","5plus"]},"description":"> `(For Sale/Sold searches only)`\n**Garage spots**: Filter properties by minimum garage/parking spaces.\n\n`Available options:`\n- `No_Min` - No minimum garage requirement\n- `1plus` - 1+ garage spots\n- `2plus` - 2+ garage spots\n- `3plus` - 3+ garage spots\n- `4plus` - 4+ garage spots\n- `5plus` - 5+ garage spots"},{"name":"homeFeatures","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air conditioning, Fireplace, Waterfront, Guest house`\n\n\n**Available amenities**:\n- Include outdoor parking\n- RV parking\n- Air conditioning\n- Fireplace\n- Primary bedroom on main floor\n- Waterfront\n- Has view\n- Pets allowed\n- Washer/dryer hookup\n- Guest house\n- Accessible home (includes wheelchari, elevator, ramp)\n- Elevator\n- Green home\n\n"},{"name":"basementTypes","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\nEnter numbers only. Available values:\n- `0,1,3` : Finished+Unfinished\n- `1` : Finished\n- `3` : Unfinished"},{"name":"HOAfees","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/month`. So, input 25, means $25/month. Available value ranges from 25/month to 5000/month.\n- **Default**: No_max"},{"name":"minPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_min","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"maxPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_max","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"propertyTaxes","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/year`. So, input 250, means $250/year. Available value ranges from 250/year to 24,000/year.\n- **Default**: No_max"},{"name":"acceptedFinancing","in":"query","required":false,"schema":{"type":"string","enum":["Any","FHA","VA"]},"description":"> `(Only available for sale/sold searches)`\n\n**Available Values**: \n- `Any` by default.\n\n- `FHA`\n- `VA`"},{"name":"priceReduced","in":"query","required":false,"schema":{"type":"string","enum":["None","AnyTime","Less_than_1d","Less_than_7d","Less_than_14d","Less_than_30d","More_than_30d","More_than_60d","More_than_120d"]},"description":"> `(Only available for sale/Sold searches)`\n\n\n**Available Values**:\n- None by default.\n- AnyTime, Less_than_1d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_30d,More_than_60d, More_than_120d"},{"name":"excludeLandLeases","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale/Sold searches)`"},{"name":"listingType","in":"query","required":false,"schema":{"type":"string"},"description":"> `(Only available for sale searches)`: Enter listing type. \n- **Available values**: `New Constructions, By Agent, MLS listed Foreclosures, For Sale by owner, Foreclosures`\n- **Example Input**: New Constructions, By Agent\n- Keeping listingType empty sets all to true.","example":"New Constructions,By Agent,MLS listed Foreclosures,For Sale by owner,Foreclosures"},{"name":"excludeShortSales","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale searches)`"},{"name":"hasDeals","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Rent searches only)`\n\n\n**Show rental deals**: Filter to show only rental properties with special deals or promotions.\n"},{"name":"moveInDate","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n**Move-in date**: Specify desired move-in date for rental properties.\n\n`Format:` MM/DD/YYYY\n`Example:` 12/15/2024"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n**Available options**:\n- Cats allowed\n- Dogs allowed\n- Dogs allowed, Cats allowed"},{"name":"amenitiesRentalProperties","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air Conditioning, Laundry Facility, Dishwasher, Pool`\n\n\n**Available amenities**:\n- Air conditioning\n- In-unit washer and dryer\n- Laundry Facility\n- Washer/dryer hookups\n- Dishwasher\n- Parking allowed\n- Utilities included\n- Furnished\n- Pool\n- Other: Income restricted\n- Other: Senior living\n- Other: Short term"},{"name":"greatSchoolsRating","in":"query","required":false,"schema":{"type":"string","enum":["Any","1plus","2plus","3plus","4plus","5plus","6plus","7plus","8plus","9plus","10"]},"description":"**School rating filter**\nFilter properties by GreatSchools rating for nearby schools.\n\n`Available options:`\n- `Any` - No school rating filter\n- `1plus` - Rating 1+\n- `2plus` - Rating 2+\n- `3plus` - Rating 3+\n- `4plus` - Rating 4+\n- `5plus` - Rating 5+\n- `6plus` - Rating 6+\n- `7plus` - Rating 7+\n- `8plus` - Rating 8+\n- `9plus` - Rating 9+\n- `10` - Rating 10 (highest)"},{"name":"schoolTypes","in":"query","required":false,"schema":{"type":"string"},"description":"Only applies when `greatSchoolsRating` is not 'Any'. For multi-select, separate with commas. `Example:` Elementary,High\n\n**Available options**:\n- `Elementary` - Elementary schools\n- `Middle` - Middle schools\n- `High` - High schools\n"},{"name":"walkScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Walk Score filter**: Filter properties by Walk Score rating (walkability).\n\n`Available options:`\n- `Any` - No walk score filter\n- `10plus` - Walk Score 10+\n- `20plus` - Walk Score 20+\n- `30plus` - Walk Score 30+\n- `40plus` - Walk Score 40+\n- `50plus` - Walk Score 50+\n- `60plus` - Walk Score 60+\n- `70plus` - Walk Score 70+\n- `80plus` - Walk Score 80+\n- `90plus` - Walk Score 90+"},{"name":"transitScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Transit Score filter**: Filter properties by Transit Score rating (public transportation access).\n\n`Available options:` **Same as walkScore**\n"},{"name":"bikeScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Bike Score filter**\nFilter properties by Bike Score rating (bike-friendliness).\n\n`Available options:` **Same as walkScore**"},{"name":"openHouse_Anytime","in":"query","required":false,"schema":{"type":"boolean"},"description":">`(For Sale searches only)`\n\n\n**Open house anytime**: Filter properties with open house events (any time).\n"},{"name":"openHouse_ThisWeekend","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale searches only)`\n\n\n**Open house this weekend**: Filter properties with open house events this weekend.\n"},{"name":"3dVideoTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Rent searches only)`\n\n\n**3D/Video tour available**: Filter properties that have 3D virtual tours or video tours available.\n"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n**Keyword search**: Search properties by specific keywords in property descriptions.\n\n`Examples:` granite countertops, pool, updated kitchen"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"This endpoint lets you search Redfin via latitude, longitude and radius(miles)."}},"/detailsbyid":{"get":{"operationId":"get_detailsbyid","summary":"detailsByID","tags":["Property Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the  **Property Search (/search)**  endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"20739181"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"example":"192575318"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get details by property id and listing id."}},"/amenities":{"get":{"operationId":"get_amenities","summary":"amenities","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get amenities details"}},"/usHousingMarketTrends":{"get":{"operationId":"get_usHousingMarketTrends","summary":"usHousingMarketTrends","tags":["Market & Region Data"],"parameters":[{"name":"propertyType","in":"query","required":false,"schema":{"type":"string","enum":["All","Houses","Condos","Townhouses"]},"description":"Filter the national trend series by property type. Default: `All`.","example":"All"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"US-national housing market trends. The backend hard-codes the US national region — no `location` param needed. Returns three blocks:\n\n- **Overview** — Median Sale Price, # Homes Sold, Mortgage Rate\n- **Supply** — # Homes for Sale, Newly Listed, Days on Market, Months of Supply\n- **Demand** — Above-list, Price Drops, Sale-to-List\n\nFor region-scoped trends use [/housingMarketTrends](https://realtyapi.io/dashboard?tab=playground&api=redfin&endpoint=housingmarkettrends)."}},"/search/bylocation":{"get":{"operationId":"get_search_bylocation","summary":"search/bylocation","tags":["Property Search"],"parameters":[{"name":"locationName","in":"query","required":true,"schema":{"type":"string"},"description":"Enter an address, neighborhood, city, or ZIP code. Examples: `New York, NY; 10001; Brooklyn; Manhattan`","example":"New York"},{"name":"locationSubName","in":"query","required":false,"schema":{"type":"string"},"description":"**Location sub-identifier**: You can use this to be specific. For example, if locationName=Texas, locationSubName=Austin, TX, USA.\n\n- For Zip codes`(10001)` in locationName, leave locationSubName empty or use it as the state`(NY)`","example":"NY"},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"**Number of results per page:** Specify how many properties to return in each call.\n`Default: 100` ; `Maximum: 1000` ; Minimum: 1","example":100},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"**Page number for pagination**: Each request will return a `nextPage` value as True or False. Use pagination until `nextPage = False`","example":1},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"**Select the type of property data you want to find.**\n"},{"name":"soldWithin","in":"query","required":false,"schema":{"type":"string","enum":["Last_7_Days"," Last_1_Month","Last_3_Months","Last_6_Months","Last_1_Year","Last_2_Years","Last_3_Years","Last_5_Years"]},"description":"> `(For Sold searches only)`\n\n**Sold properties time filter**  Filter recently sold properties by time period.\n\n`Available options:`\n- Last_7_Days (default)\n- Last_1_Month\n- Last_3_Months\n- Last_6_Months\n- Last_1_Year\n- Last_2_Years\n- Last_3_Years\n- Last_5_Years"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Most_Recently_Sold","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Price_per_Sqft","Beds","Baths"]},"description":"**Sort search results:** Select how you want to sort your search results.\n\n`For Sale:`Recommended,Newest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft\n\n`For Rent:` Recommended,Newest,Oldest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Beds,Baths\n\n`Sold:`Recommend,Recently_Sold,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft"},{"name":"minPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Minimum price filter**: Set the minimum price for properties in the search results.\n- `Format:` Numeric value (e.g., 100000 for $100,000)"},{"name":"maxPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum price filter**: Set the maximum price for properties in the search results.\n- `Format:` Numeric value (e.g., 500000 for $500,000)"},{"name":"minBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Minimum number of bedrooms**: Filter properties by minimum bedroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `Studio` - Studio apartments\n- `One` - 1+ bedrooms\n- `Two` - 2+ bedrooms\n- `Three` - 3+ bedrooms\n- `Four` - 4+ bedrooms\n- `FivePlus` - 5+ bedrooms\n- `SixPlus` - 6+ bedrooms"},{"name":"maxBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Same as minBeds**"},{"name":"baths","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OnePointFivePlus","Two","TwoPointFivePlus","ThreePlus","FourPlus","FivePlus","SixPlus"]},"description":"**Number of bathrooms**: Filter properties by minimum bathroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `OnePlus` - 1+ bathrooms\n- `OnePointFivePlus` - 1.5+ bathrooms\n- `Two` - 2+ bathrooms\n- `TwoPointFivePlus` - 2.5+ bathrooms\n- `ThreePlus` - 3+ bathrooms\n- `FourPlus` - 4+ bathrooms\n- `FivePlus` - 5+ bathrooms\n- `SixPlus` - 6+ bathrooms"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"**Property types to include**: You can combine multiple types seprated by comma. `Example:` house,condo,townhouse\n\n- `For Sale/Sold options:` House, condo, townhouse,Multi family,Land,Other,Mobile,Co-op\n\n- `For Rent options:` House, Condo, Townhouse, Apartment\n","example":"House,Condo,Townhouse,Multi family,Land,Other,Mobile,Co-op, Apartment"},{"name":"minSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"`Format:` Numeric value (e.g., 1000 for 1,000 sq ft)"},{"name":"maxSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum square footage**: Filter properties by maximum living space size.\n\n`Format:` Numeric value (e.g., 3000 for 3,000 sq ft)"},{"name":"minLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Minimum lot size**:  Filter properties by minimum lot size in square feet. For acre-sqft calculation:  `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 5000 for 5,000 sq ft)"},{"name":"maxLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n\n- **Maximum lot size**: Filter properties by maximum lot size in square feet. For acre-sqft calculation: `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 20000 for 20,000 sq ft)"},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["Active_ComingSoon","Active","ComingSoon","UnderContractOrPending","Active_UnderContractOrPending","Active_ComingSoon_UnderContract"]},"description":"> `(For Sale searches only)`\n\n\n**Property listing status**:  Filter by property listing status.\n\n`Available options:`\n- `Active_ComingSoon` - Active + Coming soon (default)\n- `Active` - Active listings only\n- `ComingSoon` - Coming soon only\n- `UnderContractOrPending` - Under contract/pending only\n- `Active_UnderContractOrPending` - Active + Under contract/pending\n- `Active_ComingSoon_UnderContract` - All statuses"},{"name":"timeOnRedfin","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(For Sale searches only)`\n\n\n**Time on market filter**: Filter properties by how long they've been on the market.\n\n`Available options:`\n- `Any` - No time filter\n- `New_listings` - New listings only\n- `Less_than_3d` - Less than 3 days\n- `Less_than_7d` - Less than 7 days\n- `Less_than_14d` - Less than 14 days\n- `Less_than_30d` - Less than 30 days\n- `More_than_7d` - More than 7 days\n- `More_than_14d` - More than 14 days\n- `More_than_30d` - More than 30 days\n- `More_than_45d` - More than 45 days\n- `More_than_60d` - More than 60 days\n- `More_than_90d` - More than 90 days\n- `More_than_180d` - More than 180 days"},{"name":"minStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`  \n- **Default**:  1"},{"name":"maxStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Default**:  1"},{"name":"minYearBuilt","in":"query","required":false,"schema":{"type":"number"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 1900"},{"name":"maxYearBuilt","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 2025"},{"name":"minMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Minimum monthly payment**: Filter by estimated minimum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 2000 for $2,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan"},{"name":"maxMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Maximum monthly payment**: Filter by estimated maximum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 5000 for $5,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan."},{"name":"hasFixerUpper","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`"},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`\nExclude 55+ communities"},{"name":"poolTypes","in":"query","required":false,"schema":{"type":"string","enum":["None","Private","Community","Private_or_Community","No_private_pool"]},"description":"> `(For Sale/Sold searches only)`\n**Pool type filter**: Filter properties by pool type availability.\n\n`Available options:`\n- `None` - Select none(Default)\n- `Private` - Private pool only\n- `Community` - Community pool only\n- `Private_or_Community` - Either private or community pool\n- `No_private_pool` - No private pool"},{"name":"garageSpots","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","1plus","2plus","3plus","4plus","5plus"]},"description":"> `(For Sale/Sold searches only)`\n**Garage spots**: Filter properties by minimum garage/parking spaces.\n\n`Available options:`\n- `No_Min` - No minimum garage requirement\n- `1plus` - 1+ garage spots\n- `2plus` - 2+ garage spots\n- `3plus` - 3+ garage spots\n- `4plus` - 4+ garage spots\n- `5plus` - 5+ garage spots"},{"name":"homeFeatures","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air conditioning, Fireplace, Waterfront, Guest house`\n\n\n**Available amenities**:\n- Include outdoor parking\n- RV parking\n- Air conditioning\n- Fireplace\n- Primary bedroom on main floor\n- Waterfront\n- Has view\n- Pets allowed\n- Washer/dryer hookup\n- Guest house\n- Accessible home (includes wheelchari, elevator, ramp)\n- Elevator\n- Green home\n\n"},{"name":"basementTypes","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\nEnter numbers only. Available values:\n- `0,1,3` : Finished+Unfinished\n- `1` : Finished\n- `3` : Unfinished"},{"name":"HOAfees","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/month`. So, input 25, means $25/month. Available value ranges from 25/month to 5000/month.\n- **Default**: No_max"},{"name":"minPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_min","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"maxPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_max","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"propertyTaxes","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/year`. So, input 250, means $250/year. Available value ranges from 250/year to 24,000/year.\n- **Default**: No_max"},{"name":"acceptedFinancing","in":"query","required":false,"schema":{"type":"string","enum":["Any","FHA","VA"]},"description":"> `(Only available for sale/sold searches)`\n\n**Available Values**: \n- `Any` by default.\n\n- `FHA`\n- `VA`"},{"name":"priceReduced","in":"query","required":false,"schema":{"type":"string","enum":["None","AnyTime","Less_than_1d","Less_than_7d","Less_than_14d","Less_than_30d","More_than_30d","More_than_60d","More_than_120d"]},"description":"> `(Only available for sale/Sold searches)`\n\n\n**Available Values**:\n- None by default.\n- AnyTime, Less_than_1d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_30d,More_than_60d, More_than_120d"},{"name":"excludeLandLeases","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale/Sold searches)`"},{"name":"listingType","in":"query","required":false,"schema":{"type":"string"},"description":"> `(Only available for sale searches)`: Enter listing type. \n- **Available values**: `New Constructions, By Agent, MLS listed Foreclosures, For Sale by owner, Foreclosures`\n- **Example Input**: New Constructions, By Agent\n- Keeping listingType empty sets all to true.","example":"New Constructions,By Agent,MLS listed Foreclosures,For Sale by owner,Foreclosures"},{"name":"excludeShortSales","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale searches)`"},{"name":"hasDeals","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Rent searches only)`\n\n\n**Show rental deals**: Filter to show only rental properties with special deals or promotions.\n"},{"name":"moveInDate","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n**Move-in date**: Specify desired move-in date for rental properties.\n\n`Format:` MM/DD/YYYY\n`Example:` 12/15/2024"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n**Available options**:\n- Cats allowed\n- Dogs allowed\n- Dogs allowed, Cats allowed"},{"name":"amenitiesRentalProperties","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air Conditioning, Laundry Facility, Dishwasher, Pool`\n\n\n**Available amenities**:\n- Air conditioning\n- In-unit washer and dryer\n- Laundry Facility\n- Washer/dryer hookups\n- Dishwasher\n- Parking allowed\n- Utilities included\n- Furnished\n- Pool\n- Other: Income restricted\n- Other: Senior living\n- Other: Short term"},{"name":"greatSchoolsRating","in":"query","required":false,"schema":{"type":"string","enum":["Any","1plus","2plus","3plus","4plus","5plus","6plus","7plus","8plus","9plus","10"]},"description":"**School rating filter**\nFilter properties by GreatSchools rating for nearby schools.\n\n`Available options:`\n- `Any` - No school rating filter\n- `1plus` - Rating 1+\n- `2plus` - Rating 2+\n- `3plus` - Rating 3+\n- `4plus` - Rating 4+\n- `5plus` - Rating 5+\n- `6plus` - Rating 6+\n- `7plus` - Rating 7+\n- `8plus` - Rating 8+\n- `9plus` - Rating 9+\n- `10` - Rating 10 (highest)"},{"name":"schoolTypes","in":"query","required":false,"schema":{"type":"string"},"description":"Only applies when `greatSchoolsRating` is not 'Any'. For multi-select, separate with commas. `Example:` Elementary,High\n\n**Available options**:\n- `Elementary` - Elementary schools\n- `Middle` - Middle schools\n- `High` - High schools\n"},{"name":"walkScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Walk Score filter**: Filter properties by Walk Score rating (walkability).\n\n`Available options:`\n- `Any` - No walk score filter\n- `10plus` - Walk Score 10+\n- `20plus` - Walk Score 20+\n- `30plus` - Walk Score 30+\n- `40plus` - Walk Score 40+\n- `50plus` - Walk Score 50+\n- `60plus` - Walk Score 60+\n- `70plus` - Walk Score 70+\n- `80plus` - Walk Score 80+\n- `90plus` - Walk Score 90+"},{"name":"transitScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Transit Score filter**: Filter properties by Transit Score rating (public transportation access).\n\n`Available options:` **Same as walkScore**\n"},{"name":"bikeScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Bike Score filter**\nFilter properties by Bike Score rating (bike-friendliness).\n\n`Available options:` **Same as walkScore**"},{"name":"openHouse_Anytime","in":"query","required":false,"schema":{"type":"boolean"},"description":">`(For Sale searches only)`\n\n\n**Open house anytime**: Filter properties with open house events (any time).\n"},{"name":"openHouse_ThisWeekend","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale searches only)`\n\n\n**Open house this weekend**: Filter properties with open house events this weekend.\n"},{"name":"3dVideoTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Rent searches only)`\n\n\n**3D/Video tour available**: Filter properties that have 3D virtual tours or video tours available.\n"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n**Keyword search**: Search properties by specific keywords in property descriptions.\n\n`Examples:` granite countertops, pool, updated kitchen"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"This endpoint lets you search Redfin via location."}},"/detailsbyurl":{"get":{"operationId":"get_detailsbyurl","summary":"detailsByUrl","tags":["Property Details"],"parameters":[{"name":"property_url","in":"query","required":true,"schema":{"type":"string"},"description":"`property_url` can be retrieved directly from the Property Search endpoint, or you can use any valid property URL you already have. The shortened path format is also supported, for example: `/NY/Saint-Albans/10970-203rd-St-11412/unit-I/home/20739181`.","example":"https://www.redfin.com/NY/Saint-Albans/10970-203rd-St-11412/unit-I/home/20739181"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get details by property url."}},"/avm":{"get":{"operationId":"get_avm","summary":"avm (Estimate)","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get avm details."}},"/marketHotness":{"get":{"operationId":"get_marketHotness","summary":"marketHotness","tags":["Market & Region Data"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Free-form location string. Accepts:\n- ZIP code — `27522`\n- City — `Cary, NC`\n- County or neighborhood\n- A direct `region_id` in the form `4_10960`\n\nThe backend resolves free-text inputs via Redfin's autocomplete.","example":"27522"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"How hot is the market in this region? Returns the **Redfin Compete Score** plus a nearby-ZIP comparison block."}},"/search/bypolygon":{"get":{"operationId":"get_search_bypolygon","summary":"search/bypolygon","tags":["Property Search"],"parameters":[{"name":"polygon","in":"query","required":true,"schema":{"type":"string"},"description":"First call `/autocomplete`, then grab the **regionId** from `sections.rows.id`, and finally plug that **regionId** into your search request for accurate results.","example":"-74.00697603821754 40.73390034908897,-73.98166503757238 40.73390034908897,-73.98166503757238 40.762112501069815,-74.00697603821754 40.762112501069815,-74.00697603821754 40.73390034908897"},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"**Number of results per page:** Specify how many properties to return in each call.\n`Default: 100` ; `Maximum: 1000` ; Minimum: 1","example":100},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"**Page number for pagination**: Each request will return a `nextPage` value as True or False. Use pagination until `nextPage = False`","example":1},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"**Select the type of property data you want to find.**\n\n> **For Sale/For Rent/Sold** returns list of homes under key: `searchResults` \n\n"},{"name":"soldWithin","in":"query","required":false,"schema":{"type":"string","enum":["Last_7_Days"," Last_1_Month","Last_3_Months","Last_6_Months","Last_1_Year","Last_2_Years","Last_3_Years","Last_5_Years"]},"description":"> `(For Sold searches only)`\n\n**Sold properties time filter**  Filter recently sold properties by time period.\n\n`Available options:`\n- Last_7_Days (default)\n- Last_1_Month\n- Last_3_Months\n- Last_6_Months\n- Last_1_Year\n- Last_2_Years\n- Last_3_Years\n- Last_5_Years"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Most_Recently_Sold","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Price_per_Sqft","Beds","Baths"]},"description":"**Sort search results:** Select how you want to sort your search results.\n\n`For Sale:`Recommended,Newest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft\n\n`For Rent:` Recommended,Newest,Oldest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Beds,Baths\n\n`Sold:`Recommend,Recently_Sold,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft"},{"name":"minPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Minimum price filter**: Set the minimum price for properties in the search results.\n- `Format:` Numeric value (e.g., 100000 for $100,000)"},{"name":"maxPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum price filter**: Set the maximum price for properties in the search results.\n- `Format:` Numeric value (e.g., 500000 for $500,000)"},{"name":"minBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Minimum number of bedrooms**: Filter properties by minimum bedroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `Studio` - Studio apartments\n- `One` - 1+ bedrooms\n- `Two` - 2+ bedrooms\n- `Three` - 3+ bedrooms\n- `Four` - 4+ bedrooms\n- `FivePlus` - 5+ bedrooms\n- `SixPlus` - 6+ bedrooms"},{"name":"maxBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Same as minBeds**"},{"name":"baths","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OnePointFivePlus","Two","TwoPointFivePlus","ThreePlus","FourPlus","FivePlus","SixPlus"]},"description":"**Number of bathrooms**: Filter properties by minimum bathroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `OnePlus` - 1+ bathrooms\n- `OnePointFivePlus` - 1.5+ bathrooms\n- `Two` - 2+ bathrooms\n- `TwoPointFivePlus` - 2.5+ bathrooms\n- `ThreePlus` - 3+ bathrooms\n- `FourPlus` - 4+ bathrooms\n- `FivePlus` - 5+ bathrooms\n- `SixPlus` - 6+ bathrooms"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"**Property types to include**: You can combine multiple types seprated by comma. `Example:` house,condo,townhouse\n\n- `For Sale/Sold options:` House, condo, townhouse,Multi family,Land,Other,Mobile,Co-op\n\n- `For Rent options:` House, Condo, Townhouse, Apartment\n","example":"House,Condo,Townhouse,Multi family,Land,Other,Mobile,Co-op, Apartment"},{"name":"minSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"`Format:` Numeric value (e.g., 1000 for 1,000 sq ft)"},{"name":"maxSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum square footage**: Filter properties by maximum living space size.\n\n`Format:` Numeric value (e.g., 3000 for 3,000 sq ft)"},{"name":"minLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Minimum lot size**:  Filter properties by minimum lot size in square feet. For acre-sqft calculation:  `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 5000 for 5,000 sq ft)"},{"name":"maxLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n\n- **Maximum lot size**: Filter properties by maximum lot size in square feet. For acre-sqft calculation: `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 20000 for 20,000 sq ft)"},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["Active_ComingSoon","Active","ComingSoon","UnderContractOrPending","Active_UnderContractOrPending","Active_ComingSoon_UnderContract"]},"description":"> `(For Sale searches only)`\n\n\n**Property listing status**:  Filter by property listing status.\n\n`Available options:`\n- `Active_ComingSoon` - Active + Coming soon (default)\n- `Active` - Active listings only\n- `ComingSoon` - Coming soon only\n- `UnderContractOrPending` - Under contract/pending only\n- `Active_UnderContractOrPending` - Active + Under contract/pending\n- `Active_ComingSoon_UnderContract` - All statuses"},{"name":"timeOnRedfin","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(For Sale searches only)`\n\n\n**Time on market filter**: Filter properties by how long they've been on the market.\n\n`Available options:`\n- `Any` - No time filter\n- `New_listings` - New listings only\n- `Less_than_3d` - Less than 3 days\n- `Less_than_7d` - Less than 7 days\n- `Less_than_14d` - Less than 14 days\n- `Less_than_30d` - Less than 30 days\n- `More_than_7d` - More than 7 days\n- `More_than_14d` - More than 14 days\n- `More_than_30d` - More than 30 days\n- `More_than_45d` - More than 45 days\n- `More_than_60d` - More than 60 days\n- `More_than_90d` - More than 90 days\n- `More_than_180d` - More than 180 days"},{"name":"minStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`  \n- **Default**:  1"},{"name":"maxStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Default**:  1"},{"name":"minYearBuilt","in":"query","required":false,"schema":{"type":"number"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 1900"},{"name":"maxYearBuilt","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 2025"},{"name":"minMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Minimum monthly payment**: Filter by estimated minimum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 2000 for $2,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan"},{"name":"maxMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Maximum monthly payment**: Filter by estimated maximum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 5000 for $5,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan."},{"name":"hasFixerUpper","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`"},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`\nExclude 55+ communities"},{"name":"poolTypes","in":"query","required":false,"schema":{"type":"string","enum":["None","Private","Community","Private_or_Community","No_private_pool"]},"description":"> `(For Sale/Sold searches only)`\n**Pool type filter**: Filter properties by pool type availability.\n\n`Available options:`\n- `None` - Select none(Default)\n- `Private` - Private pool only\n- `Community` - Community pool only\n- `Private_or_Community` - Either private or community pool\n- `No_private_pool` - No private pool"},{"name":"garageSpots","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","1plus","2plus","3plus","4plus","5plus"]},"description":"> `(For Sale/Sold searches only)`\n**Garage spots**: Filter properties by minimum garage/parking spaces.\n\n`Available options:`\n- `No_Min` - No minimum garage requirement\n- `1plus` - 1+ garage spots\n- `2plus` - 2+ garage spots\n- `3plus` - 3+ garage spots\n- `4plus` - 4+ garage spots\n- `5plus` - 5+ garage spots"},{"name":"homeFeatures","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air conditioning, Fireplace, Waterfront, Guest house`\n\n\n**Available amenities**:\n- Include outdoor parking\n- RV parking\n- Air conditioning\n- Fireplace\n- Primary bedroom on main floor\n- Waterfront\n- Has view\n- Pets allowed\n- Washer/dryer hookup\n- Guest house\n- Accessible home (includes wheelchari, elevator, ramp)\n- Elevator\n- Green home\n\n"},{"name":"basementTypes","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\nEnter numbers only. Available values:\n- `0,1,3` : Finished+Unfinished\n- `1` : Finished\n- `3` : Unfinished"},{"name":"HOAfees","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/month`. So, input 25, means $25/month. Available value ranges from 25/month to 5000/month.\n- **Default**: No_max"},{"name":"minPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_min","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"maxPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_max","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"propertyTaxes","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/year`. So, input 250, means $250/year. Available value ranges from 250/year to 24,000/year.\n- **Default**: No_max"},{"name":"acceptedFinancing","in":"query","required":false,"schema":{"type":"string","enum":["Any","FHA","VA"]},"description":"> `(Only available for sale/sold searches)`\n\n**Available Values**: \n- `Any` by default.\n\n- `FHA`\n- `VA`"},{"name":"priceReduced","in":"query","required":false,"schema":{"type":"string","enum":["None","AnyTime","Less_than_1d","Less_than_7d","Less_than_14d","Less_than_30d","More_than_30d","More_than_60d","More_than_120d"]},"description":"> `(Only available for sale/Sold searches)`\n\n\n**Available Values**:\n- None by default.\n- AnyTime, Less_than_1d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_30d,More_than_60d, More_than_120d"},{"name":"excludeLandLeases","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale/Sold searches)`"},{"name":"listingType","in":"query","required":false,"schema":{"type":"string"},"description":"> `(Only available for sale searches)`: Enter listing type. \n- **Available values**: `New Constructions, By Agent, MLS listed Foreclosures, For Sale by owner, Foreclosures`\n- **Example Input**: New Constructions, By Agent\n- Keeping listingType empty sets all to true.","example":"New Constructions,By Agent,MLS listed Foreclosures,For Sale by owner,Foreclosures"},{"name":"excludeShortSales","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale searches)`"},{"name":"hasDeals","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Rent searches only)`\n\n\n**Show rental deals**: Filter to show only rental properties with special deals or promotions.\n"},{"name":"moveInDate","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n**Move-in date**: Specify desired move-in date for rental properties.\n\n`Format:` MM/DD/YYYY\n`Example:` 12/15/2024"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n**Available options**:\n- Cats allowed\n- Dogs allowed\n- Dogs allowed, Cats allowed"},{"name":"amenitiesRentalProperties","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air Conditioning, Laundry Facility, Dishwasher, Pool`\n\n\n**Available amenities**:\n- Air conditioning\n- In-unit washer and dryer\n- Laundry Facility\n- Washer/dryer hookups\n- Dishwasher\n- Parking allowed\n- Utilities included\n- Furnished\n- Pool\n- Other: Income restricted\n- Other: Senior living\n- Other: Short term"},{"name":"greatSchoolsRating","in":"query","required":false,"schema":{"type":"string","enum":["Any","1plus","2plus","3plus","4plus","5plus","6plus","7plus","8plus","9plus","10"]},"description":"**School rating filter**\nFilter properties by GreatSchools rating for nearby schools.\n\n`Available options:`\n- `Any` - No school rating filter\n- `1plus` - Rating 1+\n- `2plus` - Rating 2+\n- `3plus` - Rating 3+\n- `4plus` - Rating 4+\n- `5plus` - Rating 5+\n- `6plus` - Rating 6+\n- `7plus` - Rating 7+\n- `8plus` - Rating 8+\n- `9plus` - Rating 9+\n- `10` - Rating 10 (highest)"},{"name":"schoolTypes","in":"query","required":false,"schema":{"type":"string"},"description":"Only applies when `greatSchoolsRating` is not 'Any'. For multi-select, separate with commas. `Example:` Elementary,High\n\n**Available options**:\n- `Elementary` - Elementary schools\n- `Middle` - Middle schools\n- `High` - High schools\n"},{"name":"walkScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Walk Score filter**: Filter properties by Walk Score rating (walkability).\n\n`Available options:`\n- `Any` - No walk score filter\n- `10plus` - Walk Score 10+\n- `20plus` - Walk Score 20+\n- `30plus` - Walk Score 30+\n- `40plus` - Walk Score 40+\n- `50plus` - Walk Score 50+\n- `60plus` - Walk Score 60+\n- `70plus` - Walk Score 70+\n- `80plus` - Walk Score 80+\n- `90plus` - Walk Score 90+"},{"name":"transitScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Transit Score filter**: Filter properties by Transit Score rating (public transportation access).\n\n`Available options:` **Same as walkScore**\n"},{"name":"bikeScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Bike Score filter**\nFilter properties by Bike Score rating (bike-friendliness).\n\n`Available options:` **Same as walkScore**"},{"name":"openHouse_Anytime","in":"query","required":false,"schema":{"type":"boolean"},"description":">`(For Sale searches only)`\n\n\n**Open house anytime**: Filter properties with open house events (any time).\n"},{"name":"openHouse_ThisWeekend","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale searches only)`\n\n\n**Open house this weekend**: Filter properties with open house events this weekend.\n"},{"name":"3dVideoTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Rent searches only)`\n\n\n**3D/Video tour available**: Filter properties that have 3D virtual tours or video tours available.\n"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n**Keyword search**: Search properties by specific keywords in property descriptions.\n\n`Examples:` granite countertops, pool, updated kitchen"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"This endpoint lets you search Redfin via polygon."}},"/basicDetails":{"get":{"operationId":"get_basicDetails","summary":"basicDetails","tags":["Individual Details"],"parameters":[{"name":"property_url","in":"query","required":true,"schema":{"type":"string"},"description":"`property_url `can be retrieved directly from the Property Search endpoint, or you can use any valid property URL you already have. The shortened path format is also supported, for example: `/NY/Saint-Albans/10970-203rd-St-11412/unit-I/home/20739181`.","example":"https://www.redfin.com/NY/Hollis/9452-199th-St-11423/home/20743109"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get basic details from this endpoint."}},"/schools":{"get":{"operationId":"get_schools","summary":"schools","tags":["Market & Region Data"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Free-form location string. Accepts:\n- ZIP code — `27522`\n- City — `Cary, NC`\n- County or neighborhood\n- A direct `region_id` in the form `4_10960`\n\nThe backend resolves free-text inputs via Redfin's autocomplete.","example":"27522"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Schools serving the region — Elementary, Middle, and High — with **GreatSchools** ratings."}},"/search/byregionid":{"get":{"operationId":"get_search_byregionid","summary":"search/byregionid","tags":["Property Search"],"parameters":[{"name":"regionId","in":"query","required":true,"schema":{"type":"string"},"description":"First call `/autocomplete`, then grab the **regionId** from `sections.rows.id`, and finally plug that **regionId** into your search request for accurate results.","example":"4_3244"},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"**Number of results per page:** Specify how many properties to return in each call.\n`Default: 100` ; `Maximum: 1000` ; Minimum: 1","example":100},{"name":"page","in":"query","required":false,"schema":{"type":"number"},"description":"**Page number for pagination**: Each request will return a `nextPage` value as True or False. Use pagination until `nextPage = False`","example":1},{"name":"searchType","in":"query","required":false,"schema":{"type":"string","enum":["For_Sale","For_Rent","Sold"]},"description":"**Select the type of property data you want to find.**\n\n> **For Sale/For Rent/Sold** returns list of homes under key: `searchResults` \n\n"},{"name":"soldWithin","in":"query","required":false,"schema":{"type":"string","enum":["Last_7_Days"," Last_1_Month","Last_3_Months","Last_6_Months","Last_1_Year","Last_2_Years","Last_3_Years","Last_5_Years"]},"description":"> `(For Sold searches only)`\n\n**Sold properties time filter**  Filter recently sold properties by time period.\n\n`Available options:`\n- Last_7_Days (default)\n- Last_1_Month\n- Last_3_Months\n- Last_6_Months\n- Last_1_Year\n- Last_2_Years\n- Last_3_Years\n- Last_5_Years"},{"name":"sortOrder","in":"query","required":false,"schema":{"type":"string","enum":["Recommended","Newest","Oldest","Most_Recently_Sold","Price_High_to_Low","Price_Low_to_High","Square_Feet","Lot_Size","Price_per_Sqft","Beds","Baths"]},"description":"**Sort search results:** Select how you want to sort your search results.\n\n`For Sale:`Recommended,Newest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft\n\n`For Rent:` Recommended,Newest,Oldest,Price_High_to_Low,Price_Low_to_High,Square_Feet,Beds,Baths\n\n`Sold:`Recommend,Recently_Sold,Price_High_to_Low,Price_Low_to_High,Square_Feet,Lot_Size,Price_per_Sqft"},{"name":"minPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Minimum price filter**: Set the minimum price for properties in the search results.\n- `Format:` Numeric value (e.g., 100000 for $100,000)"},{"name":"maxPrice","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum price filter**: Set the maximum price for properties in the search results.\n- `Format:` Numeric value (e.g., 500000 for $500,000)"},{"name":"minBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Minimum number of bedrooms**: Filter properties by minimum bedroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `Studio` - Studio apartments\n- `One` - 1+ bedrooms\n- `Two` - 2+ bedrooms\n- `Three` - 3+ bedrooms\n- `Four` - 4+ bedrooms\n- `FivePlus` - 5+ bedrooms\n- `SixPlus` - 6+ bedrooms"},{"name":"maxBeds","in":"query","required":false,"schema":{"type":"string","enum":["Any","Studio","One","Two","Three","Four","FivePlus","SixPlus"]},"description":"**Same as minBeds**"},{"name":"baths","in":"query","required":false,"schema":{"type":"string","enum":["Any","OnePlus","OnePointFivePlus","Two","TwoPointFivePlus","ThreePlus","FourPlus","FivePlus","SixPlus"]},"description":"**Number of bathrooms**: Filter properties by minimum bathroom count.\n\n`Available options:`\n- `Any` - No minimum\n- `OnePlus` - 1+ bathrooms\n- `OnePointFivePlus` - 1.5+ bathrooms\n- `Two` - 2+ bathrooms\n- `TwoPointFivePlus` - 2.5+ bathrooms\n- `ThreePlus` - 3+ bathrooms\n- `FourPlus` - 4+ bathrooms\n- `FivePlus` - 5+ bathrooms\n- `SixPlus` - 6+ bathrooms"},{"name":"homeType","in":"query","required":false,"schema":{"type":"string"},"description":"**Property types to include**: You can combine multiple types seprated by comma. `Example:` house,condo,townhouse\n\n- `For Sale/Sold options:` House, condo, townhouse,Multi family,Land,Other,Mobile,Co-op\n\n- `For Rent options:` House, Condo, Townhouse, Apartment\n","example":"House,Condo,Townhouse,Multi family,Land,Other,Mobile,Co-op, Apartment"},{"name":"minSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"`Format:` Numeric value (e.g., 1000 for 1,000 sq ft)"},{"name":"maxSquareFeet","in":"query","required":false,"schema":{"type":"string"},"description":"**Maximum square footage**: Filter properties by maximum living space size.\n\n`Format:` Numeric value (e.g., 3000 for 3,000 sq ft)"},{"name":"minLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Minimum lot size**:  Filter properties by minimum lot size in square feet. For acre-sqft calculation:  `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 5000 for 5,000 sq ft)"},{"name":"maxLotSize","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n\n- **Maximum lot size**: Filter properties by maximum lot size in square feet. For acre-sqft calculation: `1 acre` = `43560 sqft`\n- **Format**: Numeric value (e.g., 20000 for 20,000 sq ft)"},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["Active_ComingSoon","Active","ComingSoon","UnderContractOrPending","Active_UnderContractOrPending","Active_ComingSoon_UnderContract"]},"description":"> `(For Sale searches only)`\n\n\n**Property listing status**:  Filter by property listing status.\n\n`Available options:`\n- `Active_ComingSoon` - Active + Coming soon (default)\n- `Active` - Active listings only\n- `ComingSoon` - Coming soon only\n- `UnderContractOrPending` - Under contract/pending only\n- `Active_UnderContractOrPending` - Active + Under contract/pending\n- `Active_ComingSoon_UnderContract` - All statuses"},{"name":"timeOnRedfin","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(For Sale searches only)`\n\n\n**Time on market filter**: Filter properties by how long they've been on the market.\n\n`Available options:`\n- `Any` - No time filter\n- `New_listings` - New listings only\n- `Less_than_3d` - Less than 3 days\n- `Less_than_7d` - Less than 7 days\n- `Less_than_14d` - Less than 14 days\n- `Less_than_30d` - Less than 30 days\n- `More_than_7d` - More than 7 days\n- `More_than_14d` - More than 14 days\n- `More_than_30d` - More than 30 days\n- `More_than_45d` - More than 45 days\n- `More_than_60d` - More than 60 days\n- `More_than_90d` - More than 90 days\n- `More_than_180d` - More than 180 days"},{"name":"minStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`  \n- **Default**:  1"},{"name":"maxStories","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)` \n- **Default**:  1"},{"name":"minYearBuilt","in":"query","required":false,"schema":{"type":"number"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 1900"},{"name":"maxYearBuilt","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n- **Input year as number**: 2025"},{"name":"minMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Minimum monthly payment**: Filter by estimated minimum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 2000 for $2,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan"},{"name":"maxMonthlyPayment","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale searches only)`\n\n\n**Maximum monthly payment**: Filter by estimated maximum monthly payment including HOA fees, property taxes, homeowners insurance, and mortgage payments.\n\n`Format:` Numeric value (e.g., 5000 for $5,000/month)\n`Note:` Based on 6.5% interest rate with 30-year fixed loan."},{"name":"hasFixerUpper","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`"},{"name":"hide55plusComm","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Sold searches only)`\nExclude 55+ communities"},{"name":"poolTypes","in":"query","required":false,"schema":{"type":"string","enum":["None","Private","Community","Private_or_Community","No_private_pool"]},"description":"> `(For Sale/Sold searches only)`\n**Pool type filter**: Filter properties by pool type availability.\n\n`Available options:`\n- `None` - Select none(Default)\n- `Private` - Private pool only\n- `Community` - Community pool only\n- `Private_or_Community` - Either private or community pool\n- `No_private_pool` - No private pool"},{"name":"garageSpots","in":"query","required":false,"schema":{"type":"string","enum":["No_Min","1plus","2plus","3plus","4plus","5plus"]},"description":"> `(For Sale/Sold searches only)`\n**Garage spots**: Filter properties by minimum garage/parking spaces.\n\n`Available options:`\n- `No_Min` - No minimum garage requirement\n- `1plus` - 1+ garage spots\n- `2plus` - 2+ garage spots\n- `3plus` - 3+ garage spots\n- `4plus` - 4+ garage spots\n- `5plus` - 5+ garage spots"},{"name":"homeFeatures","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air conditioning, Fireplace, Waterfront, Guest house`\n\n\n**Available amenities**:\n- Include outdoor parking\n- RV parking\n- Air conditioning\n- Fireplace\n- Primary bedroom on main floor\n- Waterfront\n- Has view\n- Pets allowed\n- Washer/dryer hookup\n- Guest house\n- Accessible home (includes wheelchari, elevator, ramp)\n- Elevator\n- Green home\n\n"},{"name":"basementTypes","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\nEnter numbers only. Available values:\n- `0,1,3` : Finished+Unfinished\n- `1` : Finished\n- `3` : Unfinished"},{"name":"HOAfees","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/month`. So, input 25, means $25/month. Available value ranges from 25/month to 5000/month.\n- **Default**: No_max"},{"name":"minPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_min","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"maxPricePerSQFT","in":"query","required":false,"schema":{"type":"string","enum":["No_max","50","100","150","200","250","300","400","500","600","800","1000","1400","1800","2200","2600","3000"]},"description":"> `(Only available for sale/sold searches)`\n- Each value is $ in number. $50 is 50."},{"name":"propertyTaxes","in":"query","required":false,"schema":{"type":"string","enum":["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"]},"description":"> `(Only available for sale/sold searches)`\n- Each number shows `cost/year`. So, input 250, means $250/year. Available value ranges from 250/year to 24,000/year.\n- **Default**: No_max"},{"name":"acceptedFinancing","in":"query","required":false,"schema":{"type":"string","enum":["Any","FHA","VA"]},"description":"> `(Only available for sale/sold searches)`\n\n**Available Values**: \n- `Any` by default.\n\n- `FHA`\n- `VA`"},{"name":"priceReduced","in":"query","required":false,"schema":{"type":"string","enum":["None","AnyTime","Less_than_1d","Less_than_7d","Less_than_14d","Less_than_30d","More_than_30d","More_than_60d","More_than_120d"]},"description":"> `(Only available for sale/Sold searches)`\n\n\n**Available Values**:\n- None by default.\n- AnyTime, Less_than_1d, Less_than_7d, Less_than_14d, Less_than_30d, More_than_30d,More_than_60d, More_than_120d"},{"name":"excludeLandLeases","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale/Sold searches)`"},{"name":"listingType","in":"query","required":false,"schema":{"type":"string"},"description":"> `(Only available for sale searches)`: Enter listing type. \n- **Available values**: `New Constructions, By Agent, MLS listed Foreclosures, For Sale by owner, Foreclosures`\n- **Example Input**: New Constructions, By Agent\n- Keeping listingType empty sets all to true.","example":"New Constructions,By Agent,MLS listed Foreclosures,For Sale by owner,Foreclosures"},{"name":"excludeShortSales","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(Only available for sale searches)`"},{"name":"hasDeals","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Rent searches only)`\n\n\n**Show rental deals**: Filter to show only rental properties with special deals or promotions.\n"},{"name":"moveInDate","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n**Move-in date**: Specify desired move-in date for rental properties.\n\n`Format:` MM/DD/YYYY\n`Example:` 12/15/2024"},{"name":"pets","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n**Available options**:\n- Cats allowed\n- Dogs allowed\n- Dogs allowed, Cats allowed"},{"name":"amenitiesRentalProperties","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Rent searches only)`\n\n\n- For multiple inputs, separate each with comma. For example: `Air Conditioning, Laundry Facility, Dishwasher, Pool`\n\n\n**Available amenities**:\n- Air conditioning\n- In-unit washer and dryer\n- Laundry Facility\n- Washer/dryer hookups\n- Dishwasher\n- Parking allowed\n- Utilities included\n- Furnished\n- Pool\n- Other: Income restricted\n- Other: Senior living\n- Other: Short term"},{"name":"greatSchoolsRating","in":"query","required":false,"schema":{"type":"string","enum":["Any","1plus","2plus","3plus","4plus","5plus","6plus","7plus","8plus","9plus","10"]},"description":"**School rating filter**\nFilter properties by GreatSchools rating for nearby schools.\n\n`Available options:`\n- `Any` - No school rating filter\n- `1plus` - Rating 1+\n- `2plus` - Rating 2+\n- `3plus` - Rating 3+\n- `4plus` - Rating 4+\n- `5plus` - Rating 5+\n- `6plus` - Rating 6+\n- `7plus` - Rating 7+\n- `8plus` - Rating 8+\n- `9plus` - Rating 9+\n- `10` - Rating 10 (highest)"},{"name":"schoolTypes","in":"query","required":false,"schema":{"type":"string"},"description":"Only applies when `greatSchoolsRating` is not 'Any'. For multi-select, separate with commas. `Example:` Elementary,High\n\n**Available options**:\n- `Elementary` - Elementary schools\n- `Middle` - Middle schools\n- `High` - High schools\n"},{"name":"walkScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Walk Score filter**: Filter properties by Walk Score rating (walkability).\n\n`Available options:`\n- `Any` - No walk score filter\n- `10plus` - Walk Score 10+\n- `20plus` - Walk Score 20+\n- `30plus` - Walk Score 30+\n- `40plus` - Walk Score 40+\n- `50plus` - Walk Score 50+\n- `60plus` - Walk Score 60+\n- `70plus` - Walk Score 70+\n- `80plus` - Walk Score 80+\n- `90plus` - Walk Score 90+"},{"name":"transitScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Transit Score filter**: Filter properties by Transit Score rating (public transportation access).\n\n`Available options:` **Same as walkScore**\n"},{"name":"bikeScore","in":"query","required":false,"schema":{"type":"string","enum":["Any","10plus","20plus","30plus","40plus","50plus","60plus","70plus","80plus","90plus"]},"description":"**Bike Score filter**\nFilter properties by Bike Score rating (bike-friendliness).\n\n`Available options:` **Same as walkScore**"},{"name":"openHouse_Anytime","in":"query","required":false,"schema":{"type":"boolean"},"description":">`(For Sale searches only)`\n\n\n**Open house anytime**: Filter properties with open house events (any time).\n"},{"name":"openHouse_ThisWeekend","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale searches only)`\n\n\n**Open house this weekend**: Filter properties with open house events this weekend.\n"},{"name":"3dVideoTour","in":"query","required":false,"schema":{"type":"boolean"},"description":"> `(For Sale/Rent searches only)`\n\n\n**3D/Video tour available**: Filter properties that have 3D virtual tours or video tours available.\n"},{"name":"keyword","in":"query","required":false,"schema":{"type":"string"},"description":"> `(For Sale/Sold searches only)`\n\n\n**Keyword search**: Search properties by specific keywords in property descriptions.\n\n`Examples:` granite countertops, pool, updated kitchen"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"This endpoint lets you search Redfin via regionId."}},"/customerConversionInfo":{"get":{"operationId":"get_customerConversionInfo","summary":"customerConversionInfo","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get customerConversionInfo data."}},"/climateRisk":{"get":{"operationId":"get_climateRisk","summary":"climateRisk","tags":["Market & Region Data"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Free-form location string. Accepts:\n- ZIP code — `27522`\n- City — `Cary, NC`\n- County or neighborhood\n- A direct `region_id` in the form `4_10960`\n\nThe backend resolves free-text inputs via Redfin's autocomplete.","example":"27522"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Climate risk for the region from **First Street Foundation**: Flood, Fire, Wind, and Heat factors."}},"/search/byurl":{"get":{"operationId":"get_search_byurl","summary":"search/byurl","tags":["Property Search"],"parameters":[{"name":"searchUrl","in":"query","required":true,"schema":{"type":"string"},"example":"https://www.redfin.com/zipcode/10002/filter/property-type=house,min-price=150k,max-price=2M"},{"name":"resultCount","in":"query","required":false,"schema":{"type":"number"},"description":"Set resultCount from `1 to 350`.\n\n### Note*: This endpoint processes these filters only:\n- For sale, For rent, Sold\n- Min price, max price\n- Min beds, max beds\n- Baths\n- HomeType : House, Condo, Townhouse, Multi family, Land, Other, Mobile, Co-op\n\n> If you want the endpoint to work on other filters too, please contact: oneapi.project@gmail.com","example":50}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Search by the Redfin search URL."}},"/floodInfo":{"get":{"operationId":"get_floodInfo","summary":"floodInfo","tags":["Individual Details"],"parameters":[{"name":"fipsCode","in":"query","required":true,"schema":{"type":"string"},"description":"Get `fipsCode` from Individual Details (***/basicDetails***)  or (***/parcelBound***)","example":"36081"},{"name":"apn","in":"query","required":true,"schema":{"type":"string"},"description":"Get `apn` from Individual Details (***/basicDetails***)  or (***/parcelBound***)","example":"4109420115"},{"name":"lat","in":"query","required":true,"schema":{"type":"string"},"description":"Get `lat` from Individual Details (***/basicDetails***) ","example":"40.7059662"},{"name":"lng","in":"query","required":true,"schema":{"type":"string"},"description":"Get `lng` from Individual Details (***/basicDetails***) ","example":"-73.754585"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get flood info data."}},"/recentlySold":{"get":{"operationId":"get_recentlySold","summary":"recentlySold","tags":["Market & Region Data"],"parameters":[{"name":"location","in":"query","required":true,"schema":{"type":"string"},"description":"Free-form location string. Accepts:\n- ZIP code — `27522`\n- City — `Cary, NC`\n- County or neighborhood\n- A direct `region_id` in the form `4_10960`\n\nThe backend resolves free-text inputs via Redfin's autocomplete.","example":"27522"},{"name":"count","in":"query","required":false,"schema":{"type":"number"},"description":"How many recently-sold homes to return. Default: `24`. Min: `1`. Max: `350`.","example":24}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Recently sold homes in the region."}},"/getDatePickerData":{"get":{"operationId":"get_getDatePickerData","summary":"getDatePickerData","tags":["Individual Details"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get getDatePickerData data."}},"/hotMarketInfo":{"get":{"operationId":"get_hotMarketInfo","summary":"hotMarketInfo","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get hotMarketInfo data."}},"/insights":{"get":{"operationId":"get_insights","summary":"insights","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"20739181"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `lisyingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"192575318"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get insights (below the fold) data"}},"/mainHouseInfoPanelInfo":{"get":{"operationId":"get_mainHouseInfoPanelInfo","summary":"mainHouseInfoPanelInfo","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get mainHouseInfoPanel details"}},"/mortgageCalculatorInfo":{"get":{"operationId":"get_mortgageCalculatorInfo","summary":"mortgageCalculatorInfo","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId `can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get mortgage calculator info."}},"/overview":{"get":{"operationId":"get_overview","summary":"overview","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"20739181"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The listingId can be obtained in two ways: either from the Property Search (/search) endpoint, or by passing a property URL to the Property Details (/basicDetails) endpoint.","example":"192575318"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get overview (above the fold)"}},"/popularityInfo":{"get":{"operationId":"get_popularityInfo","summary":"popularityInfo","tags":["Individual Details"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get popularityInfo data."}},"/priceDropInfo":{"get":{"operationId":"get_priceDropInfo","summary":"priceDropInfo","tags":["Individual Details"],"parameters":[{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get priceDropInfo data."}},"/tourInsights":{"get":{"operationId":"get_tourInsights","summary":"tourInsights","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get tourInsights data"}},"/walkScore":{"get":{"operationId":"get_walkScore","summary":"walkScore","tags":["Individual Details"],"parameters":[{"name":"property_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `propertyId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"13543215"},{"name":"listing_id","in":"query","required":true,"schema":{"type":"string"},"description":"The `listingId` can be obtained in two ways: either from the **Property Search (/search)** endpoint, or by passing a property URL to the **Property Details (/basicDetails)** endpoint.","example":"207197529"}],"responses":{"200":{"description":"Successful response.","headers":{"x-credits-limit":{"description":"Total credits in your current plan period.","schema":{"type":"integer"}},"x-credits-remaining":{"description":"Credits remaining in your current plan period.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"402":{"$ref":"#/components/responses/PaymentRequired"}},"description":"Get walkScore data."}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-realtyapi-key","description":"RealtyAPI key from your dashboard at https://www.realtyapi.io."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"PaymentRequired":{"description":"No credits remaining on the API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}