Skip to content

Python package to extract and analyze Canadian real estate data from REALTOR.CA

License

Notifications You must be signed in to change notification settings

rachitt96/pyRealtor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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, such as house sale/rent price, number of bedrooms, stories, ammenities nearby etc. of any city / region within Canada. 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 a specific area.
  • 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
  • From the source code
git clone https://github.com/rachitt96/pyRealtor.git
cd pyRealtor
python setup.py install

Usage

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

house_obj = pyRealtor.HousesFacade()
house_obj.search_save_houses(
    search_area='Barrhaven',
    report_file_name='barrhaven_all_listings.xlsx'
)

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',
    report_file_name='barrhaven_all_listings.xlsx',
    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',
    report_file_name='FILES_TO_LOAD_LISTINGS.xlsx',
    open_house_date = 'MM/DD/YYYY'
)
import pyRealtor

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

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."

About

Python package to extract and analyze Canadian real estate data from REALTOR.CA

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages