Lordea® Property REST API

Introduction

Lordea® offers a simple RESTful API allowing realtors to easily create, update, and delete property listings via the API.

 

Documentation Contents

 

Available Data Fields

Below is a list of available fields that our API accepts when adding/editing properties.

Multilingual Support

Before you get started, it's important to note, that Lordea is built atop of a multilingual system, so when entering some data you will be required to follow our multilingual guidlines. All of the available language tags are listed below, next to each field. All of the fields listed below with tags offer multilingual support. When a customer changes their language on our site these options will be displayed in the correct language for them. However; fields like description will not be not be translated, as they are realtor typed static text.

Example:

It's really simple, in place of typing static text like Partially Finished for basement, use one of the options avilable for basement like PARTIALLY_FINISHED.

Field Type / Length Required
status - 1 for unpublished, 2 for published. integer / 1 true
term - Available Terms: TERM_AUCTION, TERM_BUILD_TO_SUIT, TERM_FOR_LEASE, TERM_FOR_RENT, TERM_FOR_SALE, TERM_FOR_SALE_BY_OWNER, TERM_PRE-FORECLOSURE_AUCTION, TERM_SALE_PENDING, TERM_SOLD. string / 255 true
price - We are expecting this value to be a double / float number. double / 25,2 true
net_price - We are expecting this value to be a double / float number. double / 25,2
utilities - We are expecting this value to be a double / float number. double / 25,2
energy_rating - We are expecting this value to be a double / float number. string / 255
commission - We are expecting this value to be a double / float number. double / 25,2
deposit - We are expecting this value to be a double / float number. double / 25,2
price_per_sqft - We are expecting this value to be a double / float number. double / 25,2
brokerage_percentage - We are expecting this value to be a integer. integer / 8
home_type - Available Home Types: HOME_TYPE_APARTMENT, HOME_TYPE_COMMERCIAL_REAL_ESTATE, HOME_TYPE_CONDO, HOME_TYPE_COOP, HOME_TYPE_FOREST_OTHER_LAND, HOME_TYPE_HOUSE, HOME_TYPE_INDUSTRIAL_REAL_ESTATE, HOME_TYPE_LAND, HOME_TYPE_MANUFACTURED, HOME_TYPE_OFFICE_SPACE, HOME_TYPE_SHOP, HOME_TYPE_TOWNHOUSE, HOME_TYPE_OTHER. string / 255 true
bed_rooms - We are expecting this value to be a number. integer / 3
bath_rooms - We are expecting this value to be a number. integer / 3
sqft - We are expecting this value to be a number. integer / 6 true
lot_size - We are expecting this value to be a number. integer / 12
description - We are expecting this value to be a string and is used as the full property description. string / 65,000
year_built - We are expecting this value to be a number. integer / 4
year_updated - We are expecting this value to be a number. integer / 4
hoa_dues - We are expecting this value to be a number. double / 25,2
open_house_hours - We are expecting this value to be a string. string / 255
appliances - Available Appliances: DISHWASHER, DRYER, FREEZER, GARBAGE_DISPOSAL, MICROWAVE, RANGE_OVEN, REFRIGERATOR, TRASH_COMPACTOR, WASHER, OTHER. array / 255
basement - Available Basement Options: FINISHED, PARTIALLY_FINISHED, UNFINISHED string / 255
cooling_system - Available Cooling Systems: CENTRAL, EVAPORATIVE, GEOTHERMAL, REFRIGERATION, SOLAR, WALL, OTHER. string / 255
heating_system - Available Heating Systems: BASEBOARD, FORCED_AIR, HEAT_PUMP, RADIANT, STOVE, WALL, OTHER. string / 255
heating_fuel - Available Heating Fuels: BUTANE, ELECTRIC, GAS, COAL, OIL, PROPANE, SOLAR, WOOD, PELLET, OTHER. string / 255
flooring - Available Heating Fuels: CARPET, CONCRETE, HARDWOOD, LAMINATE, LINOLEUM, VINYL, SLATE, SOFTWOOD, TILE, OTHER. array / 255
indoor_features - Available Indoor Features: ATTIC, CABLE_READY, CEILING_FANS, DOUBLE_PANE_WINDOWS, STORM_WINDOWS, FIREPLACE, INTERCOM_SYSTEM, JETTED_TUB, MOTHER-IN-LAW_APARTMENT, SECURITY_SYSTEM, SKYLIGHTS, VAULTED_CEILING, WET_BAR, WIRED. array / 255
rooms - Available Rooms: ATRIUM, BREAKFAST_NOOK, DINING_ROOM, FAMILY_ROOM, LAUNDRY_ROOM, LIBRARY, MASTER_BATH, MUD_ROOM, OFFICE, PANTRY, RECREATION_ROOM, WORKSHOP, SOLARIUM, SUN_ROOM, WALK-IN_CLOSET. array / 255
total_rooms - We are expecting this value to be a integer. integer / 3
building_amenities - Available Amenities: ASSISTED_LIVING_COMMUNITY, BASKETBALL_COURT, CONTROLLED_ACCESS, POOL, DISABLED_ACCESS, DOORMAN, ELEVATOR, FITNESS_CENTER, NEAR_TRANSPORTATION, OVER_55_ACTIVE_COMMUNITY, STORAGE, HOT_TUB, TENNIS_COURT, RACQUETBALL_COURT, SAUNA. array / 255
architectural_style - Available Styles: BUNGALOW, CAPE_COD, COLONIAL, CONTEMPORARY, CRAFTSMAN, FRENCH, GEORGIAN, LOFT, MODERN, QUEEN_ANNE, VICTORIAN, RANCH, RAMBLER, SANTA_FE, PUEBLO_STYLE, SPANISH, SPLIT_LEVEL, TUDOR, OTHER. array / 255
exterior_building_material - Available Materials: BRICK, CEMENT_CONCRETE, COMPOSITION, METAL, SHINGLE, STONE, STUCCO, VINYL, WOOD, WOOD_PRODUCTS, OTHER. array / 255
outdoor_amenities - Available Amenities: BASKETBALL_COURT, POOL, GATED_ENTRY, STORAGE, HOT_TUB, TENNIS_COURT, RACQUETBALL_COURT, BALCONY, PATIO, BARBECUE, DECK, DOCK, FENCED_YARD, GARDEN, GREENHOUSE, LAWN, POND, PORCH, RV_PAND, SPRINKLER_SYSTEM, WATERFRONT. array / 255
number_of_stories - We are expecting this value to be a integer. integer / 3
parking - Available Parking: CARPORT, GARAGE_ATTACHED, GARAGE_DETACHED, OFF_STREET, ON_STREET. array / 255
number_of_parking - We are expecting this value to be a integer. integer / 3
roof_type - Available Roof Types: ASPHALT, BUILT_UP, COMPOSITION, METAL, SHAKE, SHINGLE, TILE, WOOD, OTHER. array / 255
view - Available View: CITY, MOUNTAIN, PARK, TERRITORIAL, WATER, OTHER. array / 255
floor - We are expecting this value to be a integer. integer / 3
transportation - Available Transportation: BUS, COACH, TRAIN, HIGH_SPEED_TRAIN, LIGHT_RAIL, SUBWAY, FERRY, BOAT, TAXI, TRAM, WALK, DRIVE, BICYCLE, OTHER. array / 255
furnished - Available Furnished Options: UNFURNISHED, FURNISHED, PARTIALLY_FURNISHED. string / 255
school - We are expecting this value to be a string. string / 255
property_faces - Available Property Faces: NORTH, NORTH_EAST, NORTH_WEST, EAST, SOUTH, SOUTH_EAST, SOUTH_WEST, WEST. string / 255
address_1 - We are expecting this value to be a string. string / 255 true
address_2 - We are expecting this value to be a string. string / 255
city - We are expecting this value to be a string. string / 255 true
province - We are expecting this value to be a string. string / 255 true
postal_code - We are expecting this value to be a string. string / 255 true
country - We are expecting this value to be a string. string / 255 true
lat - This is the property's latitude, we are expecting this value to be a double / float number. string / 255 true
lng - This is the property's longitude, we are expecting this value to be a double / float number. string / 255 true
sold_for_price - We are expecting this value to be a double / float number. double / 25,2
buyers_name - We are expecting this value to be a string. string / 255
date_sold - We are expecting this value to be a string. string / 255
purchase_type - We are expecting this value to be a string. string / 255
youtube - We are expecting this value to be a string. string / 255
vimeo - We are expecting this value to be a string. string / 255
photos - We are expecting this value to be an array. array / 255



