# overview **Overview** The Furnished Finder Scraper API provides comprehensive data access to Furnished Finder's extensive listings of furnished rental properties. This API offers a streamlined way for real estate professionals, investors, and data analysts to gather valuable market insights. Through its well-defined endpoints, users can retrieve detailed property information, including listing details, location suggestions, photos, availability calendars, and geographic coordinates. Leveraging these endpoints — property, listing, location_suggestions, photos, availability_of_property, and coordinates — real estate investors can identify investment opportunities, analysts can conduct market research and track trends, and developers can integrate Furnished Finder data into their own applications. This powerful tool unlocks a wealth of information, empowering users to make informed decisions in the furnished rental market. **** ~~Test~~ - sideview ``` ``` **** # authentication **How to get API key** The Scrapeak API uses API keys to authenticate requests. You can view and manage your API keys in the [Scrapeak Dashboard](https://app.scrapeak.com/dashboard/settings). You need to sign up for any plan (including free starter plan) to get an API key. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. **** ~~Steps~~ - json ```- Log in or Register for the Scrapeak Dashboard. - Sign up for any plan, including the free starter plan. - Go to the settings page and copy your API key.``` **** # endpoints ## property Details **Property Details** `/property` `/property` API endpoint gives you all the important information you need to use our scraper effectively. This scraper is a strong tool that helps you easily get lots of details about properties. | Parameter | Description | Is required| Type| Default| | ---------: | :------------------- | ---------: | :------------------- | :------------------- | | `api_key` | Your API key | Yes | String | - | | `id` | id of property | Yes | String | - | | `includePhotos` | Also scrape the photos | No | Boolean | False | | `includeCoordinates` | Also scrape the coordinates of property | No | Boolean | False | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and id of a property api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY property_id = "598610_1" #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/property" params = {"api_key": api_key, "id": property_id} #/ Make the API request response = requests.get(api_url, params=params) response_content = response.text print(response_content)``` **** **** ~~*Response Example ~~ - json ```{ "is_success": true, "data": { "url": "https://www.furnishedfinder.com/property/598610_1", "propertyId": "598610_1", "title": "3 Bedroom Private Beach Bungalow Near Bald Point State Park", "tags": [ "Furnished Rental", "Verified Owner" ], "rating": null, "hotelOverview": { "type": "House", "bedrooms": "3 Bedroom", "bathrooms": "2 Bathroom", "utilitiesIncluded": "Yes!", "laundry": "In-Unit W/D", "furnitureIncluded": "Yes!" }, "reviews": [], "photos": [], "coordinates": { "lat": null, "lng": null }, "propertyOverview": { "property": "598610", "location": "Panacea Florida 32346\n", "price": "$4,800/Month Available On August 9", "petFriendly": "Yes!" }, "price": "$4,800/Month", "accommodations": [ "Essentials (Kitchenware Bathware Linens)", "Air Conditioning", "Heating", "Quiet Environment", "Full-size ironing board", "Storage", "Hair dryer", "Non-Smoking", "Starter toiletries (toilet paper soap shampoo etc.)", "Dedicated workspace for laptops", "Pack 'n Play/travel crib", "Portable fans", "TV", "Smart TV", "Internet", "WiFi", "Kitchen", "Stovetop", "Dishwasher", "Full-size fridge", "Microwave", "Kitchen Essentials (plates utensils pots/pans etc.)", "Starter Kitchen Essentials (dish soap paper towels sponge etc)", "Cleaning products", "Cleaning products for Bathroom", "Smoke Detector", "Carbon Monoxide Detector", "First Aid Kit", "Fire Extinguisher", "Free Parking on Premises", "Stairs at Entrance and/or Inside the Property", "2 car driveway plus street parking available in front of house (2 spots if needed)" ], "description": "Escape to our 3-bed, 2-bath beach bungalow just 100 feet from the private beach and 1 mile from Bald Point State Park. Wake up to Gulf of Mexico views from the deck to spot dolphins, enjoy a well-equipped kitchen, and relax on the screened porch or large deck with BBQ and outdoor shower. The epic, vaulted-ceiling entertainment room features a large TV, board games, and upstairs deck! Don't miss out on unforgettable beach memories! Book now.\n\n\n", "features": [ "Pet Friendly", "Utilities Included", "Furniture Included", "In-Unit W/D" ], "monthlyPrice": "$4,800/Month", "propertyFees": [ { "name": "Cleaning Fee", "amount": "$225.00" }, { "name": "Pet Deposit (Non-Refundable)", "amount": "$100.00" } ], "closestFacilitiesAndAttractions": [ { "name": "Tallahassee Opc", "distance": "33.92 miles away" }, { "name": "Tallahassee Memorial Hospital", "distance": "36.99 miles away" }, { "name": "Tallahassee Vet Center", "distance": "37.76 miles away" }, { "name": "Capital Regional Medical Center", "distance": "38.55 miles away" }, { "name": "George E Weems Memorial Hospital", "distance": "41.85 miles away" } ], "propertyManager": "https://www.furnishedfinder.com/members/profile?u=paul.kupfer", "bedrooms": { "PropertyId": 0, "Bed1": "Queen Bed", "Bed2": "Queen Bed", "Bed3": "Queen Bed", "Bed4": "", "Bed5": "", "Bed6": "", "Bed7": "", "Bed8": "", "Sleeps1": "2", "Sleeps2": "2", "Sleeps3": "2", "Sleeps4": "", "Sleeps5": "", "Sleeps6": "", "Sleeps7": "", "Sleeps8": "" } }, "message": "Scraped successfully!", "info": { "used_credits": 1, "remaining_credits": 6696 } }``` **** ## Basic Search **Basic Listing Search** `/listing` The Basic Search extracts general information about properties based on specified criteria. The parameters used for this search include the location name, moving date, and monthly budget range. By utilizing these parameters, users can easily filter and identify properties that meet their specific requirements. This functionality streamlines the property search process, allowing potential renters or buyers to focus on properties that are most relevant to their needs. | Parameter | Description | Is required| Type| Default| | ---------: | :------------------- | ---------: | :------------------- | :------------------- | | `api_key` | Your API key | Yes | String | - | | `searchType` | searchType is "basic" for this endpoint | Yes | String | basic | | `q` | Location name, it must be this format 'Dallas, Texas' | Yes | String | | | `moveInDate` | Move In Date - Format is (YYYY-MM-DD) | Yes | String | Today's date | | `monthlyBudgetMin` | Minimum monthly budget $ | Yes | Integer | 0 | | `monthlyBudgetMax` | Maximum monthly budget $ | Yes | Integer | 100000| | `postFilter` | If you want it to ignore the date and budget criteria, set it to False. | No | String | True | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and listing URL api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/listing" parameters = {"api_key": api_key, "searchType":"basic", "q":"Tampa, Florida", "moveInDate":"2024-08-15", "monthlyBudgetMin":0, "monthlyBudgetMax":3000} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** **** ~~*Response Example~~ - json ```{ "is_success": true, "data": [ { "id": "335800_1", "IsMultipleUnit": "False", "name": "

