Simple RESTful Web App to find Real Estate Listings

Overview

Unreal Estate

Unreal Estate is a simple RESTful web app that allows the user to find Real Estate listings they might be interested in. Unreal Estate is built on Laravel 5 and PHP 7.

Listing Updates

The application maintains its own database of real estate listings. These listings are updated daily (2:00AM EST) from an external source.

API Usage

There are two endpoints available for reading listing data, and one endpoint for modifying listing data.

Get All Listings

Retrieves all listings as an array of JSON objects

  • URL /listings
  • Method GET
  • Success Response
    • Code: 200
    • Content: { [ { }, ... ] }

Get Paginated Listings

Retrieves a partial collection of all listings as an array of JSON objects. Sorting, filtering, and pagination is done via query parameters.

  • URL /paginated_listings
  • Method GET
  • URL Parameters All parameters are optional, some have default values if not specified
Parameter Description Allowed Values Default
page specifies the page to show any positive, non-zero integer 1
results_per_page specifies the number of results to show per page any positive, non-zero integer 1
photos_only returns only photos from the listings true or false false
sort specifies how to sort the returned listings Sorting Expression, only list_price and listing_date fields none

if no sorting is specified, no sorting will be explicitly applied and there are no guarantees what order the results will be in

  • Success Response
    • Code: 206
    • Content: { [ { }, ... ] }
  • Error Responses
    • Errors in URL parameters
      • Code: 400
      • Content: { "error": "there was an error with the query parameters" }
    • No data for given pagination parameters
      • Code: 404
      • Content: none

Toggle Listing Activation

Allows user to activate or deactivate a listing. The behavior of this endpoint is toggling, so calling the endpoint when the listing is inactive will activate it, and vice-versa.

The endpoint also returns the representation of the affected listing as a JSON object.

  • URL /listings/:id/toggle_activation
  • Method PUT
  • Success Response
    • Code: 200
    • Content: { }
  • Error Responses
    • No Listing for id
      • Code: 404
      • Content: none
You might also like...
TinyFileManager is web based file manager and it is a simple, fast and small file manager with a single file, multi-language ready web application
TinyFileManager is web based file manager and it is a simple, fast and small file manager with a single file, multi-language ready web application

TinyFileManager is web based file manager and it is a simple, fast and small file manager with a single file, multi-language ready web application for storing, uploading, editing and managing files and folders online via web browser. The Application runs on PHP 5.5+, It allows the creation of multiple users and each user can have its own directory and a build-in support for managing text files with cloud9 IDE and it supports syntax highlighting for over 150+ languages and over 35+ themes.

Crater is an open-source web & mobile app that helps you track expenses, payments & create professional invoices & estimates.
Crater is an open-source web & mobile app that helps you track expenses, payments & create professional invoices & estimates.

Introduction Crater is an open-source web & mobile app that helps you track expenses, payments & create professional invoices & estimates. Web Applica

Web based fantasy sports draft app
Web based fantasy sports draft app

Hoot Draft makes running drafts for fantasy sports a real hoot! (dad jokes sold separately) Large color-coded draft board updates live during the draf

An open source self hosted notes and bookmarks taking web app.
An open source self hosted notes and bookmarks taking web app.

Benotes An open source self hosted web app for your notes and bookmarks side by side. This project is currently in Beta. You may encounter bugs or err

This web app aims to manage alumnus databases.

Aplikasi Database Alumni Aplikasi berbasis web ini bertujuan untuk melakukan pendataan alumni. Aplikasi ini dibuat menggunakan framework CodeIgniter d

Scrumwala: Your very own Scrum, Agile project management web app - built with Laravel
Scrumwala: Your very own Scrum, Agile project management web app - built with Laravel

Scrumwala Your very own Scrum/Agile web app built with Laravel Features Create and manage projects with plan and work views Group issues in a project

Retrieve MySejahtera App's data from MySejahtera API and show to users via web browser. Written in PHP
Retrieve MySejahtera App's data from MySejahtera API and show to users via web browser. Written in PHP

MySejahtera-PHP-Web Retrieve MySejahtera App's data from MySejahtera API and show to users via web browser. Written in PHP. Disclaimer This web app is

Laravel web app for signing up for community service opportunities

Community Service A Laravel web app for registering for service opportunities. Installation Make sure the following are installed on your system: Node

A mini social media like web app built using Laravel 8 & Vue JS 3

About Laravel Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experie

Owner
Jett Durham
T-Shaped Software Developer currently specializing in Frontend Web Development ⚛️ Musician: primarily guitar, mostly metal. Lover of all things tech 🎮 🧠
Jett Durham
Official repository for Find A PR. Find A PR is a platform that curates a list of issues around Laravel based project.

About Find A PR This is the official repository for Find A PR. Find A PR is a platform that curates a list of issues around Laravel based project. Req

Ash Allen 33 Dec 15, 2022
A Real time chat app made in Next.js, Laravel and Ably.

Chat App with Next.js, Laravel and Ably This repository serves as a code container for the tutorial I wrote on Ably's Blog. Blog link will be updated

Ravgeet Dhillon 13 Dec 17, 2022
Online web application developed in PHP using Laravel framework for managing real-time kitchen orders in a restaurant.

Online web application developed in PHP using Laravel framework for managing real-time kitchen orders in a restaurant. It allows, through a web panel, real-time communication between chefs and waiters about the status of orders.

Fernando 2 Nov 9, 2022
Subscriptify - a simple subscription platform(only RESTful APIs with MySQL)

Create a simple subscription platform(only RESTful APIs with MySQL) in which users can subscribe to a website (there can be multiple websites in the system). Whenever a new post is published on a particular website, all it's subscribers shall receive an email with the post title and description in it. (no authentication of any kind is required)

Md Rafsan Jani Rafin 2 Mar 24, 2022
A simple RESTful non-blocking API, to send and receive money

A simple RESTful non-blocking API, to send and receive money.

Daniel Rodrigues 3 Dec 19, 2022
mini Project in Laravel and vue js. Real World Laravel 8x + vue js Dashboard.Task management and project management system

mini Project in Laravel and vue js. Real World Laravel 8x + vue js Dashboard.Task management and project management system. Dashboard features such as: Complete Dashboard, Custom Authentication, Email Verification, custom-login-register-forgot password (without jetstream).

Hasmukh Dharajiya 2 Sep 20, 2022
Create a PHP 8 CRUD (Create, Read, Update, Delete) RESTful API with an MySQL database.

Créer une API RESTful PHP 8 CRUD (Create, Read, Update , Delete) simple avec MySQL et PDO (PHP Data Objects) Détails du référentiel : Lire, insérer, m

HOUESSOU Béryl 5 Oct 10, 2022
Unified sample web app. The easy way to learn web frameworks.

Notejam The easy way to learn web frameworks Do you know framework X and want to try framework Y? The easy way to start with a new framework is to com

Sergey Komar 1.1k Dec 21, 2022
Simple web app to easily create landing pages by dragging and dropping prebuilt blocks

Drag & Drop landing page builder made with Laravel 8, Vue.js 3 and Tailwind CSS

Isaac Souza 10 Nov 6, 2022
A simple Lumen web app to send basic commands and fetch the current status to your Ford vehicle with Sync 3 enabled

FordPass Access This is a simple Lumen web app to send basic commands and fetch the current status to your Ford vehicle with Sync 3 enabled. Local dev

Sam 4 Nov 21, 2022