Available API Endpoints


List All Properties

[GET] https://api.lordea.com/v1/your_api_key/properties

Response: 200

Headers: Content-Type:application/json

Example:

<?php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.lordea.com/v1/your_api_key/properties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);

require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'

response = RestClient.get 'https://api.lordea.com/v1/your_api_key/properties'
puts response
var request = require('request');

request('https://api.lordea.com/v1/your_api_key/properties', function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
from urllib2 import Request, urlopen

request = Request('https://api.lordea.com/v1/your_api_key/properties')

response_body = urlopen(request).read()
print response_body
let url = NSURL(string: "https://api.lordea.com/v1/your_api_key/properties")!
let request = NSMutableURLRequest(URL: url)

let session = NSURLSession.sharedSession()
let task = session.dataTaskWithRequest(request) { data, response, error in
    if let response = response, data = data {
        print(response)
        print(String(data: data, encoding: NSUTF8StringEncoding))
    } else {
        print(error)
    }
}

task.resume()
var request = new XMLHttpRequest();

request.open('GET', 'https://api.lordea.com/v1/your_api_key/properties');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();

 

Create A New Property

[POST] https://api.lordea.com/v1/your_api_key/properties

Response: 201

Headers: Content-Type:application/json

Response Body:

{
  success: true
}

Example:

<?php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.lordea.com/v1/your_api_key/properties");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);

curl_setopt($ch, CURLOPT_POST, TRUE);

curl_setopt($ch, CURLOPT_POSTFIELDS, [
    {
        \"id\": integer,
        \"status\": integer,
        \"term\": string,
        \"price\": string,
        \"net_price\": string,
        \"utilities\": string,
        \"energy_rating\": string,
        \"commission\": string,
        \"deposit\": string,
        \"price_per_sqft\": string,
        \"brokerage_percentage\": string,
        \"youtube\": string,
        \"vimeo\": string,
        \"home_type\": string,
        \"bed_rooms\": string,
        \"bath_rooms\": string,
        \"sqft\": integer,
        \"lot_size\": integer,
        \"description\": string,
        \"year_built\": integer,
        \"year_updated\": integer,
        \"hoa_dues\": string,
        \"open_house_hours\": string,
        \"appliances\": string,
        \"basement\": string,
        \"cooling_system\": string,
        \"heating_system\": string,
        \"heating_fuel\": string,
        \"flooring\": string,
        \"indoor_features\": string,
        \"rooms\": string,
        \"total_rooms\": string,
        \"building_amenities\": string,
        \"architectural_style\": string,
        \"exterior_building_material\": string,
        \"outdoor_amenities\": string,
        \"number_of_stories\": string,
        \"parking\": string,
        \"number_of_parking\": string,
        \"roof_type\": string,
        \"view\": string,
        \"floor\": string,
        \"transportation\": string,
        \"school\": string,
        \"property_faces\": string,
        \"address_1\": string,
        \"address_2\": string,
        \"city\": string,
        \"province\": string,
        \"postal_code\": string,
        \"country\": string,
        \"lat\": string,
        \"lng\": string,
        \"sold_for_price\": string,
        \"buyers_name\": string,
        \"date_sold\": string,
        \"purchase_type\": string,
        \"photos\": [
            {
                0:{
                    \"xs\": string,
                    \"sm\": string,
                    \"md\": string,
                    \"lg\": string
                }
            }
        ]
    }
]);

