HomeHarvest/README.md

43 lines
1.1 KiB
Markdown
Raw Normal View History

2023-09-17 13:10:21 -07:00
# HomeHarvest
**HomeHarvest** aims to be the top Python real estate scraping library.
2023-09-15 19:47:46 -07:00
2023-09-18 08:38:56 -07:00
_**Under Consideration**: We're looking into the possibility of an Excel plugin to cater to a broader audience._
2023-09-15 19:47:46 -07:00
2023-09-18 10:01:52 -07:00
[![Try with Replit](https://replit.com/badge?caption=Try%20with%20Replit)](https://replit.com/@ZacharyHampton/HomeHarvestDemo)
2023-09-18 08:38:56 -07:00
## Installation
2023-09-15 19:47:46 -07:00
```bash
pip install --upgrade homeharvest
2023-09-17 13:10:21 -07:00
```
2023-09-18 08:38:56 -07:00
## Example Usage
2023-09-18 08:45:31 -07:00
```py
>>> from homeharvest import scrape_property
... properties = scrape_property(
... location="85281", site_name="zillow", listing_type="for_rent"
... )
>>> properties.head()
address_one city ... mls_id description
0 420 N Scottsdale Rd Tempe ... NaN NaN
1 1255 E University Dr Tempe ... NaN NaN
2 1979 E Rio Salado Pkwy Tempe ... NaN NaN
3 548 S Wilson St Tempe ... None None
4 945 E Playa Del Norte Dr Unit 4027 Tempe ... NaN NaN
[5 rows x 23 columns]
2023-09-17 13:10:21 -07:00
```
2023-09-18 08:38:56 -07:00
### Site Name Options
- `zillow`
- `redfin`
- `realtor.com`
### Listing Types
- `for_rent`
- `for_sale`
- `sold`