PropertyIntel: Uncover Hidden Real Estate Insights

View Live Demo

Table of Contents

1. About The Project
   • Features
   • System Architecture
   • Technologies Used
2. Getting Started
   • Installation
3. How it Works
4. API Endpoints and Query Parameters
5. Top Contributors

About The Project

PropertyIntel is an innovative web app platform that empowers users to explore and analyze building violations across New York City. It integrates a RESTful API built using real-time data from the NYC Department of Buildings (DOB), sourced from the NYC Open Data platform. The app features an interactive, map-based interface powered by the Google Maps API. This web app sets us apart from other real estate platforms because we help uncover property issues such as code violations and unresolved maintenance problems that other mainstream real estate platforms like Zillow and StreetEasy do not provide.

This tool is designed to provide actionable insights for real estate professionals, property buyers, investors, homebuyers, and the general public by:

• Highlighting property issues that may affect market value
• Identifying unresolved maintenance concerns
• Exposing legal or code violations
• Offering leverage for negotiations
• Supporting informed investment decisions
• Revealing neighborhood trends and infrastructure challenges

(back to top)

Features

• Real-time Data: The app leverages up-to-date data from the NYC Open Data platform to provide accurate information on building violations across New York City.
• Map-based Interface: Users can easily visualize and interact with building violations through an interactive, map-based interface.
• Search Filters: The app supports multiple search filters (address, zip code, and BIN number) to help users find specific violations or complaints.

(back to top)

System Architecture

(back to top)

Technologies Used

• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

Follow the steps below to set up and run the project locally.

Installation

1. Get a free API Key at Google Maps API

2. Clone the repo

   git clone https://github.com/MChaudhry9/PropertyIntel-A-Real-Estate-App.git
   

3. Install NPM packages in your terminal

   npm install

4. Enter your Google Maps API key in client/src/components/Map/Map.jsx:

   bootstrapURLKeys={{ key: 'YOUR_API_KEY' }}

5. Run the Development Server

   cd client
   npm start

6. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin github_username/repo_name
   git remote -v # confirm the changes

(back to top)

How it Works

1. User Inputs Their Query
   Users enters an address/zipcode/BIN number into the search bar to find building violations.

2. Address Geolocation
   The Google Maps API identifies and locates the entered address, placing a marker on the interactive map to highlight the location.

3. API Query
   The application sends the address details to the custom API, which processes the request and retrieves relevant building violation data.

4. Data Fetching
   The custom API queries the NYC Open Data platform for violation records associated with the provided address, ensuring accurate and up-to-date information.

5. Displaying Violations
   The fetched violation data is returned to the front end, where it is displayed in a user-friendly format. Violations are represented as map markers, and detailed information is provided for each violation.

(back to top)

API Endpoints and Query Parameters

• GET /api/complaints: Retrieve all violations.
• GET /api/complaints?address={}: Retrieve a violation by address.
• GET /api/complaints?zip_code={}: Retrieve a violation by zipcode.
• GET /api/complaints?bin_number={}: Retrieve a violation by the unique identifier: Building Identification Number (BIN Number).
• GET /api/complaints?address={}&zip_code={}: Retrieve a violation by both address and zipcode.
• GET /api/complaints?address={}&bin_number={}: Retrieve a violation by address and BIN number.
• GET /api/complaints?zip_code={}&bin_number={}: Retrieve a violation by both zip code and BIN number.
• GET /api/complaints?address={}&zip_code={}&bin_number={}: Retrieve a violation by address, zip code, and BIN number.

(back to top)

Top contributors:

• Mamuna Chaudhry
• Chao Hong
• Jay Trivedi

(back to top)