curl_setopt($ch, CURLOPT_HTTPHEADER, array(
  "Content-Type: application/json"
));

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);
require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'

values = [
    {
        "id": integer,
        "status": integer,
        "term": string,
        "price": string,
        "net_price": string,
        "utilities": string,
        "energy_rating": string,
        "commission": string,
        "deposit": string,
        "price_per_sqft": string,
        "brokerage_percentage": string,
        "youtube": string,
        "vimeo": string,
        "home_type": string,
        "bed_rooms": string,
        "bath_rooms": string,
        "sqft": integer,
        "lot_size": integer,
        "description": string,
        "year_built": integer,
        "year_updated": integer,
        "hoa_dues": string,
        "open_house_hours": string,
        "appliances": string,
        "basement": string,
        "cooling_system": string,
        "heating_system": string,
        "heating_fuel": string,
        "flooring": string,
        "indoor_features": string,
        "rooms": string,
        "total_rooms": string,
        "building_amenities": string,
        "architectural_style": string,
        "exterior_building_material": string,
        "outdoor_amenities": string,
        "number_of_stories": string,
        "parking": string,
        "number_of_parking": string,
        "roof_type": string,
        "view": string,
        "floor": string,
        "transportation": string,
        "school": string,
        "property_faces": string,
        "address_1": string,
        "address_2": string,
        "city": string,
        "province": string,
        "postal_code": string,
        "country": string,
        "lat": string,
        "lng": string,
        "sold_for_price": string,
        "buyers_name": string,
        "date_sold": string,
        "purchase_type": string,
        "photos": [
            {
                0:{
                    "xs": string,
                    "sm": string,
                    "md": string,
                    "lg": string
                }
            }
        ]
    }
]

