### Get Rent Estimate with Radius and Age Constraints Source: https://context7.com/rentcast/api-resources/llms.txt Calculate a rent estimate by address, applying constraints for maximum search radius and the age of comparable listings (days old). ```bash # Get rent estimate with radius and age constraints curl -X GET "https://api.rentcast.io/v1/avm/rent/long-term?address=5500%20Grand%20Lake%20Dr,%20San%20Antonio,%20TX,%2078244&maxRadius=2&daysOld=180" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Get Sale Listing by ID Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a single sale listing using its unique identifier. Ensure you replace 'YOUR_API_KEY' with your actual API key. ```bash # Get sale listing by ID curl -X GET "https://api.rentcast.io/v1/listings/sale/3821-Hargis-St,-Austin,-TX-78723" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Paginate Property Search Results (Second Page) Source: https://context7.com/rentcast/api-resources/llms.txt Fetch the second page of property search results by adjusting the 'offset' parameter. This example retrieves the next 50 records. Ensure your API key is included. ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=50&offset=50" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/avm/rent/long-term Source: https://context7.com/rentcast/api-resources/llms.txt Returns a property rent estimate with comparable rental listings. ```APIDOC ## GET /v1/avm/rent/long-term ### Description Returns a property rent estimate with comparable rental listings. Analyzes nearby rental properties to estimate fair market rent. ### Method GET ### Endpoint https://api.rentcast.io/v1/avm/rent/long-term ### Parameters #### Query Parameters - **address** (string) - Required - The full address of the property. - **propertyType** (string) - Optional - Type of property. - **bedrooms** (integer) - Optional - Number of bedrooms. - **bathrooms** (integer) - Optional - Number of bathrooms. - **squareFootage** (integer) - Optional - Property square footage. - **compCount** (integer) - Optional - Number of comparables to return. - **maxRadius** (number) - Optional - Search radius in miles. - **daysOld** (integer) - Optional - Maximum age of rental listings in days. ### Response #### Success Response (200) - **rent** (number) - Estimated fair market rent. - **rentRangeLow** (number) - Lower bound of the rent estimate. - **rentRangeHigh** (number) - Upper bound of the rent estimate. - **subjectProperty** (object) - Details of the subject property. - **comparables** (array) - List of comparable rental properties. ``` -------------------------------- ### GET /v1/listings/rental/long-term/{id} Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a single rental listing by its unique identifier. ```APIDOC ## GET /v1/listings/rental/long-term/{id} ### Description Retrieve a single rental listing by its unique identifier. ### Method GET ### Endpoint /v1/listings/rental/long-term/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the rental listing. ### Request Example ```bash # Get rental listing by ID curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term/2005-Arborside-Dr,-Austin,-TX-78754" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **id** (string) - Unique identifier for the listing. - **formattedAddress** (string) - The full address of the property. - **propertyType** (string) - The type of the property (e.g., 'Single Family'). - **bedrooms** (integer) - The number of bedrooms. - **bathrooms** (float) - The number of bathrooms. - **squareFootage** (integer) - The total square footage of the property. - **yearBuilt** (integer) - The year the property was built. - **hoa** (object) - Homeowners Association details. - **fee** (integer) - The HOA fee amount. - **status** (string) - The current status of the listing (e.g., 'Active'). - **price** (integer) - The listed price of the property. - **listingType** (string) - The type of listing (e.g., 'Standard'). - **listedDate** (string) - The date the property was listed (ISO 8601 format). - **daysOnMarket** (integer) - The number of days the property has been on the market. - **mlsName** (string) - The name of the Multiple Listing Service. - **mlsNumber** (string) - The MLS number for the listing. - **listingAgent** (object) - Details about the listing agent. - **name** (string) - The name of the agent. - **phone** (string) - The phone number of the agent. - **email** (string) - The email address of the agent. - **listingOffice** (object) - Details about the listing office. - **name** (string) - The name of the office. - **phone** (string) - The phone number of the office. - **history** (object) - Historical data for the listing. - **[date]** (object) - An object where the key is the date (YYYY-MM-DD) and the value contains event details. - **event** (string) - The type of event (e.g., 'Rental Listing'). - **price** (integer) - The price associated with the event. - **daysOnMarket** (integer) - Days on market at the time of the event. #### Response Example ```json [ { "id": "2005-Arborside-Dr,-Austin,-TX-78754", "formattedAddress": "2005 Arborside Dr, Austin, TX 78754", "propertyType": "Single Family", "bedrooms": 3, "bathrooms": 2.5, "squareFootage": 1681, "yearBuilt": 2019, "hoa": { "fee": 45 }, "status": "Active", "price": 2200, "listingType": "Standard", "listedDate": "2024-09-18T00:00:00.000Z", "daysOnMarket": 13, "mlsName": "CentralTexas", "mlsNumber": "556965", "listingAgent": { "name": "Zachary Barton", "phone": "5129948203", "email": "zak-barton@realtytexas.com" }, "listingOffice": { "name": "Realty Texas", "phone": "5124765348" }, "history": { "2024-09-18": { "event": "Rental Listing", "price": 2200, "daysOnMarket": 13 } } } ] ``` ``` -------------------------------- ### Search Sale Listings by Price Range Source: https://context7.com/rentcast/api-resources/llms.txt Filter sale listings by a price range using the 'price' parameter. This example searches for properties between $200,000 and $500,000. Remember to include your API key. ```bash curl -X GET "https://api.rentcast.io/v1/listings/sale?city=Austin&state=TX&price=200000-500000" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Get Rental Listing by ID Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a specific long-term rental listing using its unique identifier. Remember to substitute 'YOUR_API_KEY' with your valid API key. ```bash # Get rental listing by ID curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term/2005-Arborside-Dr,-Austin,-TX-78754" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Zip Code Market Statistics Source: https://context7.com/rentcast/api-resources/llms.txt Provides an example response structure for market statistics of a specific zip code. ```APIDOC ## GET /v1/zipcodes/{zipCode}/market ### Description Retrieves market statistics for a given zip code. ### Method GET ### Endpoint /v1/zipcodes/{zipCode}/market ### Path Parameters - **zipCode** (string) - Required - The zip code for which to retrieve market data. ### Response Example (Success Response - 200) ```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, "averageSquareFootage": 1717, "averageDaysOnMarket": 77, "medianDaysOnMarket": 61, "newListings": 41, "totalListings": 248, "dataByPropertyType": [ { "propertyType": "Single Family", "averagePrice": 347649, "medianPrice": 305000, "averagePricePerSquareFoot": 214.07, "averageDaysOnMarket": 69.19, "newListings": 24, "totalListings": 158 }, { "propertyType": "Townhouse", "averagePrice": 316301, "medianPrice": 254990, "averagePricePerSquareFoot": 188.97, "averageDaysOnMarket": 86.29, "newListings": 12, "totalListings": 41 } ], "dataByBedrooms": [ { "bedrooms": 3, "averagePrice": 312571, "medianPrice": 290000, "averagePricePerSquareFoot": 196.7, "averageDaysOnMarket": 78.57, "newListings": 24, "totalListings": 129 }, { "bedrooms": 4, "averagePrice": 431145, "medianPrice": 375000, "averagePricePerSquareFoot": 189.84, "averageDaysOnMarket": 66.37, "newListings": 9, "totalListings": 42 } ], "history": { "2025-06": { "date": "2025-06-01T00:00:00.000Z", "averagePrice": 348402, "medianPrice": 290000, "newListings": 47, "totalListings": 263 }, "2025-07": { "date": "2025-07-01T00:00:00.000Z", "averagePrice": 355280, "medianPrice": 290000, "newListings": 55, "totalListings": 244 } } } } ``` ``` -------------------------------- ### GET /v1/listings/sale/{id} Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a single sale listing by its unique identifier. ```APIDOC ## GET /v1/listings/sale/{id} ### Description Retrieve a single sale listing by its unique identifier. ### Method GET ### Endpoint /v1/listings/sale/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the sale listing. ### Request Example ```bash curl -X GET "https://api.rentcast.io/v1/listings/sale/3821-Hargis-St,-Austin,-TX-78723" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **id** (string) - Unique identifier for the listing. - **formattedAddress** (string) - The full address of the property. - **propertyType** (string) - The type of the property (e.g., 'Single Family'). - **bedrooms** (integer) - The number of bedrooms. - **bathrooms** (float) - The number of bathrooms. - **squareFootage** (integer) - The total square footage of the property. - **yearBuilt** (integer) - The year the property was built. - **hoa** (object) - Homeowners Association details. - **fee** (integer) - The HOA fee amount. - **status** (string) - The current status of the listing (e.g., 'Active'). - **price** (integer) - The listed price of the property. - **listingType** (string) - The type of listing (e.g., 'Standard'). - **listedDate** (string) - The date the property was listed (ISO 8601 format). - **daysOnMarket** (integer) - The number of days the property has been on the market. - **mlsName** (string) - The name of the Multiple Listing Service. - **mlsNumber** (string) - The MLS number for the listing. - **listingAgent** (object) - Details about the listing agent. - **name** (string) - The name of the agent. - **phone** (string) - The phone number of the agent. - **email** (string) - The email address of the agent. - **website** (string) - The website of the agent. - **listingOffice** (object) - Details about the listing office. - **name** (string) - The name of the office. - **phone** (string) - The phone number of the office. - **history** (object) - Historical data for the listing. - **[date]** (object) - An object where the key is the date (YYYY-MM-DD) and the value contains event details. - **event** (string) - The type of event (e.g., 'Sale Listing'). - **price** (integer) - The price associated with the event. - **listingType** (string) - The type of listing for the event. - **daysOnMarket** (integer) - Days on market at the time of the event. #### Response Example ```json [ { "id": "3821-Hargis-St,-Austin,-TX-78723", "formattedAddress": "3821 Hargis St, Austin, TX 78723", "propertyType": "Single Family", "bedrooms": 4, "bathrooms": 2.5, "squareFootage": 2345, "yearBuilt": 2008, "hoa": { "fee": 65 }, "status": "Active", "price": 899000, "listingType": "Standard", "listedDate": "2024-06-24T00:00:00.000Z", "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" }, "history": { "2024-06-24": { "event": "Sale Listing", "price": 899000, "listingType": "Standard", "daysOnMarket": 99 } } } ] ``` ``` -------------------------------- ### Search Properties by Year Built Range Source: https://context7.com/rentcast/api-resources/llms.txt Filter properties by the year they were built using the 'yearBuilt' parameter. This example retrieves properties constructed between 2000 and 2020. Ensure your API key is present. ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&yearBuilt=2000-2020" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Get All Market Statistics for a Zip Code Source: https://context7.com/rentcast/api-resources/llms.txt Fetch comprehensive market statistics for a given US zip code, including sales and rental data over a specified history range. Replace 'YOUR_API_KEY' with your actual API key. ```bash # Get all market statistics for a zip code curl -X GET "https://api.rentcast.io/v1/markets?zipCode=29611&dataType=All&historyRange=6" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/avm/value Source: https://context7.com/rentcast/api-resources/llms.txt Returns a property value estimate with comparable properties used for the calculation. ```APIDOC ## GET /v1/avm/value ### Description Returns a property value estimate with comparable properties used for the calculation. The AVM analyzes recent sales of similar properties to estimate market value. ### Method GET ### Endpoint https://api.rentcast.io/v1/avm/value ### Parameters #### Query Parameters - **address** (string) - Optional - The full address of the property. - **latitude** (number) - Optional - Latitude coordinate. - **longitude** (number) - Optional - Longitude coordinate. - **propertyType** (string) - Optional - Type of property. - **bedrooms** (integer) - Optional - Number of bedrooms. - **bathrooms** (integer) - Optional - Number of bathrooms. - **squareFootage** (integer) - Optional - Property square footage. - **compCount** (integer) - Optional - Number of comparables to return. ### Response #### Success Response (200) - **price** (number) - Estimated market value. - **priceRangeLow** (number) - Lower bound of the estimate. - **priceRangeHigh** (number) - Upper bound of the estimate. - **subjectProperty** (object) - Details of the subject property. - **comparables** (array) - List of comparable properties used. ``` -------------------------------- ### Get Value Estimate with Property Attributes Override Source: https://context7.com/rentcast/api-resources/llms.txt Fetch a property value estimate by address, with the option to override default property attributes like type, bedrooms, bathrooms, square footage, and comparable property count. ```bash # Get value estimate with property attributes override curl -X GET "https://api.rentcast.io/v1/avm/value?address=5500%20Grand%20Lake%20Dr,%20San%20Antonio,%20TX,%2078244&propertyType=Single%20Family&bedrooms=3&bathrooms=2&squareFootage=1878&compCount=10" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Get Rent Estimate with Property Attributes Source: https://context7.com/rentcast/api-resources/llms.txt Fetch a rent estimate by address, allowing for overrides of property attributes such as type, bedrooms, bathrooms, and square footage. You can also specify the number of comparable properties to consider. ```bash # Get rent estimate with property attributes curl -X GET "https://api.rentcast.io/v1/avm/rent/long-term?address=5500%20Grand%20Lake%20Dr,%20San%20Antonio,%20TX,%2078244&propertyType=Single%20Family&bedrooms=3&bathrooms=2&squareFootage=1878&compCount=5" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/properties/{id} Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a single property record by its unique identifier. ```APIDOC ## GET /v1/properties/{id} ### Description Retrieve a single property record by its unique identifier. ### Method GET ### Endpoint https://api.rentcast.io/v1/properties/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the property. ### Response #### Success Response (200) - **id** (string) - Unique property identifier. - **formattedAddress** (string) - Full address string. - **propertyType** (string) - Type of property. ``` -------------------------------- ### Example API Response for Zip Code Data Source: https://context7.com/rentcast/api-resources/llms.txt This JSON object represents a typical response from the API, detailing sale data for a specific zip code, including property type and bedroom breakdowns. ```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, "averageSquareFootage": 1717, "averageDaysOnMarket": 77, "medianDaysOnMarket": 61, "newListings": 41, "totalListings": 248, "dataByPropertyType": [ { "propertyType": "Single Family", "averagePrice": 347649, "medianPrice": 305000, "averagePricePerSquareFoot": 214.07, "averageDaysOnMarket": 69.19, "newListings": 24, "totalListings": 158 }, { "propertyType": "Townhouse", "averagePrice": 316301, "medianPrice": 254990, "averagePricePerSquareFoot": 188.97, "averageDaysOnMarket": 86.29, "newListings": 12, "totalListings": 41 } ], "dataByBedrooms": [ { "bedrooms": 3, "averagePrice": 312571, "medianPrice": 290000, "averagePricePerSquareFoot": 196.7, "averageDaysOnMarket": 78.57, "newListings": 24, "totalListings": 129 }, { "bedrooms": 4, "averagePrice": 431145, "medianPrice": 375000, "averagePricePerSquareFoot": 189.84, "averageDaysOnMarket": 66.37, "newListings": 9, "totalListings": 42 } ], "history": { "2025-06": { "date": "2025-06-01T00:00:00.000Z", "averagePrice": 348402, "medianPrice": 290000, "newListings": 47, "totalListings": 263 }, "2025-07": { "date": "2025-07-01T00:00:00.000Z", "averagePrice": 355280, "medianPrice": 290000, "newListings": 55, "totalListings": 244 } } } } ``` -------------------------------- ### Get Value Estimate by Coordinates Source: https://context7.com/rentcast/api-resources/llms.txt Obtain a property value estimate using latitude and longitude coordinates. You can also specify property type and number of bedrooms. ```bash # Get value estimate by coordinates curl -X GET "https://api.rentcast.io/v1/avm/value?latitude=29.475962&longitude=-98.351442&propertyType=Single%20Family&bedrooms=3" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/properties/random Source: https://context7.com/rentcast/api-resources/llms.txt Returns a list of property records selected at random for testing or sampling purposes. ```APIDOC ## GET /v1/properties/random ### Description Returns a list of property records selected at random. Useful for testing or sampling data. ### Method GET ### Endpoint https://api.rentcast.io/v1/properties/random ### Parameters #### Query Parameters - **limit** (integer) - Optional - Number of random records to return. ``` -------------------------------- ### Get Random Property Records Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a list of random property records, useful for testing or sampling data. ```bash # Get random properties curl -X GET "https://api.rentcast.io/v1/properties/random?limit=5" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/listings/sale Source: https://context7.com/rentcast/api-resources/llms.txt Search for properties listed for sale in a geographical area or by specific address. ```APIDOC ## GET /v1/listings/sale ### Description Search for properties listed for sale in a geographical area or by specific address. Returns active and inactive MLS listings with agent and office information. ### Method GET ### Endpoint https://api.rentcast.io/v1/listings/sale ### Parameters #### Query Parameters - **city** (string) - Optional - City name. - **state** (string) - Optional - State code. - **zipCode** (string) - Optional - Zip code. - **status** (string) - Optional - Listing status (e.g., Active). - **limit** (integer) - Optional - Number of results to return. - **price** (string) - Optional - Price range (e.g., 200000-500000). - **latitude** (number) - Optional - Latitude coordinate. - **longitude** (number) - Optional - Longitude coordinate. - **radius** (number) - Optional - Search radius in miles. - **propertyType** (string) - Optional - Type of property. - **bedrooms** (string) - Optional - Bedroom range (e.g., 3-4). ``` -------------------------------- ### Get Value Estimate by Address Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve an Automated Valuation Model (AVM) estimate for a property using its address. Ensure your API key is included in the request headers. ```bash # Get value estimate by address curl -X GET "https://api.rentcast.io/v1/avm/value?address=5500%20Grand%20Lake%20Dr,%20San%20Antonio,%20TX,%2078244" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/properties Source: https://context7.com/rentcast/api-resources/llms.txt Search for property records using various filters such as address, location, or property attributes. ```APIDOC ## GET /v1/properties ### Description Search for property records in a geographical area or by specific address. Returns comprehensive property information including ownership, tax history, features, and sale history. ### Method GET ### Endpoint https://api.rentcast.io/v1/properties ### Parameters #### Query Parameters - **address** (string) - Optional - The full address to search for. - **city** (string) - Optional - The city name. - **state** (string) - Optional - The state abbreviation. - **zipCode** (string) - Optional - The zip code. - **propertyType** (string) - Optional - The type of property (e.g., Single Family). - **bedrooms** (integer) - Optional - Number of bedrooms. - **bathrooms** (integer) - Optional - Number of bathrooms. - **limit** (integer) - Optional - Number of results to return. - **offset** (integer) - Optional - Pagination offset. - **includeTotalCount** (boolean) - Optional - Whether to include the total count of records. - **latitude** (float) - Optional - Latitude for radius search. - **longitude** (float) - Optional - Longitude for radius search. - **radius** (float) - Optional - Search radius in miles. ### Response #### Success Response (200) - **id** (string) - Unique property identifier. - **formattedAddress** (string) - Full address string. - **propertyType** (string) - Type of property. - **bedrooms** (integer) - Number of bedrooms. - **bathrooms** (integer) - Number of bathrooms. - **squareFootage** (integer) - Total square footage. - **yearBuilt** (integer) - Year the property was built. - **owner** (object) - Ownership details. ``` -------------------------------- ### Get Rent Estimate by Address Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve a long-term rent estimate for a property using its address. This endpoint analyzes nearby rental listings to estimate fair market rent. ```bash # Get rent estimate by address curl -X GET "https://api.rentcast.io/v1/avm/rent/long-term?address=5500%20Grand%20Lake%20Dr,%20San%20Antonio,%20TX,%2078244" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Get Only Rental Market Statistics Source: https://context7.com/rentcast/api-resources/llms.txt Obtain only rental market statistics for a given zip code and history range. Remember to substitute 'YOUR_API_KEY' with your valid API key. ```bash # Get only rental market statistics curl -X GET "https://api.rentcast.io/v1/markets?zipCode=29611&dataType=Rental&historyRange=6" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/listings/rental/long-term Source: https://context7.com/rentcast/api-resources/llms.txt Search for long-term rental listings by various criteria. Returns active and inactive rental listings with agent information. ```APIDOC ## GET /v1/listings/rental/long-term ### Description Search for long-term rental listings in a geographical area or by specific address. Returns active and inactive rental listings with agent information. ### Method GET ### Endpoint /v1/listings/rental/long-term ### Parameters #### Query Parameters - **city** (string) - Optional - The city to search within. - **state** (string) - Optional - The state to search within (e.g., 'TX'). - **zipCode** (string) - Optional - The zip code to search within. - **status** (string) - Optional - The status of the listing (e.g., 'Active', 'Inactive'). - **limit** (integer) - Optional - The maximum number of results to return. - **price** (string) - Optional - A price range for the rental (e.g., '1500-2500'). - **propertyType** (string) - Optional - The type of property (e.g., 'Single Family'). - **bedrooms** (integer) - Optional - The minimum number of bedrooms. - **bathrooms** (float) - Optional - The minimum number of bathrooms. ### Request Example ```bash # Search rental listings by city and state curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term?city=Austin&state=TX&status=Active&limit=5" \ -H "X-Api-Key: YOUR_API_KEY" # Search rental listings by zip code with price filter curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term?zipCode=78754&price=1500-2500&status=Active" \ -H "X-Api-Key: YOUR_API_KEY" # Search rental listings with property filters curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term?city=Austin&state=TX&propertyType=Single%20Family&bedrooms=3&bathrooms=2" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### Response #### Success Response (200) - **id** (string) - Unique identifier for the listing. - **formattedAddress** (string) - The full address of the property. - **propertyType** (string) - The type of the property (e.g., 'Single Family'). - **bedrooms** (integer) - The number of bedrooms. - **bathrooms** (float) - The number of bathrooms. - **squareFootage** (integer) - The total square footage of the property. - **yearBuilt** (integer) - The year the property was built. - **hoa** (object) - Homeowners Association details. - **fee** (integer) - The HOA fee amount. - **status** (string) - The current status of the listing (e.g., 'Active'). - **price** (integer) - The listed price of the property. - **listingType** (string) - The type of listing (e.g., 'Standard'). - **listedDate** (string) - The date the property was listed (ISO 8601 format). - **daysOnMarket** (integer) - The number of days the property has been on the market. - **mlsName** (string) - The name of the Multiple Listing Service. - **mlsNumber** (string) - The MLS number for the listing. - **listingAgent** (object) - Details about the listing agent. - **name** (string) - The name of the agent. - **phone** (string) - The phone number of the agent. - **email** (string) - The email address of the agent. - **listingOffice** (object) - Details about the listing office. - **name** (string) - The name of the office. - **phone** (string) - The phone number of the office. - **history** (object) - Historical data for the listing. - **[date]** (object) - An object where the key is the date (YYYY-MM-DD) and the value contains event details. - **event** (string) - The type of event (e.g., 'Rental Listing'). - **price** (integer) - The price associated with the event. - **daysOnMarket** (integer) - Days on market at the time of the event. #### Response Example ```json [ { "id": "2005-Arborside-Dr,-Austin,-TX-78754", "formattedAddress": "2005 Arborside Dr, Austin, TX 78754", "propertyType": "Single Family", "bedrooms": 3, "bathrooms": 2.5, "squareFootage": 1681, "yearBuilt": 2019, "hoa": { "fee": 45 }, "status": "Active", "price": 2200, "listingType": "Standard", "listedDate": "2024-09-18T00:00:00.000Z", "daysOnMarket": 13, "mlsName": "CentralTexas", "mlsNumber": "556965", "listingAgent": { "name": "Zachary Barton", "phone": "5129948203", "email": "zak-barton@realtytexas.com" }, "listingOffice": { "name": "Realty Texas", "phone": "5124765348" }, "history": { "2024-09-18": { "event": "Rental Listing", "price": 2200, "daysOnMarket": 13 } } } ] ``` ``` -------------------------------- ### Get Only Sale Market Statistics Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve only sale-related market statistics for a specified zip code and history range. Ensure you replace 'YOUR_API_KEY' with your actual API key. ```bash # Get only sale market statistics curl -X GET "https://api.rentcast.io/v1/markets?zipCode=29611&dataType=Sale&historyRange=12" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### GET /v1/markets Source: https://context7.com/rentcast/api-resources/llms.txt Returns aggregate market statistics and listing trends for a US zip code. Provides insights into pricing, days on market, and inventory levels broken down by property type and bedroom count. ```APIDOC ## GET /v1/markets ### Description Returns aggregate market statistics and listing trends for a US zip code. Provides insights into pricing, days on market, and inventory levels broken down by property type and bedroom count. ### Method GET ### Endpoint /v1/markets ### Parameters #### Query Parameters - **zipCode** (string) - Required - The zip code for which to retrieve market statistics. - **dataType** (string) - Optional - Specifies the type of data to retrieve. Options: 'All', 'Sale', 'Rental'. Defaults to 'All'. - **historyRange** (integer) - Optional - The number of months of historical data to include. Defaults to 6. ### Request Example ```bash # Get all market statistics for a zip code curl -X GET "https://api.rentcast.io/v1/markets?zipCode=29611&dataType=All&historyRange=6" \ -H "X-Api-Key: YOUR_API_KEY" # Get only sale market statistics curl -X GET "https://api.rentcast.io/v1/markets?zipCode=29611&dataType=Sale&historyRange=12" \ -H "X-Api-Key: YOUR_API_KEY" # Get only rental market statistics curl -X GET "https://api.rentcast.io/v1/markets?zipCode=29611&dataType=Rental&historyRange=6" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### Response #### Success Response (200) (Response structure for market statistics is complex and depends on `dataType` and `historyRange`. It typically includes aggregated data like median prices, number of listings, days on market, etc., broken down by property type and bedroom count for the specified period.) #### Response Example (Example response structure would be provided here based on specific query parameters, detailing market trends for sales and rentals.) ``` -------------------------------- ### Search Properties with Advanced Filters Source: https://context7.com/rentcast/api-resources/llms.txt Demonstrates how to use query parameters for advanced search capabilities, including numeric ranges and multiple values for criteria like bedrooms, price, square footage, year built, and days on market. ```APIDOC ## GET /v1/properties ### Description Retrieves a list of properties with advanced search capabilities. ### Method GET ### Endpoint /v1/properties ### Query Parameters - **city** (string) - Required - The city to search within. - **state** (string) - Required - The state to search within. - **bedrooms** (string) - Optional - Number of bedrooms. Supports ranges (e.g., "3-5") or multiple values (e.g., "2,3"). - **price** (string) - Optional - Price range (e.g., "200000-500000"). - **squareFootage** (string) - Optional - Square footage range (e.g., "1500-2500"). - **yearBuilt** (string) - Optional - Year built range (e.g., "2000-2020"). ### Request Example ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&bedrooms=3-5&squareFootage=1500-2500" \ -H "X-Api-Key: YOUR_API_KEY" ``` ## GET /v1/listings/sale ### Description Retrieves a list of sale listings with advanced search capabilities. ### Method GET ### Endpoint /v1/listings/sale ### Query Parameters - **city** (string) - Required - The city to search within. - **state** (string) - Required - The state to search within. - **price** (string) - Optional - Price range (e.g., "200000-500000"). - **daysOld** (string) - Optional - Days on market range (e.g., "1-30"). ### Request Example ```bash curl -X GET "https://api.rentcast.io/v1/listings/sale?city=Austin&state=TX&price=200000-500000&daysOld=1-30" \ -H "X-Api-Key: YOUR_API_KEY" ``` ``` -------------------------------- ### Pagination Source: https://context7.com/rentcast/api-resources/llms.txt Explains how to paginate through API results to retrieve data in manageable chunks. ```APIDOC ## GET /v1/properties (with Pagination) ### Description Retrieves properties with pagination enabled. ### Method GET ### Endpoint /v1/properties ### Query Parameters - **city** (string) - Required - The city to search within. - **state** (string) - Required - The state to search within. - **limit** (integer) - Optional - The number of records to return per page. Defaults to 50. - **offset** (integer) - Optional - The number of records to skip. Used for retrieving subsequent pages. - **includeTotalCount** (boolean) - Optional - If true, the response will include the `X-Total-Count` header with the total number of available records. ### Request Example (First Page) ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=50&offset=0&includeTotalCount=true" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### Request Example (Second Page) ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=50&offset=50" \ -H "X-Api-Key: YOUR_API_KEY" ``` ### Response Headers - **X-Total-Count** (integer) - Present when `includeTotalCount` is true. Indicates the total number of records available. ``` -------------------------------- ### Search Rental Listings with Property Filters Source: https://context7.com/rentcast/api-resources/llms.txt Filter long-term rental listings by city, state, property type, number of bedrooms, and bathrooms. Replace 'YOUR_API_KEY' with your actual API key. ```bash # Search rental listings with property filters curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term?city=Austin&state=TX&propertyType=Single%20Family&bedrooms=3&bathrooms=2" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Paginate Property Search Results (First Page) Source: https://context7.com/rentcast/api-resources/llms.txt Retrieve the first page of property search results, limiting the number of records and including the total count in the response headers. Requires your API key. ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&limit=50&offset=0&includeTotalCount=true" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Search Rental Listings by City and State Source: https://context7.com/rentcast/api-resources/llms.txt Search for long-term rental listings by specifying city and state. You can filter by status and limit the number of results. Replace 'YOUR_API_KEY' with your actual API key. ```bash # Search rental listings by city and state curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term?city=Austin&state=TX&status=Active&limit=5" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Search Rental Listings by Zip Code with Price Filter Source: https://context7.com/rentcast/api-resources/llms.txt Find long-term rental listings within a specific zip code and a defined price range. Replace 'YOUR_API_KEY' with your actual API key. ```bash # Search rental listings by zip code with price filter curl -X GET "https://api.rentcast.io/v1/listings/rental/long-term?zipCode=78754&price=1500-2500&status=Active" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Search Sale Listings by Zip Code with Price Filter Source: https://context7.com/rentcast/api-resources/llms.txt Query for sale listings within a specific zip code, applying a price range filter. The status of the listings can also be specified. ```bash # Search sale listings by zip code with price filter curl -X GET "https://api.rentcast.io/v1/listings/sale?zipCode=78723&price=200000-500000&status=Active" \ -H "X-Api-Key: YOUR_API_KEY" ``` -------------------------------- ### Authenticate API Requests Source: https://context7.com/rentcast/api-resources/llms.txt Include the API key in the X-Api-Key header for all requests. A 401 status code is returned if the key is missing or invalid. ```bash # Include your API key in the X-Api-Key header for all requests curl -X GET "https://api.rentcast.io/v1/properties?address=5500%20Grand%20Lake%20Dr,%20San%20Antonio,%20TX,%2078244" \ -H "X-Api-Key: YOUR_API_KEY" # Example response for authentication error (401) { "status": 401, "error": "auth/api-key-invalid", "message": "No API key provided in request. An API key must be provided in the 'X-Api-Key' header" } ``` -------------------------------- ### Search Properties by Multiple Bedroom Values Source: https://context7.com/rentcast/api-resources/llms.txt Specify multiple values for the 'bedrooms' parameter, separated by commas, to retrieve properties matching any of the specified bedroom counts. Include your API key. ```bash curl -X GET "https://api.rentcast.io/v1/properties?city=Austin&state=TX&bedrooms=2,3" \ -H "X-Api-Key: YOUR_API_KEY" ```