# Zillow Scraper
This Python module can be used for getting property listings from Zillow. This allows users to extract detailed information about properties available for sale or rent, as well as sold properties, across various states in the USA.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Supported States](#supported-states)
- [Configuration](#configuration)
- [Data Output](#data-output)
- [Logging](#logging)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
## Features
- Scrape property listings from Zillow for multiple states.
- Retrieve detailed property information including:
- Address
- Price
- Days on Zillow
- Zestimate and Rent Zestimate
- Property type (e.g., single-family home, condo)
- Geographic coordinates (latitude and longitude)
- Support for paginated results, allowing users to scrape multiple pages of listings.
## Installation
To install the Zillow Scraper module, follow these steps:
1. **Clone the Repository:**
```bash
git clone https://github.com/yourusername/zillow_scraper.git
cd zillow_scraper
```
2. **Install the Package:**
```bash
pip install zillow_scraper
```
3. **Install Dependencies:**
If you don't have the required libraries, you can install them using:
```bash
pip install -r requirements.txt
```
4. **Usage**
To use the Zillow Scraper, you can import the scrape_selected_states function from the module and call it with the desired parameters.
```bash
## Example:
from zillow_scraper.scraper import scrape_selected_states
# Define the states and listing type you want to scrape
selected_states = {
"California": "ca",
"Texas": "tx"
}
# Scrape for sale listings
df = scrape_selected_states(selected_states, "for_sale")
# Display the scraped data
print(df.head())
```
## Listing Types:
- for_sale: For properties currently on the market.
- for_rent: For rental listings.
- sold: For properties that have been sold.
## Supported States
The scraper supports all 50 states in the USA. Below is a list of the states and their corresponding abbreviations:
```bash
| State | Abbreviation |
|--------------------|--------------|
| Alabama | al |
| Alaska | ak |
| Arizona | az |
| Arkansas | ar |
| California | ca |
| Colorado | co |
| Connecticut | ct |
| Delaware | de |
| Florida | fl |
| Georgia | ga |
| Hawaii | hi |
| Idaho | id |
| Illinois | il |
| Indiana | in |
| Iowa | ia |
| Kansas | ks |
| Kentucky | ky |
| Louisiana | la |
| Maine | me |
| Maryland | md |
| Massachusetts | ma |
| Michigan | mi |
| Minnesota | mn |
| Mississippi | ms |
| Missouri | mo |
| Montana | mt |
| Nebraska | ne |
| Nevada | nv |
| New Hampshire | nh |
| New Jersey | nj |
| New Mexico | nm |
| New York | ny |
| North Carolina | nc |
| North Dakota | nd |
| Ohio | oh |
| Oklahoma | ok |
| Oregon | or |
| Pennsylvania | pa |
| Rhode Island | ri |
| South Carolina | sc |
| South Dakota | sd |
| Tennessee | tn |
| Texas | tx |
| Utah | ut |
| Vermont | vt |
| Virginia | va |
| Washington | wa |
| West Virginia | wv |
| Wisconsin | wi |
| Wyoming | wy |
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Adeyemi0/zillow_scraper",
"name": "zillow-scraper",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Your Name",
"author_email": "xmine4346@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/bd/65/7cdb12994d0ad9479890afd93a93dbcaa975bfa126ba39cefa1c0e8cb81f/zillow_scraper-0.1.0.tar.gz",
"platform": null,
"description": "# Zillow Scraper\n\nThis Python module can be used for getting property listings from Zillow. This allows users to extract detailed information about properties available for sale or rent, as well as sold properties, across various states in the USA.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Supported States](#supported-states)\n- [Configuration](#configuration)\n- [Data Output](#data-output)\n- [Logging](#logging)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contact](#contact)\n\n## Features\n\n- Scrape property listings from Zillow for multiple states.\n- Retrieve detailed property information including:\n - Address\n - Price\n - Days on Zillow\n - Zestimate and Rent Zestimate\n - Property type (e.g., single-family home, condo)\n - Geographic coordinates (latitude and longitude)\n- Support for paginated results, allowing users to scrape multiple pages of listings.\n\n## Installation\n\nTo install the Zillow Scraper module, follow these steps:\n\n1. **Clone the Repository:**\n\n ```bash\n git clone https://github.com/yourusername/zillow_scraper.git\n cd zillow_scraper\n ```\n\n\n2. **Install the Package:**\n\n ```bash\n pip install zillow_scraper\n\n ```\n\n3. **Install Dependencies:**\nIf you don't have the required libraries, you can install them using:\n\n ```bash\n pip install -r requirements.txt\n\n ```\n4. **Usage**\nTo use the Zillow Scraper, you can import the scrape_selected_states function from the module and call it with the desired parameters.\n\n```bash\n## Example:\n\nfrom zillow_scraper.scraper import scrape_selected_states\n\n# Define the states and listing type you want to scrape\nselected_states = {\n \"California\": \"ca\",\n \"Texas\": \"tx\"\n}\n\n# Scrape for sale listings\ndf = scrape_selected_states(selected_states, \"for_sale\")\n\n# Display the scraped data\nprint(df.head())\n\n```\n## Listing Types:\n- for_sale: For properties currently on the market.\n- for_rent: For rental listings.\n- sold: For properties that have been sold.\n\n## Supported States\nThe scraper supports all 50 states in the USA. Below is a list of the states and their corresponding abbreviations:\n```bash\n\n| State | Abbreviation |\n|--------------------|--------------|\n| Alabama | al |\n| Alaska | ak |\n| Arizona | az |\n| Arkansas | ar |\n| California | ca |\n| Colorado | co |\n| Connecticut | ct |\n| Delaware | de |\n| Florida | fl |\n| Georgia | ga |\n| Hawaii | hi |\n| Idaho | id |\n| Illinois | il |\n| Indiana | in |\n| Iowa | ia |\n| Kansas | ks |\n| Kentucky | ky |\n| Louisiana | la |\n| Maine | me |\n| Maryland | md |\n| Massachusetts | ma |\n| Michigan | mi |\n| Minnesota | mn |\n| Mississippi | ms |\n| Missouri | mo |\n| Montana | mt |\n| Nebraska | ne |\n| Nevada | nv |\n| New Hampshire | nh |\n| New Jersey | nj |\n| New Mexico | nm |\n| New York | ny |\n| North Carolina | nc |\n| North Dakota | nd |\n| Ohio | oh |\n| Oklahoma | ok |\n| Oregon | or |\n| Pennsylvania | pa |\n| Rhode Island | ri |\n| South Carolina | sc |\n| South Dakota | sd |\n| Tennessee | tn |\n| Texas | tx |\n| Utah | ut |\n| Vermont | vt |\n| Virginia | va |\n| Washington | wa |\n| West Virginia | wv |\n| Wisconsin | wi |\n| Wyoming | wy |\n\n```\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A web scraper for Zillow real estate listings.",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/Adeyemi0/zillow_scraper"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a3cbab56b705a69f449f1c841193aa693ef8c3472ba82f0f3786d3478c3c3802",
"md5": "4176ba686b84230ae269501a8be38ece",
"sha256": "968c858bb40591007f45b245ee15d4c56ab6f447f0c002749ea36e7c40093390"
},
"downloads": -1,
"filename": "zillow_scraper-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4176ba686b84230ae269501a8be38ece",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5466,
"upload_time": "2024-10-28T19:07:23",
"upload_time_iso_8601": "2024-10-28T19:07:23.601566Z",
"url": "https://files.pythonhosted.org/packages/a3/cb/ab56b705a69f449f1c841193aa693ef8c3472ba82f0f3786d3478c3c3802/zillow_scraper-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bd657cdb12994d0ad9479890afd93a93dbcaa975bfa126ba39cefa1c0e8cb81f",
"md5": "1bab1947f92fa27dc7c4296835010c4c",
"sha256": "4f68c9790bff2c463148900fae97502af037f992b5199ab4fd57a70ae8f57c4d"
},
"downloads": -1,
"filename": "zillow_scraper-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1bab1947f92fa27dc7c4296835010c4c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5612,
"upload_time": "2024-10-28T19:07:24",
"upload_time_iso_8601": "2024-10-28T19:07:24.647343Z",
"url": "https://files.pythonhosted.org/packages/bd/65/7cdb12994d0ad9479890afd93a93dbcaa975bfa126ba39cefa1c0e8cb81f/zillow_scraper-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-28 19:07:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Adeyemi0",
"github_project": "zillow_scraper",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "requests",
"specs": []
},
{
"name": "beautifulsoup4",
"specs": []
},
{
"name": "pandas",
"specs": []
},
{
"name": "fake-useragent",
"specs": []
},
{
"name": "streamlit",
"specs": []
}
],
"lcname": "zillow-scraper"
}
JSON