headers = {
  :content_type => 'application/json'
}

response = RestClient.post 'https://api.lordea.com/v1/your_api_key/properties', values, headers
puts response
var request = require('request');

request({
  method: 'POST',
  url: 'https://api.lordea.com/v1/your_api_key/properties',
  headers: {
    'Content-Type': 'application/json'
  },
  body: "[
    {
        \"id\": integer,
        \"status\": integer,
        \"term\": string,
        \"price\": string,
        \"net_price\": string,
        \"utilities\": string,
        \"energy_rating\": string,
        \"commission\": string,
        \"deposit\": string,
        \"price_per_sqft\": string,
        \"brokerage_percentage\": string,
        \"youtube\": string,
        \"vimeo\": string,
        \"home_type\": string,
        \"bed_rooms\": string,
        \"bath_rooms\": string,
        \"sqft\": integer,
        \"lot_size\": integer,
        \"description\": string,
        \"year_built\": integer,
        \"year_updated\": integer,
        \"hoa_dues\": string,
        \"open_house_hours\": string,
        \"appliances\": string,
        \"basement\": string,
        \"cooling_system\": string,
        \"heating_system\": string,
        \"heating_fuel\": string,
        \"flooring\": string,
        \"indoor_features\": string,
        \"rooms\": string,
        \"total_rooms\": string,
        \"building_amenities\": string,
        \"architectural_style\": string,
        \"exterior_building_material\": string,
        \"outdoor_amenities\": string,
        \"number_of_stories\": string,
        \"parking\": string,
        \"number_of_parking\": string,
        \"roof_type\": string,
        \"view\": string,
        \"floor\": string,
        \"transportation\": string,
        \"school\": string,
        \"property_faces\": string,
        \"address_1\": string,
        \"address_2\": string,
        \"city\": string,
        \"province\": string,
        \"postal_code\": string,
        \"country\": string,
        \"lat\": string,
        \"lng\": string,
        \"sold_for_price\": string,
        \"buyers_name\": string,
        \"date_sold\": string,
        \"purchase_type\": string,
        \"photos\": [
            {
                0:{
                    \"xs\": string,
                    \"sm\": string,
                    \"md\": string,
                    \"lg\": string
                }
            }
        ]
    }
]"
}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
from urllib2 import Request, urlopen

