Page cover

PropFuse API

Use our API to access real-time data about Property.

Authentication

User Registration

Register a new user.

POST https://propfuseapi.vercel.app/api/register

Creates a new user.

Request Body

Name
Type
Description

username*

string

The username of the user

email*

string

The email ID of the user

password*

string

The password to be given

{
    "_id": "64b534b6847d791670c255c5",
    "email": "captain@gmail.com"
}

User Login

Log in a user.

POST https://propfuseapi.vercel.app/api/login

Logs in a user.

Request Body

Name
Type
Description

email*

string

Registered email ID of the user

password*

string

Password

{
    "message": "successfully logged in"
}

Current User

Check the current user.

GET https://propfuseapi.vercel.app/api/current

Checks the logged in user.

{
    "username": "caprogers",
    "email": "captain@gmail.com",
    "id": "64b534b6847d791670c255c5"
}

User Logout

Log out the user.

GET https://propfuseapi.vercel.app/api/logout

Logs out the logged in user.

{
    "message": "successfully logged out"
}

API Endpoints

Property Listings

Users must be logged in for accessing the property listings.

Get all properties.

GET https://propfuseapi.vercel.app/api/listings

Fetches all the property listings.

[
    {
        "area": "1260 sqft",
        "image_url": "https://img.staticmb.com/mbphoto/property/cropped_images/2019/May/24/Photo_h300_w450/42266845_10_PropertyImage1558706280819_300_450.jpg",
        "location": "3 BHK Builder Floor for Sale in Rohini Sector 7 New Delhi",
        "price": "₹2.20 Cr"
    },
]

Property Listings by location

Get properties by location.

GET https://propfuseapi.vercel.app/api/listings/filter

Fetches all the properties of a particular location by filtering the data.

Query Parameters

Name
Type
Description

location*

string

location for listings

PreviousIntroduction

Last updated