Skip to main content

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

Project description

PyPI Downloads Python PyPI - License

Realtorpy is a python package that provides fast and easy way to extract Multiple Listing Service (MLS) details from REALTOR.CA and REALTOR.COM, such as house sale/rent price, number of bedrooms, stories, ammenities nearby etc. of any city / region within Canada or United States. The library provides functionality to easily store the extracted data in excel sheet for further analysis.

Realtorpy can be used to

  • Analyze and extract all real estate listing in Canada or United States.
  • 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 realtorpy
  • From the source code
git clone https://github.com/labi1240/Realtorpy.git
cd Realtorpy
python setup.py install

Usage

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

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

import Realtorpy

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

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

import Realtorpy

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

If the city/area name is common between United States and Canada, then by default pyRealtor will extract listings from either country. To externally request pyRealtor to fetch listing from a specific country:

import Realtorpy

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

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 Realtorpy

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

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

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

Terms of Use

Realtorpy 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](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 Distribution

realtorpy-1.0.0.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

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

Realtorpy-1.0.0-py3-none-any.whl (18.1 kB view details)

Uploaded Python 3

File details

Details for the file realtorpy-1.0.0.tar.gz.

File metadata

  • Download URL: realtorpy-1.0.0.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for realtorpy-1.0.0.tar.gz
Algorithm Hash digest
SHA256 5ec95b456d901db35c3a1472643869e382a2e34abc018b014f729653480cac61
MD5 910a881a47033d2e2bab4a07e46063fb
BLAKE2b-256 6b0593541adb696380d3fb2abae13eee522ad4ca2bad6d7fe316da963ae24b9d

See more details on using hashes here.

File details

Details for the file Realtorpy-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: Realtorpy-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 18.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for Realtorpy-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0c11298358b7b321fe39a77d2cce0d5bdf766ba6d9e25b15a564c6fe74140941
MD5 26abf16f57c20db8bd4b8b6437d4b613
BLAKE2b-256 a094087089431635be96d807e530f12f5d8831aa77984fe7ab26971d86220e28

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