values = """
[
    {
        "id": integer,
        "status": integer,
        "term": string,
        "price": string,
        "net_price": string,
        "utilities": string,
        "energy_rating": string,
        "commission": string,
        "deposit": string,
        "price_per_sqft": string,
        "brokerage_percentage": string,
        "youtube": string,
        "vimeo": string,
        "home_type": string,
        "bed_rooms": string,
        "bath_rooms": string,
        "sqft": integer,
        "lot_size": integer,
        "description": string,
        "year_built": integer,
        "year_updated": integer,
        "hoa_dues": string,
        "open_house_hours": string,
        "appliances": string,
        "basement": string,
        "cooling_system": string,
        "heating_system": string,
        "heating_fuel": string,
        "flooring": string,
        "indoor_features": string,
        "rooms": string,
        "total_rooms": string,
        "building_amenities": string,
        "architectural_style": string,
        "exterior_building_material": string,
        "outdoor_amenities": string,
        "number_of_stories": string,
        "parking": string,
        "number_of_parking": string,
        "roof_type": string,
        "view": string,
        "floor": string,
        "transportation": string,
        "school": string,
        "property_faces": string,
        "address_1": string,
        "address_2": string,
        "city": string,
        "province": string,
        "postal_code": string,
        "country": string,
        "lat": string,
        "lng": string,
        "sold_for_price": string,
        "buyers_name": string,
        "date_sold": string,
        "purchase_type": string,
        "photos": [
            {
                0:{
                    "xs": string,
                    "sm": string,
                    "md": string,
                    "lg": string
                }
            }
        ]
    }
]"""

headers = {
  'Content-Type': 'application/json'
}
request = Request('https://api.lordea.com/v1/your_api_key/properties', data=values, headers=headers)

response_body = urlopen(request).read()
print response_body
let url = NSURL(string: "https://api.lordea.com/v1/your_api_key/properties")!
let request = NSMutableURLRequest(URL: url)
request.HTTPMethod = "POST"
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

request.HTTPBody = [
    {
        \"id\": integer,
        \"status\": integer,
        \"term\": string,
        \"price\": string,
        \"net_price\": string,
        \"utilities\": string,
        \"energy_rating\": string,
        \"commission\": string,
        \"deposit\": string,
        \"price_per_sqft\": string,
        \"brokerage_percentage\": string,
        \"youtube\": string,
        \"vimeo\": string,
        \"home_type\": string,
        \"bed_rooms\": string,
        \"bath_rooms\": string,
        \"sqft\": integer,
        \"lot_size\": integer,
        \"description\": string,
        \"year_built\": integer,
        \"year_updated\": integer,
        \"hoa_dues\": string,
        \"open_house_hours\": string,
        \"appliances\": string,
        \"basement\": string,
        \"cooling_system\": string,
        \"heating_system\": string,
        \"heating_fuel\": string,
        \"flooring\": string,
        \"indoor_features\": string,
        \"rooms\": string,
        \"total_rooms\": string,
        \"building_amenities\": string,
        \"architectural_style\": string,
        \"exterior_building_material\": string,
        \"outdoor_amenities\": string,
        \"number_of_stories\": string,
        \"parking\": string,
        \"number_of_parking\": string,
        \"roof_type\": string,
        \"view\": string,
        \"floor\": string,
        \"transportation\": string,
        \"school\": string,
        \"property_faces\": string,
        \"address_1\": string,
        \"address_2\": string,
        \"city\": string,
        \"province\": string,
        \"postal_code\": string,
        \"country\": string,
        \"lat\": string,
        \"lng\": string,
        \"sold_for_price\": string,
        \"buyers_name\": string,
        \"date_sold\": string,
        \"purchase_type\": string,
        \"photos\": [
            {
                0:{
                    \"xs\": string,
                    \"sm\": string,
                    \"md\": string,
                    \"lg\": string
                }
            }
        ]
    }
].dataUsingEncoding(NSUTF8StringEncoding);