Private Oasis Studio Apartment

", "lat": 27.9701709, "long": -82.7581854, "MDesc": "

Fully Furnished
Utilities Included
Studio
Pets Welcome

", "MDesc2": "$1,000/month", "PType": "Apartment", "PF": "True", "image": "https://static.furnishedfinder.com/335800/1/335800_1_51424577-300-300.jpg", "PILink": "https://www.furnishedfinder.com/property/335800_1", "Icon": "", "Price": "$1,000", "Avail": "Contact for Availability", "AvailDate": "7/31/2024", "City": "Clearwater", "State": "Florida", "Preferred": "True", "Verified": "True", "BathType": "Private Bath", "LNRLink": "", "camount": "0", "BedRoomCount": "9", "ExternalCode": "", "Furnished": "True", "Utilities": "True", "HotTub": "False", "FreeParking": "True", "HouseKeeping": "False", "Wifi": "True", "Pool": "False", "SmartTV": "True", "Laundry": "False", "KingSizeBed": "False", "EV": "False", "Kitchen": "True", "WheelChair": "False", "Gym": "False", "Score": "1000", "PMScore": "290", "QualityScore": "410", "brand": "", "Subbrand": ", ", "ComplexPartner": "False", "Submitted_by": "sarah.davis18", "images": [ { "url": "335800/1/335800_1_51424577-300-300.jpg", "caption": "" }, { "url": "335800/1/335800_1_51424578-300-300.jpg", "caption": "" }, { "url": "335800/1/335800_1_51424580-300-300.png", "caption": "" }, { "url": "335800/1/335800_1_51424583-300-300.JPG", "caption": "" }, { "url": "335800/1/335800_1_51424586-300-300.JPG", "caption": "" }, { "url": "335800/1/335800_1_51424620-300-300.png", "caption": "" }, { "url": "335800/1/335800_1_51424622-300-300.JPG", "caption": "" }, { "url": "335800/1/335800_1_51424624-300-300.JPG", "caption": "" } ], "Bedrooms": [ { "title": "Bedroom 1", "sleep": "1", "beds": "Double (Full) Bed" } ] }, { "id": "373053_1", "IsMultipleUnit": "False", "name": "

