### GET /listings/sale - Example with Multiple Value Parameters Source: https://developers.rentcast.io/reference/search-queries This example demonstrates how to retrieve sale listings using multiple values for parameters like propertyType and bedrooms. ```APIDOC ## GET /listings/sale ### Description Retrieves sale listings with specified criteria, supporting multiple values for certain query parameters. ### Method GET ### Endpoint /listings/sale ### Parameters #### Query Parameters - **city** (string) - Required - The city to search within. - **state** (string) - Required - The state to search within. - **propertyType** (string) - Optional - Allows multiple values separated by `|` (e.g., `Condo|Townhouse`). Supports `Condo`, `Townhouse`, etc. - **bedrooms** (string) - Optional - Allows multiple values separated by `|` (e.g., `2|3`). - **limit** (integer) - Optional - The maximum number of results to return. ### Request Example ```curl curl --request GET \ --url 'https://api.rentcast.io/v1/listings/sale?city=Austin&state=TX&propertyType=Condo|Townhouse&bedrooms=2|3&limit=10' \ --header 'Accept: application/json' \ --header 'X-Api-Key: YOUR_API_KEY' ``` ### Response #### Success Response (200) - **listings** (array) - An array of listing objects. - **propertyType** (string) - The type of the property. - **bedrooms** (integer) - The number of bedrooms. - ... (other listing details) #### Response Example ```json { "listings": [ { "propertyType": "Condo", "bedrooms": 2, "city": "Austin", "state": "TX", "limit": 10 }, { "propertyType": "Townhouse", "bedrooms": 3, "city": "Austin", "state": "TX", "limit": 10 } ] } ``` ``` -------------------------------- ### GET /listings/rental/long-term - Example with Numeric Range Parameters Source: https://developers.rentcast.io/reference/search-queries This example shows how to fetch long-term rental listings using numeric range filters for parameters like bedrooms, price, and daysOld. ```APIDOC ## GET /listings/rental/long-term ### Description Retrieves long-term rental listings with specified criteria, supporting numeric range filters for various parameters. ### Method GET ### Endpoint /listings/rental/long-term ### Parameters #### Query Parameters - **city** (string) - Required - The city to search within. - **state** (string) - Required - The state to search within. - **bedrooms** (string) - Optional - Supports numeric range (e.g., `2:4` for 2 to 4 bedrooms). - **price** (string) - Optional - Supports numeric range (e.g., `1200:*` for $1,200 or more). - **daysOld** (string) - Optional - Supports numeric range (e.g., `*:30` for 30 days or less). - **limit** (integer) - Optional - The maximum number of results to return. ### Request Example ```curl curl --request GET \ --url 'https://api.rentcast.io/v1/listings/rental/long-term?city=Austin&state=TX&bedrooms=2:4&price=1200:*&daysOld=*:30&limit=10' \ --header 'Accept: application/json' \ --header 'X-Api-Key: YOUR_API_KEY' ``` ### Response #### Success Response (200) - **listings** (array) - An array of rental listing objects. - **bedrooms** (integer) - The number of bedrooms. - **price** (float) - The listed rent price. - **daysOld** (integer) - The number of days the property has been listed. - ... (other listing details) #### Response Example ```json { "listings": [ { "bedrooms": 3, "price": 1500.00, "daysOld": 15, "city": "Austin", "state": "TX", "limit": 10 }, { "bedrooms": 4, "price": 1300.00, "daysOld": 25, "city": "Austin", "state": "TX", "limit": 10 } ] } ``` ### Callout - The `saleDateRange` and `daysOld` query parameters are always treated as a range. If you provide a single value for either of them, it will be treated as the maximum range value. ``` -------------------------------- ### Property Listing Example (Standard) - JSON Source: https://developers.rentcast.io/reference/property-listings An example of a standard property listing record returned by the Rentcast API. This JSON object includes comprehensive details about a property, its listing status, pricing, and agent information. ```json { "id": "3821-Hargis-St,-Austin,-TX-78723", "formattedAddress": "3821 Hargis St, Austin, TX 78723", "addressLine1": "3821 Hargis St", "addressLine2": null, "city": "Austin", "state": "TX", "stateFips": "48", "zipCode": "78723", "county": "Travis", "countyFips": "453", "latitude": 30.290643, "longitude": -97.701547, "propertyType": "Single Family", "bedrooms": 4, "bathrooms": 2.5, "squareFootage": 2345, "lotSize": 3284, "yearBuilt": 2008, "hoa": { "fee": 65 }, "status": "Active", "price": 899000, "listingType": "Standard", "listedDate": "2024-06-24T00:00:00.000Z", "removedDate": null, "createdDate": "2021-06-25T00:00:00.000Z", "lastSeenDate": "2024-09-30T13:11:47.157Z", "daysOnMarket": 99, "mlsName": "UnlockMLS", "mlsNumber": "5519228", "listingAgent": { "name": "Jennifer Welch", "phone": "5124313110", "email": "jennifer@gottesmanresidential.com", "website": "https://www.gottesmanresidential.com" }, "listingOffice": { "name": "Gottesman Residential R.E.", "phone": "5124512422", "email": "nataliem@gottesmanresidential.com", "website": "https://www.gottesmanresidential.com" }, "history": { "2021-07-28": { "event": "Sale Listing", "price": 949000, "listingType": "Standard", "listedDate": "2021-07-28T00:00:00.000Z", "removedDate": "2021-08-23T00:00:00.000Z", "daysOnMarket": 26 }, "2024-06-24": { "event": "Sale Listing", "price": 899000, "listingType": "Standard", "listedDate": "2024-06-24T00:00:00.000Z", "removedDate": null, "daysOnMarket": 99 } } } ``` -------------------------------- ### Property Listing Example (New Construction) - JSON Source: https://developers.rentcast.io/reference/property-listings An example of a new construction property listing record from the Rentcast API. This JSON structure highlights specific fields relevant to new builds, such as builder information and development details. ```json { "id": "3781-Passion-Vine-Dr,-Alva,-FL-33920", "formattedAddress": "3781 Passion Vine Dr, Alva, FL 33920", "addressLine1": "3781 Passion Vine Dr", "addressLine2": null, "city": "Alva", "state": "FL", "stateFips": "12", "zipCode": "33920", "county": "Lee", "countyFips": "071", "latitude": 26.686521, "longitude": -81.685764, "propertyType": "Single Family", "bedrooms": 4, "bathrooms": 2, "squareFootage": 1850, "lotSize": 7405, "yearBuilt": 2023, "hoa": { "fee": 220 }, "status": "Active", "price": 428595, "listingType": "New Construction", "listedDate": "2024-09-19T00:00:00.000Z", "removedDate": null, "createdDate": "2024-07-24T00:00:00.000Z", "lastSeenDate": "2024-09-28T12:28:50.115Z", "daysOnMarket": 10, "builder": { "name": "Pulte Homes", "development": "Hampton Lakes at River Hall", "phone": "2392300326", "website": "https://www.pulte.com" }, "history": { "2024-09-19": { "event": "Sale Listing", "price": 428595, "listingType": "New Construction", "listedDate": "2024-09-19T00:00:00.000Z", "removedDate": null, "daysOnMarket": 10 } } } ``` -------------------------------- ### Get Total Results Count with cURL Source: https://developers.rentcast.io/reference/pagination This cURL example demonstrates how to request the total number of properties matching a query by setting `includeTotalCount=true`. The API response will include an `X-Total-Count` header containing the total number of matching results. This method can increase API response times and should be used judiciously. ```curl curl --request GET \ --url 'https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=20&includeTotalCount=true' \ --header 'Accept: application/json' \ --header 'X-Api-Key: YOUR_API_KEY' ``` -------------------------------- ### Example Successful Property Search Response Source: https://developers.rentcast.io/reference/property-records Provides an example of a successful JSON response when searching for properties. It includes detailed information about a property, such as its address, size, sale history, and features. ```JSON [ { "id": "5500-Grand-Lake-Dr,-San-Antonio,-TX-78244", "formattedAddress": "5500 Grand Lake Dr, San Antonio, TX 78244", "addressLine1": "5500 Grand Lake Dr", "addressLine2": null, "city": "San Antonio", "state": "TX", "stateFips": "48", "zipCode": "78244", "county": "Bexar", "countyFips": "029", "latitude": 29.475962, "longitude": -98.351442, "propertyType": "Single Family", "bedrooms": 3, "bathrooms": 2, "squareFootage": 1878, "lotSize": 8850, "yearBuilt": 1973, "assessorID": "05076-103-0500", "legalDescription": "CB 5076A BLK 3 LOT 50", "subdivision": "WOODLAKE", "zoning": "RH", "lastSaleDate": "2024-11-18T00:00:00.000Z", "lastSalePrice": 270000, "hoa": { "fee": 175 }, "features": { "architectureType": "Contemporary", "cooling": true, "coolingType": "Central", "exteriorType": "Wood", "fireplace": true } } ] ``` -------------------------------- ### Property Data Schema Example Source: https://developers.rentcast.io/reference/value-estimate This JSON snippet illustrates the structure of property data returned by the Rentcast API. It includes fields such as address components, property characteristics, and listing information with their respective data types and example values. ```json { "addressLine2": { "type": "string" }, "city": { "type": "string", "example": "San Antonio" }, "state": { "type": "string", "example": "TX" }, "stateFips": { "type": "string", "example": "48" }, "zipCode": { "type": "string", "example": "78244" }, "county": { "type": "string", "example": "Bexar" }, "countyFips": { "type": "string", "example": "029" }, "latitude": { "type": "number", "example": 29.47046, "default": "" }, "longitude": { "type": "number", "example": -98.351561, "default": "" }, "propertyType": { "type": "string", "example": "Single Family" }, "bedrooms": { "type": "number", "example": 3, "default": "" }, "bathrooms": { "type": "number", "example": 2, "default": "" }, "squareFootage": { "type": "number", "example": 1895, "default": "" }, "lotSize": { "type": "number", "example": 6882, "default": "" }, "yearBuilt": { "type": "number", "example": 1988, "default": "" }, "status": { "type": "string", "example": "Active" }, "price": { "type": "number", "example": 289444, "default": "" }, "listingType": { "type": "string", "example": "Standard" }, "listedDate": { "type": "string", "example": "2025-04-11T00:00:00.000Z", "format": "date-time" }, "removedDate": { "type": "string", "format": "date-time" }, "lastSeenDate": { "type": "string", "example": "2025-09-03T10:57:39.532Z", "format": "date-time" }, "daysOnMarket": { "type": "number", "example": 146, "default": "" }, "distance": { "type": "number", "example": 0.384, "default": "" }, "daysOld": { "type": "number", "example": 1, "default": "" }, "correlation": { "type": "number", "example": 0.9916, "default": "" } } ``` -------------------------------- ### Market Data Response Example (JSON) Source: https://developers.rentcast.io/reference/market-data An example of the JSON response structure for market data, including price and rent statistics, days on market, and listing counts for a specific zip code. This response provides aggregated data for sales and rentals, further broken down by property type. ```json { "id": "29611", "zipCode": "29611", "saleData": { "lastUpdatedDate": "2025-08-26T00:00:00.000Z", "averagePrice": 356598, "medianPrice": 295000, "minPrice": 8899, "maxPrice": 2530000, "averagePricePerSquareFoot": 203.45, "medianPricePerSquareFoot": 188.61, "minPricePerSquareFoot": 54, "maxPricePerSquareFoot": 943.24, "averageSquareFootage": 1717, "medianSquareFootage": 1573, "minSquareFootage": 636, "maxSquareFootage": 6000, "averageDaysOnMarket": 77, "medianDaysOnMarket": 61, "minDaysOnMarket": 2, "maxDaysOnMarket": 279, "newListings": 41, "totalListings": 248, "dataByPropertyType": [ { "propertyType": "Condo", "averagePrice": 398267, "medianPrice": 157500, "minPrice": 124900, "maxPrice": 1599000, "averagePricePerSquareFoot": 174.28, "medianPricePerSquareFoot": 132.02, "minPricePerSquareFoot": 119.07, "maxPricePerSquareFoot": 357.48, "averageSquareFootage": 1700, "medianSquareFootage": 1148, "minSquareFootage": 1049, "maxSquareFootage": 4473, "averageDaysOnMarket": 119.17, "medianDaysOnMarket": 111, "minDaysOnMarket": 33, "maxDaysOnMarket": 225, "newListings": 0, "totalListings": 6 }, { "propertyType": "Land", "averagePrice": 481907, "medianPrice": 275000, "minPrice": 36900, "maxPrice": 2530000, "averagePricePerSquareFoot": null, "medianPricePerSquareFoot": null, "minPricePerSquareFoot": null, "maxPricePerSquareFoot": null, "averageSquareFootage": null, "medianSquareFootage": null, "minSquareFootage": null, "maxSquareFootage": null, "averageDaysOnMarket": 107.43, "medianDaysOnMarket": 104, "minDaysOnMarket": 5, "maxDaysOnMarket": 256, "newListings": 1, "totalListings": 28 }, { "propertyType": "Manufactured", "averagePrice": 154643, "medianPrice": 89900, "minPrice": 8899, "maxPrice": 499900, "averagePricePerSquareFoot": 83.07, "medianPricePerSquareFoot": 69.85, "minPricePerSquareFoot": 54, "maxPricePerSquareFoot": 127.66, "averageSquareFootage": 2090, "medianSquareFootage": 1175, "minSquareFootage": 924, "maxSquareFootage": 6000, "averageDaysOnMarket": 116.43, "medianDaysOnMarket": 97, "minDaysOnMarket": 81, "maxDaysOnMarket": 181, "newListings": 0, "totalListings": 7 }, { "propertyType": "Multi-Family", "averagePrice": 446750, "medianPrice": 479900, "minPrice": 240000, "maxPrice": 514500, "averagePricePerSquareFoot": 182.87, "medianPricePerSquareFoot": 180.01, "minPricePerSquareFoot": 152.73, "maxPricePerSquareFoot": 217.79, "averageSquareFootage": 2498, "medianSquareFootage": 2666, "minSquareFootage": 1102, "maxSquareFootage": 3200, "averageDaysOnMarket": 37, "medianDaysOnMarket": 11, "minDaysOnMarket": 11, "maxDaysOnMarket": 134, "newListings": 4, "totalListings": 8 }, { "propertyType": "Single Family", "averagePrice": 347649, "medianPrice": 305000, "minPrice": 128000, "maxPrice": 1798611, "averagePricePerSquareFoot": 214.07, "medianPricePerSquareFoot": 206.33, "minPricePerSquareFoot": 94.79 } ] } } ``` -------------------------------- ### API Success Example Response Source: https://developers.rentcast.io/reference/value-estimate This JSON object represents a successful API response, providing an example of property data including price and price range details. This is useful for understanding the expected output format for successful queries. ```json { "price": 250000, "priceRangeLow": 195000, "priceRangeHigh": 304000 } ``` -------------------------------- ### GET /v1/rent/estimate Source: https://developers.rentcast.io/reference/rent-estimate-long-term Returns a property rent estimate and comparable properties based on address or coordinates. ```APIDOC ## GET /v1/rent/estimate ### Description Returns the current property rent estimate and comparable rental listings for a specific address or a latitude/longitude coordinate. The rent estimate represents the expected long-term rental income for the property. ### Method GET ### Endpoint /v1/rent/estimate ### Parameters #### Query Parameters - **address** (string) - Optional - The street address of the property (e.g., "123 Main St, Anytown, CA 90210"). - **lat** (number) - Optional - The latitude of the property's location. - **lon** (number) - Optional - The longitude of the property's location. - **distance** (number) - Optional - The maximum distance in miles to search for comparable properties. Defaults to 5 miles. - **limit** (integer) - Optional - The maximum number of comparable properties to return. Defaults to 10. ### Request Example ```json { "request": "GET /v1/rent/estimate?address=1600+Amphitheatre+Parkway,+Mountain+View,+CA" } ``` ### Response #### Success Response (200) - **rentEstimate** (object) - The estimated monthly rent for the property. - **value** (number) - The estimated rent amount. - **currency** (string) - The currency of the rent estimate (e.g., "USD"). - **comparableProperties** (array) - A list of comparable rental properties. - **correlation** (number) - A score indicating how similar the comparable property is to the subject property. - **property** (object) - Details of the comparable property. - **address** (object) - The address of the comparable property. - **street** (string) - **city** (string) - **state** (string) - **zipcode** (string) - **rentEstimate** (object) - The rent estimate for the comparable property. - **value** (number) - **currency** (string) - **subjectProperty** (object) - Attributes of the subject property. #### Response Example ```json { "rentEstimate": { "value": 2500, "currency": "USD" }, "comparableProperties": [ { "correlation": 0.95, "property": { "address": { "street": "123 Main St", "city": "Anytown", "state": "CA", "zipcode": "90210" }, "rentEstimate": { "value": 2450, "currency": "USD" } } } ], "subjectProperty": { "bedrooms": 3, "bathrooms": 2, "squareFootage": 1500 } } ``` ``` -------------------------------- ### Property Record Example - JSON Source: https://developers.rentcast.io/reference/property-data An example of a single-family residential property record returned by the Rentcast API. This JSON object includes detailed information such as address, property characteristics, tax history, sale history, and owner details. Data availability for specific fields may vary by location. ```json { "id": "5500-Grand-Lake-Dr,-San-Antonio,-TX-78244", "formattedAddress": "5500 Grand Lake Dr, San Antonio, TX 78244", "addressLine1": "5500 Grand Lake Dr", "addressLine2": null, "city": "San Antonio", "state": "TX", "stateFips": "48", "zipCode": "78244", "county": "Bexar", "countyFips": "029", "latitude": 29.475962, "longitude": -98.351442, "propertyType": "Single Family", "bedrooms": 3, "bathrooms": 2, "squareFootage": 1878, "lotSize": 8850, "yearBuilt": 1973, "assessorID": "05076-103-0500", "legalDescription": "CB 5076A BLK 3 LOT 50", "subdivision": "WOODLAKE", "zoning": "RH", "lastSaleDate": "2024-11-18T00:00:00.000Z", "lastSalePrice": 270000, "hoa": { "fee": 175 }, "features": { "architectureType": "Contemporary", "cooling": true, "coolingType": "Central", "exteriorType": "Wood", "fireplace": true, "fireplaceType": "Masonry", "floorCount": 1, "foundationType": "Slab / Mat / Raft", "garage": true, "garageSpaces": 2, "garageType": "Garage", "heating": true, "heatingType": "Forced Air", "pool": true, "poolType": "Concrete", "roofType": "Asphalt", "roomCount": 5, "unitCount": 1, "viewType": "City" }, "taxAssessments": { "2020": { "year": 2020, "value": 142610, "land": 23450, "improvements": 119160 }, "2021": { "year": 2021, "value": 163440, "land": 45050, "improvements": 118390 }, "2022": { "year": 2022, "value": 197600, "land": 49560, "improvements": 148040 }, "2023": { "year": 2023, "value": 225790, "land": 59380, "improvements": 166410 }, "2024": { "year": 2024, "value": 216513, "land": 59380, "improvements": 157133 } }, "propertyTaxes": { "2020": { "year": 2020, "total": 3023 }, "2021": { "year": 2021, "total": 3455 }, "2022": { "year": 2022, "total": 4077 }, "2023": { "year": 2023, "total": 4201 }, "2024": { "year": 2024, "total": 4065 } }, "history": { "2017-10-19": { "event": "Sale", "date": "2017-10-19T00:00:00.000Z", "price": 185000 }, "2024-11-18": { "event": "Sale", "date": "2024-11-18T00:00:00.000Z", "price": 270000 } }, "owner": { "names": [ "Rolando Villarreal" ], "type": "Individual", "mailingAddress": { "id": "5500-Grand-Lake-Dr,-San-Antonio,-TX-78244", "formattedAddress": "5500 Grand Lake Dr, San Antonio, TX 78244", "addressLine1": "5500 Grand Lake Dr", "addressLine2": null, "city": "San Antonio", "state": "TX", "stateFips": "48", "zipCode": "78244" } }, "ownerOccupied": true } ``` -------------------------------- ### GET /properties/details Source: https://developers.rentcast.io/reference/market-statistics Retrieves detailed information about properties, including sales data and rental breakdowns for a specified zip code. ```APIDOC ## GET /properties/details ### Description Retrieves detailed information about properties, including sales data and rental breakdowns for a specified zip code. ### Method GET ### Endpoint `/properties/details` ### Parameters #### Query Parameters - **zipCode** (string) - Required - The zip code for which to retrieve property details. ### Request Example ```json { "zipCode": "29611" } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the property. - **zipCode** (string) - The zip code of the property. - **saleData** (object) - Contains sales-related information for the property. - **lastUpdatedDate** (string) - The date when the sales data was last updated. - **averagePrice** (number) - The average sale price of properties in the area. - **medianPrice** (number) - The median sale price of properties in the area. - **minPrice** (number) - The minimum sale price of properties in the area. - **maxPrice** (number) - The maximum sale price of properties in the area. - **averagePricePerSquareFoot** (number) - The average sale price per square foot. - **medianPricePerSquareFoot** (number) - The median sale price per square foot. - **minPricePerSquareFoot** (number) - The minimum sale price per square foot. - **maxPricePerSquareFoot** (number) - The maximum sale price per square foot. - **averageSquareFootage** (number) - The average square footage of properties. - **medianSquareFootage** (number) - The median square footage of properties. - **minSquareFootage** (number) - The minimum square footage of properties. - **maxSquareFootage** (number) - The maximum square footage of properties. - **averageDaysOnMarket** (number) - The average number of days properties stayed on the market. - **medianDaysOnMarket** (number) - The median number of days properties stayed on the market. #### Response Example ```json { "id": "29611", "zipCode": "29611", "saleData": { "lastUpdatedDate": "2025-08-26T00:00:00.000Z", "averagePrice": 356598, "medianPrice": 295000, "minPrice": 8899, "maxPrice": 2530000, "averagePricePerSquareFoot": 203.45, "medianPricePerSquareFoot": 188.61, "minPricePerSquareFoot": 54, "maxPricePerSquareFoot": 943.24, "averageSquareFootage": 1717, "medianSquareFootage": 1573, "minSquareFootage": 636, "maxSquareFootage": 6000, "averageDaysOnMarket": 77, "medianDaysOnMarket": 61 } } ``` ``` -------------------------------- ### GET /market-data Source: https://developers.rentcast.io/reference/market-statistics Retrieves aggregated rental market data. This endpoint provides key metrics such as average rent, days on market, and a breakdown of data by property type. ```APIDOC ## GET /market-data ### Description Retrieves aggregated rental market data. This endpoint provides key metrics such as average rent, days on market, and a breakdown of data by property type. ### Method GET ### Endpoint /market-data ### Parameters #### Query Parameters - **location** (string) - Optional - The geographic location for which to retrieve market data (e.g., city, zip code). - **propertyType** (string) - Optional - Filters the results to a specific property type (e.g., "Apartment", "House"). ### Request Example ```json { "example": "GET /market-data?location=San%20Francisco&propertyType=Apartment" } ``` ### Response #### Success Response (200) - **averageRent** (number) - The average rental price for the specified location. - **medianRent** (number) - The median rental price for the specified location. - **minRent** (number) - The minimum rental price observed. - **maxRent** (number) - The maximum rental price observed. - **averageDaysOnMarket** (number) - The average number of days properties spend on the market. - **medianDaysOnMarket** (number) - The median number of days properties spend on the market. - **minDaysOnMarket** (number) - The minimum number of days properties spend on the market. - **maxDaysOnMarket** (number) - The maximum number of days properties spend on the market. - **newListings** (number) - The number of new listings in the period. - **totalListings** (number) - The total number of active listings. - **dataByPropertyType** (array) - An array of objects, each detailing market data for a specific property type. - **propertyType** (string) - The type of property (e.g., "Apartment", "House"). - **averageRent** (number) - The average rental price for this property type. - **medianRent** (number) - The median rental price for this property type. - **minRent** (number) - The minimum rental price for this property type. - **maxRent** (number) - The maximum rental price for this property type. - **averageRentPerSquareFoot** (number) - The average rent per square foot for this property type. - **medianRentPerSquareFoot** (number) - The median rent per square foot for this property type. - **minRentPerSquareFoot** (number) - The minimum rent per square foot for this property type. - **maxRentPerSquareFoot** (number) - The maximum rent per square foot for this property type. - **averageSquareFootage** (number) - The average square footage for this property type. - **medianSquareFootage** (number) - The median square footage for this property type. - **minSquareFootage** (number) - The minimum square footage for this property type. #### Response Example ```json { "averageRent": 2672, "medianRent": 2672, "minRent": 875, "maxRent": 1835, "averageDaysOnMarket": 34.06, "medianDaysOnMarket": 1, "minDaysOnMarket": 1, "maxDaysOnMarket": 321, "newListings": 46, "totalListings": 94, "dataByPropertyType": [ { "propertyType": "Apartment", "averageRent": 1098, "medianRent": 1025, "minRent": 875, "maxRent": 1835, "averageRentPerSquareFoot": 1.25, "medianRentPerSquareFoot": 1.1, "minRentPerSquareFoot": 1.05, "maxRentPerSquareFoot": 2.03, "averageSquareFootage": 911, "medianSquareFootage": 950, "minSquareFootage": 629 } ] } ``` ``` -------------------------------- ### GET /properties/rentals Source: https://developers.rentcast.io/reference/market-statistics Retrieves rental data for properties, including current and historical rent information, and property characteristics relevant to rentals. ```APIDOC ## GET /properties/rentals ### Description Retrieves rental data for properties, including current and historical rent information, and property characteristics relevant to rentals. ### Method GET ### Endpoint /properties/rentals ### Parameters #### Query Parameters - **address** (string) - Optional - The street address of the property. - **city** (string) - Optional - The city where the property is located. - **state** (string) - Optional - The state where the property is located (e.g., 'CA', 'NY'). - **zipcode** (string) - Optional - The zip code of the property. - **date** (string) - Optional - Specific date for rental data (YYYY-MM-DD). If not provided, the latest available data is returned. ### Request Example ``` GET /properties/rentals?state=TX&city=Austin&date=2024-01-01 ``` ### Response #### Success Response (200) - **properties** (array) - An array of property rental records. - **propertyId** (string) - Unique identifier for the property. - **address** (object) - Address details of the property. - **rentalData** (object) - Historical and current rental metrics. - **date** (string) - The date of the rental data. - **averageRent** (number) - The average rent for properties in the area. - **medianRent** (number) - The median rent for properties in the area. - **minRent** (number) - The minimum rent observed. - **maxRent** (number) - The maximum rent observed. - **averageRentPerSquareFoot** (number) - Average rent per square foot. - **medianRentPerSquareFoot** (number) - Median rent per square foot. - **averageSquareFootage** (number) - Average square footage of rental units. - **medianSquareFootage** (number) - Median square footage of rental units. #### Response Example ```json { "properties": [ { "propertyId": "abcdef12-3456-7890-abcd-ef1234567890", "address": { "street": "456 Oak Ave", "city": "Austin", "state": "TX", "zipcode": "78701" }, "rentalData": { "date": "2024-01-01T00:00:00.000Z", "averageRent": 1800, "medianRent": 1750, "minRent": 900, "maxRent": 3500, "averageRentPerSquareFoot": 1.50, "medianRentPerSquareFoot": 1.45, "averageSquareFootage": 1200, "medianSquareFootage": 1100 } } ] } ``` ``` -------------------------------- ### GET /properties/analytics Source: https://developers.rentcast.io/reference/market-statistics Retrieves aggregated analytics data for properties, allowing for analysis of market trends based on various criteria like location and number of bedrooms. ```APIDOC ## GET /properties/analytics ### Description Retrieves aggregated analytics data for properties, allowing for analysis of market trends based on various criteria like location and number of bedrooms. ### Method GET ### Endpoint /properties/analytics ### Parameters #### Query Parameters - **city** (string) - Optional - Filters analytics by city. - **state** (string) - Optional - Filters analytics by state. - **zipcode** (string) - Optional - Filters analytics by zipcode. - **beds** (number) - Optional - Filters analytics by the exact number of bedrooms. - **property_type** (string) - Optional - Filters by property type (e.g., 'single_family', 'condo'). ### Response #### Success Response (200) - **analytics** (object) - An object containing aggregated property analytics. - **totalListings** (number) - Total number of listings matching the criteria. - **averagePrice** (number) - Average listing price. - **medianPrice** (number) - Median listing price. - **minPrice** (number) - Minimum listing price. - **maxPrice** (number) - Maximum listing price. - **averagePricePerSquareFoot** (number) - **medianPricePerSquareFoot** (number) - **minPricePerSquareFoot** (number) - **maxPricePerSquareFoot** (number) - **averageSquareFootage** (number) - **medianSquareFootage** (number) - **minSquareFootage** (number) - **maxSquareFootage** (number) - **averageDaysOnMarket** (number) - **medianDaysOnMarket** (number) - **minDaysOnMarket** (number) - **maxDaysOnMarket** (number) - **newListings** (number) - Number of new listings. - **dataByBedrooms** (array) - An array of objects, each detailing analytics by number of bedrooms. - **bedrooms** (number) - **averagePrice** (number) - **medianPrice** (number) - **minPrice** (number) - **maxPrice** (number) - **averagePricePerSquareFoot** (number) - **medianPricePerSquareFoot** (number) - **minPricePerSquareFoot** (number) - **maxPricePerSquareFoot** (number) - **averageSquareFootage** (number) - **medianSquareFootage** (number) - **minSquareFootage** (number) - **maxSquareFootage** (number) - **averageDaysOnMarket** (number) - **medianDaysOnMarket** (number) - **minDaysOnMarket** (number) - **maxDaysOnMarket** (number) - **newListings** (number) - **totalListings** (number) #### Response Example ```json { "analytics": { "totalListings": 6, "averagePrice": 499900, "medianPrice": 499900, "minPrice": 499900, "maxPrice": 499900, "averagePricePerSquareFoot": 83.32, "medianPricePerSquareFoot": 83.32, "minPricePerSquareFoot": 83.32, "maxPricePerSquareFoot": 83.32, "averageSquareFootage": 6000, "medianSquareFootage": 6000, "minSquareFootage": 6000, "maxSquareFootage": 6000, "averageDaysOnMarket": 81, "medianDaysOnMarket": 81, "minDaysOnMarket": 81, "maxDaysOnMarket": 81, "newListings": 0, "dataByBedrooms": [ { "bedrooms": 0, "averagePrice": 499900, "medianPrice": 499900, "minPrice": 499900, "maxPrice": 499900, "averagePricePerSquareFoot": 83.32, "medianPricePerSquareFoot": 83.32, "minPricePerSquareFoot": 83.32, "maxPricePerSquareFoot": 83.32, "averageSquareFootage": 6000, "medianSquareFootage": 6000, "minSquareFootage": 6000, "maxSquareFootage": 6000, "averageDaysOnMarket": 81, "medianDaysOnMarket": 81, "minDaysOnMarket": 81, "maxDaysOnMarket": 81, "newListings": 0, "totalListings": 1 } ] } } ``` ```