let session = NSURLSession.sharedSession()
let task = session.dataTaskWithRequest(request) { data, response, error in
    if let response = response, data = data {
        print(response)
        print(String(data: data, encoding: NSUTF8StringEncoding))
    } else {
        print(error)
    }
}

task.resume()
var request = new XMLHttpRequest();

request.open('POST', 'https://api.lordea.com/v1/your_api_key/properties');

request.setRequestHeader('Content-Type', 'application/json');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

var body = [
    {
        'id': integer,
        'status': integer,
        'term': string,
        'price': string,
        'net_price': string,
        'utilities': string,
        'energy_rating': string,
        'commission': string,
        'deposit': string,
        'price_per_sqft': string,
        'brokerage_percentage': string,
        'youtube': string,
        'vimeo': string,
        'home_type': string,
        'bed_rooms': string,
        'bath_rooms': string,
        'sqft': integer,
        'lot_size': integer,
        'description': string,
        'year_built': integer,
        'year_updated': integer,
        'hoa_dues': string,
        'open_house_hours': string,
        'appliances': string,
        'basement': string,
        'cooling_system': string,
        'heating_system': string,
        'heating_fuel': string,
        'flooring': string,
        'indoor_features': string,
        'rooms': string,
        'total_rooms': string,
        'building_amenities': string,
        'architectural_style': string,
        'exterior_building_material': string,
        'outdoor_amenities': string,
        'number_of_stories': string,
        'parking': string,
        'number_of_parking': string,
        'roof_type': string,
        'view': string,
        'floor': string,
        'transportation': string,
        'school': string,
        'property_faces': string,
        'address_1': string,
        'address_2': string,
        'city': string,
        'province': string,
        'postal_code': string,
        'country': string,
        'lat': string,
        'lng': string,
        'sold_for_price': string,
        'buyers_name': string,
        'date_sold': string,
        'purchase_type': string,
        'photos': [
            {
                0:{
                    'xs': string,
                    'sm': string,
                    'md': string,
                    'lg': string
                }
            }
        ]
    }
];

request.send(JSON.stringify(body));

 

Show a Property's Detail

[GET] https://api.lordea.com/v1/your_api_key/properties/property_id

Response: 200

Headers: Content-Type:application/json

Example:

<?php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.lordea.com/v1/your_api_key/properties/property_id");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);
require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'

response = RestClient.get 'https://api.lordea.com/v1/your_api_key/properties/property_id'
puts response
var request = require('request');

request('https://api.lordea.com/v1/your_api_key/properties/property_id', function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
from urllib2 import Request, urlopen

request = Request('https://api.lordea.com/v1/your_api_key/properties/property_id')

response_body = urlopen(request).read()
print response_body
import Foundation

// NOTE: Uncommment following two lines for use in a Playground
// import PlaygroundSupport
// PlaygroundPage.current.needsIndefiniteExecution = true

let url = URL(string: "https://api.lordea.com/v1/your_api_key/properties/property_id")!
var request = URLRequest(url: url)

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  if let response = response, let data = data {
    print(response)
    print(String(data: data, encoding: .utf8))
  } else {
    print(error)
  }
}

task.resume()
var request = new XMLHttpRequest();

request.open('GET', 'https://api.lordea.com/v1/your_api_key/properties/property_id');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


Update A Property

[PATCH] https://api.lordea.com/v1/your_api_key/properties/property_id

Response: 200

Headers: Content-Type:application/json

Response Body:

{
  success: true
}

Example:

<?php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.lordea.com/v1/your_api_key/properties/property_id");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PATCH");

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);
require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'

response = RestClient.patch 'https://api.lordea.com/v1/your_api_key/properties/property_id'
puts response
var request = require('request');

request({
  method: 'PATCH',
  url: 'https://api.lordea.com/v1/your_api_key/properties/property_id',
}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
from urllib2 import Request, urlopen

request = Request('https://api.lordea.com/v1/your_api_key/properties/property_id')
request.get_method = lambda: 'PATCH'

response_body = urlopen(request).read()
print response_body
import Foundation

// NOTE: Uncommment following two lines for use in a Playground
// import PlaygroundSupport
// PlaygroundPage.current.needsIndefiniteExecution = true

let url = URL(string: "https://api.lordea.com/v1/your_api_key/properties/property_id")!
var request = URLRequest(url: url)
request.httpMethod = "PATCH"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  if let response = response, let data = data {
    print(response)
    print(String(data: data, encoding: .utf8))
  } else {
    print(error)
  }
}

