HomeHarvest/README.md

34 lines
565 B
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 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-17 13:10:21 -07:00
```
from homeharvest import scrape_property
properties = scrape_property(
location="85281", site_name="zillow", listing_type="for_rent"
)
print(properties)
```
2023-09-18 08:38:56 -07:00
### Site Name Options
- `zillow`
- `redfin`
- `realtor.com`
### Listing Types
- `for_rent`
- `for_sale`
- `sold`