Master Suite in Peaceful and Serene Home near...

", "lat": 27.9744638, "long": -82.7736248, "MDesc": "

Fully Furnished
Utilities Included
Pets Welcome
Room in a House

", "MDesc2": "$1,000/month", "PType": "Room", "PF": "True", "image": "https://static.furnishedfinder.com/373053/1/373053_1_37595030-300-300.jpg", "PILink": "https://www.furnishedfinder.com/property/373053_1", "Icon": "/images/roomH.png", "Price": "$1,000", "Avail": "Contact for Availability", "AvailDate": "7/27/2024", "City": "Clearwater", "State": "Florida", "Preferred": "True", "Verified": "True", "BathType": "Private Bath", "LNRLink": "", "camount": "0", "BedRoomCount": "1", "ExternalCode": "", "Furnished": "True", "Utilities": "True", "HotTub": "False", "FreeParking": "False", "HouseKeeping": "False", "Wifi": "True", "Pool": "False", "SmartTV": "False", "Laundry": "True", "KingSizeBed": "False", "EV": "False", "Kitchen": "True", "WheelChair": "False", "Gym": "False", "Score": "0", "PMScore": "500", "QualityScore": "320", "brand": "", "Subbrand": ", ", "ComplexPartner": "False", "Submitted_by": "Diane.Kucks", "images": [ { "url": "373053/1/373053_1_37595030-300-300.jpg", "caption": "" }, { "url": "373053/1/373053_1_38159253-300-300.jpg", "caption": "" }, { "url": "373053/1/373053_1_38159258-300-300.jpg", "caption": "" }, { "url": "373053/1/373053_1_38159248-300-300.jpg", "caption": "" }, { "url": "373053/1/373053_1_37595049-300-300.jpg", "caption": "" }, { "url": "373053/1/373053_1_38159273-300-300.jpg", "caption": "" } ], "Bedrooms": [] }, { "id": "557203_1", "IsMultipleUnit": "False", "name": "

NEAR EVERYTHING

", "lat": 27.9901639235618, "long": -82.7720393905587, "MDesc": "

Fully Furnished
Utilities Included
Room in a House