task.resume()
var request = new XMLHttpRequest();

request.open('PATCH', 'https://api.lordea.com/v1/your_api_key/properties/property_id');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


Delete A Property

[DELETE] https://api.lordea.com/v1/your_api_key/properties/property_id

Response: 200

Headers: Content-Type:application/json

Response Body:

{
  success: true
}

Example:

<?php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, "https://api.lordea.com/v1/your_api_key/properties/property_id");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "DELETE");

$response = curl_exec($ch);
curl_close($ch);

var_dump($response);
require 'rubygems' if RUBY_VERSION < '1.9'
require 'rest_client'

response = RestClient.delete 'https://api.lordea.com/v1/your_api_key/properties/property_id'
puts response
var request = require('request');

request({
  method: 'DELETE',
  url: 'https://api.lordea.com/v1/your_api_key/properties/property_id',
}, function (error, response, body) {
  console.log('Status:', response.statusCode);
  console.log('Headers:', JSON.stringify(response.headers));
  console.log('Response:', body);
});
from urllib2 import Request, urlopen

request = Request('https://api.lordea.com/v1/your_api_key/properties/property_id')
request.get_method = lambda: 'DELETE'

response_body = urlopen(request).read()
print response_body
import Foundation

// NOTE: Uncommment following two lines for use in a Playground
// import PlaygroundSupport
// PlaygroundPage.current.needsIndefiniteExecution = true

let url = URL(string: "https://api.lordea.com/v1/your_api_key/properties/property_id")!
var request = URLRequest(url: url)
request.httpMethod = "DELETE"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  if let response = response, let data = data {
    print(response)
    print(String(data: data, encoding: .utf8))
  } else {
    print(error)
  }
}

task.resume()
var request = new XMLHttpRequest();

request.open('DELETE', 'https://api.lordea.com/v1/your_api_key/properties/property_id');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);
  }
};

request.send();


Errors Codes

Code Meaning
400 Bad Request
401 Unauthorized – Your API key is wrong.
403 Forbidden – The property requested is hidden for administrators only.
404 Not Found – The specified property could not be found.
405 Method Not Allowed – You tried to access a property with an invalid method.
406 Not Acceptable – You requested a format that isn’t json.
410 Gone – The property requested has been removed from our servers.
429 Too Many Requests – You’re requesting too many properties! Slow down!
500 Internal Server Error – We had a problem with our server. Try again later.
503 Service Unavailable – We’re temporarially offline for maintanance. Please try again later.

© 2015-2023 Lordea | Terms of Use | Privacy Policy | Developers | About Us | Contact

Privacy Policy

Your privacy is very important to us. Accordingly, we have developed this Policy in order for you to understand how we collect, use, communicate and disclose and make use of personal information. The following outlines our privacy policy.

  • Before or at the time of collecting personal information, we will identify the purposes for which information is being collected.
  • We will collect and use of personal information solely with the objective of fulfilling those purposes specified by us and for other compatible purposes, unless we obtain the consent of the individual concerned or as required by law.
  • We will only retain personal information as long as necessary for the fulfillment of those purposes.
  • We will collect personal information by lawful and fair means and, where appropriate, with the knowledge or consent of the individual concerned.
  • Personal data should be relevant to the purposes for which it is to be used, and, to the extent necessary for those purposes, should be accurate, complete, and up-to-date.
  • We will protect personal information by reasonable security safeguards against loss or theft, as well as unauthorized access, disclosure, copying, use or modification.
  • We will make readily available to customers information about our policies and practices relating to the management of personal information.
  • We are committed to conducting our business in accordance with these principles in order to ensure that the confidentiality of personal information is protected and maintained.