Skip to main content

Python package for fetching and analyzing REALTOR.CA and REALTOR.COM MLS Listings

Project description

PyPI Downloads Python PyPI - License

pyRealtor is a python package that provides fast and easy way to extract Multiple Listing Service (MLS) details, from REALTOR.CA, REALTOR.COM and HOUSING.COM, of any city / region within Canada, United States or India. The library provides functionality to easily store the extracted data in excel sheet for further analysis.

pyRealtor can be used to

  • Analyze and extract all real estate listing in Canada, United States, India.
  • Find only Open House on a specifc day in a particular area.

Installing

The easiest way to install the library is to execute (preferably in a virtualenv) the command:

pip install pyRealtor

Usage

  1. To get all real estate properties for sale in specific area

If the area is within Canada, then pyRealtor will fetch listings from REALTOR.CA

import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Barrhaven'
)

If the area is within United States, then pyRealtor will fetch listings from REALTOR.COM

import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Bentonville'
)

If the area is within India, then pyRealtor will fetch listings from HOUSING.COM

import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Vastrapur'
)

If the city/area name is common between multiple countries, then by default pyRealtor will extract listings from any country. To externally request pyRealtor to fetch listing from a specific country:

import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Ottawa',
    country='Canada'
)
import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='whitefield',
    country='India'
)

RELTOR.CA API has the rate limit, and it may block IP in case you trigger API multiple times in short period. In that case, you can use use_proxy argument.

import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Barrhaven',
    use_proxy=True
)
  1. To get only Open House listings in a specific area
import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='CITY/SUBURB',
    open_house_date = 'MM/DD/YYYY'
)
import pyRealtor

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Barrhaven',
    open_house_date = '10/29/2023'
)

(Note: Open House filter functionality is only available within Canadian region through REALTOR.CA.)

Terms of Use

pyRealtor is a tool to extract, filter and analyze publicly accessible MLS listings provided by REALTOR.CA. More information on the use of this data can be found on REALTOR.CA website: https://www.realtor.ca/terms-of-use

"REALTOR.CA website/database is a copyright-protected work which is owned by CREA. Part of the contents of REALTOR.CA website/database, including all real estate listings and related information, images and photographs (collectively, "Listing Content"), are also protected by copyright, which is owned by the CREA members who supplied the content and/or by third parties, and is reproduced in REALTOR.CA website/database under license. The contents of REALTOR.CA website/database, including the Listing Content, are intended for the private, non-commercial use by individuals. Any commercial use of the website/database, including the Listing Content, in whole or in part, directly or indirectly, is specifically forbidden except with the prior written authority of the owner of the copyright."

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyrealtor-0.2.6-py3-none-any.whl (27.7 kB view details)

Uploaded Python 3

File details

Details for the file pyrealtor-0.2.6-py3-none-any.whl.

File metadata

  • Download URL: pyrealtor-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 27.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for pyrealtor-0.2.6-py3-none-any.whl
Algorithm Hash digest
SHA256 360ea50cb509ecb1f35ed07a376b46ea55c783af5b8ccdeb3219551a6a74081a
MD5 c16df78478fbdef896f694452ef63d58
BLAKE2b-256 cfc92644988f0942bc61dcf93540218c5bd941e4020930716122b8dde4bd703c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page