", "MDesc2": "$949/month", "PType": "Room", "PF": "False", "image": "https://static.furnishedfinder.com/557203/1/557203_1_50325031-300-300.JPG", "PILink": "https://www.furnishedfinder.com/property/557203_1", "Icon": "/images/roomH.png", "Price": "$949", "Avail": "Contact for Availability", "AvailDate": "7/22/2024", "City": "Clearwater", "State": "Florida", "Preferred": "True", "Verified": "True", "BathType": "Private Bath", "LNRLink": "", "camount": "0", "BedRoomCount": "1", "ExternalCode": "", "Furnished": "True", "Utilities": "True", "HotTub": "False", "FreeParking": "True", "HouseKeeping": "False", "Wifi": "True", "Pool": "False", "SmartTV": "True", "Laundry": "False", "KingSizeBed": "False", "EV": "False", "Kitchen": "True", "WheelChair": "False", "Gym": "False", "Score": "1000", "PMScore": "0", "QualityScore": "0", "brand": "", "Subbrand": ", ", "ComplexPartner": "False", "Submitted_by": "Alexis.Jaime", "images": [ { "url": "557203/1/557203_1_50325031-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325030-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325032-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325034-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325035-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325036-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325037-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325038-300-300.JPG", "caption": "" }, { "url": "557203/1/557203_1_50325039-300-300.jpg", "caption": "" }, { "url": "557203/1/557203_1_50325040-300-300.jpg", "caption": "" }, { "url": "557203/1/557203_1_50325065-300-300.jpg", "caption": "" }, { "url": "557203/1/557203_1_50325083-300-300.jpg", "caption": "" }, { "url": "557203/1/557203_1_50325099-300-300.jpg", "caption": "" }, { "url": "557203/1/557203_1_50671868-300-300.jpg", "caption": "" } ], "Bedrooms": [ { "title": "Bedroom 1", "sleep": "1", "beds": "Queen Bed" } ] } ], "message": "success", "info": { "used_credits": 20, "remaining_credits": 485339 } }``` **** ## Search by list URL **Search by list URL** `/listing` The Search by List URL feature efficiently extracts general property information based on parameters defined in the URL, specifically the location name, moving date, and monthly budget range. By incorporating these parameters directly into the URL, users can swiftly filter and pinpoint properties that align with their unique criteria. This streamlined approach enhances the overall property search experience, enabling potential renters or buyers to concentrate on listings that best suit their needs without the need for extensive manual searches. With this functionality, the process becomes more user-friendly, ensuring a quicker path to finding the ideal property. | Parameter | Description | Is required| Type| Default| | ---------: | :------------------- | ---------: | :------------------- | :------------------- | | `api_key` | Your API key | Yes | String | - | | `searchType` | searchType is "url" for this endpoint | Yes | String | url | | `url` | Web page url of list | Yes | String | - | | `postFilter` | If you want it to ignore the date and budget criteria, set it to False. | No | String | True | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and listing URL api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/listing" parameters = {"api_key": api_key, "searchType":"url", "url":"https://www.furnishedfinder.com/housing/Tampa/Florida/Budget1800/MoveIndate20240812/"} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** **** ~~*Response Example~~ - json ```SAME STRUCTURE AS BASIC SEARCH OUTPUT``` **** ## Search by Coordinates **Search by Coordinates** `/listing` The Coordinate-Based Search feature transforms the property search process by utilizing a specific set of parameters, namely latitude, longitude, and zoom level. Unlike traditional methods that require users to input location names, moving dates, and budget ranges, this innovative approach allows users to pinpoint a geographic area directly on a map interface. By adjusting these geospatial parameters, users can efficiently narrow down their search to properties within a desired vicinity, thus eliminating irrelevant options. This streamlined process greatly enhances user experience by providing a more targeted and convenient method for renters or buyers to find properties that align closely with their spatial preferences and geographical interests. | Parameter | Description | Is required| Type| Default| | ---------: | :------------------- | ---------: | :------------------- | :------------------- | | `api_key` | Your API key | Yes | String | - | | `searchType` | searchType is "coordinate" for this endpoint | Yes | String | coordinate | | `lat` | Latitude of coordinates | Yes | Float | - | | `lng` | Longitude of coordinates | Yes | Float | - | | `zoomLevel` | Zoom level on the map. Smaller number represents greater distance. ( min:5 - max:15) | Yes | Integer | 11 | | `moveInDate` | Move In Date - Format is (YYYY-MM-DD) | Yes | String | Today's date | | `monthlyBudgetMin` | Minimum monthly budget $ | Yes | Integer | 0 | | `monthlyBudgetMax` | Maximum monthly budget $ | Yes | Integer | 100000| | `postFilter` | If you want it to ignore the date and budget criteria, set it to False. | No | String | True | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and listing URL api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/listing" parameters = {"api_key": api_key,"searchType":"coordinate", "lat":27.98369643754117, "lng":-82.4591879072859, "zoomLevel":11, "moveInDate":"2024-08-15", "monthlyBudgetMin":100, "monthlyBudgetMax":3000} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** **** ~~*Response Example~~ - json ```SAME STRUCTURE AS BASIC SEARCH OUTPUT``` **** ## Photos of Property **Photos of Property** `/photos` The `/photos` endpoint is a service that retrieves and provides a collection of photographs associated with a specific property listing. Upon sending a request that includes the unique property identifier, the endpoint returns a structured dataset of high-resolution images, which may be utilized for real estate presentation and analysis purposes, thereby enhancing the visual understanding of the property's features and environment. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `id` | Id of property | Yes | String | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and query api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/photos" parameters = {"api_key": api_key, "id": "598610_1"} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** **** ~~*Response Example~~ - json ```{ "is_success": true, "data": [ { "id": "52007365", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007365-full.jpg", "caption": "" }, { "id": "52007432", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007432-full.JPG", "caption": "" }, { "id": "52007367", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007367-full.jpg", "caption": "" }, { "id": "52007368", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007368-full.jpg", "caption": "" }, { "id": "52007369", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007369-full.jpg", "caption": "" }, { "id": "52007370", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007370-full.jpg", "caption": "" }, { "id": "52007375", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007375-full.jpg", "caption": "" }, { "id": "52007378", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007378-full.jpg", "caption": "" }, { "id": "52007376", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007376-full.jpg", "caption": "" }, { "id": "52007374", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007374-full.jpg", "caption": "" }, { "id": "52007377", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007377-full.jpg", "caption": "" }, { "id": "52007379", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007379-full.jpg", "caption": "" }, { "id": "52007380", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007380-full.jpg", "caption": "" }, { "id": "52007441", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007441-full.jpg", "caption": "" }, { "id": "52007383", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007383-full.jpg", "caption": "" }, { "id": "52007384", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007384-full.jpg", "caption": "" }, { "id": "52007385", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007385-full.jpg", "caption": "" }, { "id": "52007386", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007386-full.jpg", "caption": "" }, { "id": "52007387", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007387-full.jpg", "caption": "" }, { "id": "52007388", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007388-full.jpg", "caption": "" }, { "id": "52007389", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007389-full.jpg", "caption": "" }, { "id": "52007390", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007390-full.jpg", "caption": "" }, { "id": "52007391", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007391-full.jpg", "caption": "" }, { "id": "52007392", "photopath": "https://staticproperties.furnishedfinder.com/598610/1/598610_1_52007392-full.jpg", "caption": "" } ], "message": "success", "info": { "used_credits": 20, "remaining_credits": 485319 } }``` **** ## Coordinates of Property **Coordinates of Property** `/coordinates` The `/coordinates` endpoint is designed to provide precise geolocation data for a given property. You can input specific property identifiers, and the endpoint will return the latitude and longitude, thereby enabling seamless integration into various mapping and geographic information systems. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `id` | Id of property | Yes | String | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and query api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/coordinates" parameters = {"api_key": api_key, "id": "598610_1"} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** ~~*Response Example~~ - json ```{ "is_success": true, "data": { "lat": 29.9249684, "lng": -84.3346271 }, "message": "success", "info": { "used_credits": 20, "remaining_credits": 485299 } }``` **** **** ## Availability of Property **Availability of Property** `/availabilityOfProperty` The `/availabilityOfProperty` endpoint is a crucial feature that provides users with the ability to access and review booked dates on a property's calendar. This endpoint ensures that potential clients can easily ascertain the specific dates a property is unavailable. You can see detailed data on the occupancy status of a property. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `id` | Id of property | Yes | String | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and query api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/availabilityOfProperty" parameters = {"api_key": api_key, "id": "598610_1"} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** ~~*Response Example~~ - json ```{ "is_success": true, "data": [ { "start": "2024-08-08", "end": "2024-08-09", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-10-16", "end": "2024-10-23", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-10-24", "end": "2024-10-27", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-11-08", "end": "2024-11-10", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-11-14", "end": "2024-11-17", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-11-23", "end": "2024-11-30", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-11-30", "end": "2024-11-30", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2024-12-22", "end": "2024-12-28", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2025-02-22", "end": "2025-03-01", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2025-03-15", "end": "2025-03-21", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2025-08-08", "end": "2025-08-09", "color": "#8B0000", "is_available": false, "status": "Unavailable" }, { "start": "2025-08-10", "end": "2027-08-01", "color": "#cae6a2", "is_available": true, "status": "Available" } ], "message": "success", "info": { "used_credits": 20, "remaining_credits": 485279 } }``` **** ## Location Search **Location Search** `/locationSuggestions` The `/locationSuggestions` endpoint is a fantastic feature of the Furnished Finder Scraper API that lets users search for different places just by typing a name. It's really versatile and can show results like states, counties, streets. When you add this feature to your apps or websites, it makes it easy for users to find important location-based information. Whether they want to look for properties in a specific area or explore details about neighborhoods, the `/locationSuggestions` endpoint gives them accurate and relevant results, making their real estate experience even better. | Parameter | Description | Is required| Type| | ---------: | :------------------- | ---------: | :------------------- | | `api_key` | Your API key | Yes | String | | `q` | An address, neighborhood or city | Yes | String | **** ~~Scraper API Call~~ - python ```import requests #/ Set your API key and query api_key = "YOUR-API-KEY" # CHANGE WITH YOUR API KEY query = "YOUR-QUERY" #/ API endpoint and default headers api_url = "https://app.scrapeak.com/v1/scrapers/furnished_finder/locationSuggestions" parameters = {"api_key": api_key, "q": query} #/ Make the API request response = requests.get(api_url, params=parameters) response_content = response.text print(response_content)``` **** ~~Response Example~~ - json ```{ "is_success": true, "data": [ { "city": "Dallas, Texas", "points": null }, { "city": "Dallas, Georgia", "points": null }, { "city": "Dallas, North Carolina", "points": null }, { "city": "Dallas, Oregon", "points": null }, { "city": "Dallas, Pennsylvania", "points": null }, { "city": "Dallas, South Dakota", "points": null }, { "city": "Dallas, Wisconsin", "points": null }, { "city": "Dallas, West Virginia", "points": null }, { "city": "Dallas Center, Iowa", "points": null }, { "city": "Dallas City, Illinois", "points": null }, { "city": "Dallastown, Pennsylvania", "points": null }, { "city": "Dallas - Selfville Volunteer Fire Department, Alabama", "points": null }, { "city": "Dallas - Sioux Creek Joint Fire Department, Wisconsin", "points": null }, { "city": "Dallas, Alabama", "points": null }, { "city": "Dallas, Arkansas", "points": null }, { "city": "Dallas, Arizona", "points": null }, { "city": "Dallas, Colorado", "points": null }, { "city": "Dallas, Florida", "points": null }, { "city": "Dallas, Maine", "points": null }, { "city": "Dallas, Missouri", "points": null } ], "message": "success", "info": { "used_credits": 20, "remaining_credits": 485259 } }``` **** # Scripts Library **Scripts Library** To support our users in getting started quickly, we provide a collection of useful scripts in our "Scripts Library" repository on GitHub. This resourceful repository offers a variety of scripts that can streamline your integration process and enhance your overall experience. With these pre-made scripts readily available, you can accelerate your development and effortlessly implement Scrapeak's capabilities into your applications or projects. [Click here to see the Scripts Library](https://www.scrapeak.com/pricing/) **** ~~Test~~ - sideview-github-preview ``` ``` **** # Costs **Credit Cost** Scrapers in the Scrapeak store use credits per request. Our system only charges you for successful results. Status that we count as successful requests: `'is_success': true` [Click here to see the plans](https://www.scrapeak.com/pricing/) **** ~~Test~~ - sideview ```

Parameter Table

Endpoint	Description	Supported Platforms	Credits Usage
`All endpoints`	All endpoints of Furnished Finder Scraper API	Web and API	20 credits/request

``` # FAQs **FAQs** **Can I change my API key?** \ Yes it's possible. Please contact us. **Can I get occupancy rate of any property?** \ Yes, you can extract occupancy informations via `/availabilityOfProperty` API endpoint. **** ~~Test~~ - sideview ```

What is the rate limit?
It depends on your subscription plan. Click here to see the plans

What programming languages can I use?
You can use any programming language you want. Our preference is usually Python.

```

Loading ...