HousingAnywhere API

Download OpenAPI specification:Download

Introduction

The HousingAnywhere API allows you to easily publish your listings on the largest rental accommodation platform globally. The API strongly advances data interoperability between HousingAnywhere and its partners. As property managers you can use the API to connect your inventory to the HousingAnywhere platform, enabling you to reach a far bigger target audience. Bookings take place on the HousingAnywhere platform and the API will ensure that partner systems are updated in real-time whenever one of your properties gets booked on the HousingAnywhere platform.

Publish Quality Listings

The HousingAnywhere API offers a range of possibilities. The API supplies a managed solution for storing and accessing property data such as media and listing details on HousingAnywhere.

Integrate with Property Management Systems

Connected property managers can store and access information regarding the pricing and availability of all their rental units. This information is updated based on a predetermined frequency as updates are pulled by the HA platform.

Bookings made easy

Webhooks enable two-way integrations to ensure that information is kept synchronized between HousingAnywhere and systems that are already being used by property managers. By using these webhooks, bookings and cancellations can automatically be confirmed as they happen, and availability calendars are updated on the fly.

Getting Started guide

To get started, any user can request an API key. Every API request needs a private API key in query parameters as a part of authentication, which is unique to each client. Please contact our team to request your unique key. For more information, contact us at api@housinganywhere.com

Authentication

Authentication is done using a custom query parameter called 'api_key'.

ApiKeyAuth

Security scheme type: API Key
query parameter name: api_key

Technical Support

If you need additional technical support after going through our technical documentation, our team of international account managers will be eager to facilitate you.

Listings

This API reference describes how to create, update and fetch your listings on the HousingAnywhere platform. Request and response field descriptions and sample code are provided.

Add Listing

Creates a listing on the HousingAnywhere platform. When creating a single listing, your request must include the fields marked as mandatory, other fields are optional but encouraged.

Authorizations:
Request Body schema: application/json
price
required
integer <int32>

Price of the appartment in lowest denomination in given currency. e.g: Cents if currency is Euro

currencyCode
required
string

Currency code of the currency used in ISO 4217 format.

address
required
object (Address)

The address of the listing by the house number, street, city, state, postal code and the country code.

type
required
integer (Type)
Enum:"House = 0" "Building = 1" "Apartment = 2"
kind
required
integer (Kind)
Enum:"EntirePlace = 0" "PrivateRoom = 1" "SharedRoom = 2"
description
required
string
deposit
integer <int32>

Security Deposit of the appartment in lowest denomination in given currency. e.g: Cents if currency is Euro

estimatedBills
integer <int32>

Estimated montly bills of the appartment in lowest denomination in given currency. e.g: Cents if currency is Euro

minimumStayMonths
integer <int32>

Mention if there is a minimum limit on the period of stay, for eg, the tenant has to stay at least 2 months.

maxBookableDays
integer <int32>

Mention if there is a maximum limit on the period of stay, for eg, the tenant cannot book for more than a year.

currentOccupancy
integer <int32>

The number of people currently living in the house. This is only applicable to properties that are shared apartments or shared rooms.

rules
object (Rules)
minAge
integer <int32>

If there is a minimum age applicable to the tenant, i.e., they have to be at least 18 years old.

maxAge
integer <int32>

If there is a maximum age applicable to the tenant, i.e., they have to be no older than 35 years.

preferredGender
string (Gender)
Enum:"male" "female" "other"
facilities
object

Specify the facilities provided in the listing.

calendarOperations
Array of object (CalendarOperation)
images
Array of object (ImageRequest)

Responses

200

Add Listing Response

400

Bad request or Malformed JSON

401

Authorization error. API key is missing or invalid.

403

Insufficient Permission

422

Wrong payload

500

Something went wrong on server side

post /listings

Production Server. Use it for real data

https://mitra.housinganywhere.com/api/v1/listings

Test server. Use it for test data

https://mitra.s.stage.housinganywhere.com/api/v1/listings

Request samples

application/json
Copy
Expand all Collapse all
{
  • "price": 56700,
  • "currencyCode": "EUR",
  • "address":
    {
    },
  • "type": 1,
  • "kind": 1,
  • "description": "An awsome apartment",
  • "deposit": 24000,
  • "estimatedBills": 15000,
  • "minimumStayMonths": 26,
  • "maxBookableDays": 30,
  • "currentOccupancy": 2,
  • "rules":
    {
    },
  • "minAge": 23,
  • "maxAge": 45,
  • "preferredGender": "male",
  • "facilities":
    {
    },
  • "calendarOperations":
    [
    ],
  • "images":
    []
}

Response samples

application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "data":
    {
    }
}

Get All Listings

Get all listings of the particular advertiser.

Authorizations:

Responses

200

GetListingsResponse

400

Bad request or Malformed JSON

401

Authorization error. API key is missing or invalid.

403

Insufficient Permission

500

Something went wrong on server side

get /listings

Production Server. Use it for real data

https://mitra.housinganywhere.com/api/v1/listings

Test server. Use it for test data

https://mitra.s.stage.housinganywhere.com/api/v1/listings

Response samples

application/json
Copy
Expand all Collapse all
{
  • "meta":
    {
    },
  • "data":
    [
    ],
  • "pagination":
    {
    }
}

Update Listing

Update details of specific listing.

Authorizations:
path Parameters
listing_id
required
integer <int64>

The ID of the listing to update

Request Body schema: application/json
price
integer <int32>

Price of the appartment in lowest denomination in given currency. e.g: Cents if currency is Euro

address
object (Address)

The address of the listing by the house number, street, city, state, postal code and the country code.

type
integer (Type)
Enum:"House = 0" "Building = 1" "Apartment = 2"
kind
integer (Kind)
Enum:"EntirePlace = 0" "PrivateRoom = 1" "SharedRoom = 2"
description
string
deposit
integer <int32>

Security Deposit of the appartment in lowest denomination in given currency. e.g: Cents if currency is Euro

estimatedBills
integer <int32>

Estimated montly bills of the appartment in lowest denomination in given currency. e.g: Cents if currency is Euro

minimumStayMonths
integer <int32>

Mention if there is a minimum limit on the period of stay, for eg, the tenant has to stay at least 2 months.

maxBookableDays
integer <int32>

Mention if there is a maximum limit on the period of stay, for eg, the tenant cannot book for more than a year.

currentOccupancy
integer <int32>

The number of people currently living in the house. This is only applicable to properties that are shared apartments or shared rooms.

rules
object (Rules)
minAge
integer <int32>

If there is a minimum age applicable to the tenant, i.e., they have to be at least 18 years old.

maxAge
integer <int32>

If there is a maximum age applicable to the tenant, i.e., they have to be no older than 35 years.

preferredGender
string (Gender)
Enum:"male" "female" "other"
facilities
object (Facilities)

Responses

200

Update Listing Response

400

Bad request or Malformed JSON

401

Authorization error. API key is missing or invalid.

403

Insufficient Permission

404

Insufficient Permission

422

Wrong payload

500

Something went wrong on server side

patch /listings/{listing_id}

Production Server. Use it for real data

https://mitra.housinganywhere.com/api/v1/listings/{listing_id}

Test server. Use it for test data

https://mitra.s.stage.housinganywhere.com/api/v1/