Advertised Proposals API (Public API)


This API is automatically activated upon website subscription in Billing Settings. And can be used for websites on external services, or used as data to power third party applications. 


The URL will be 


[AgencyID].landmax.pro/api/lettings

[AgencyID].landmax.pro/api/sales



Note as this data is already public either via agents website or portals, there is no need for an API key. Restriction: 100 Calls per minute



Parameters: 


The API displays 25 results at a time by default. 


limit 


This can be used to change the number count. 


Example URL: http://lmxwebsite.landmax.pro/api/lettings?limit=50


We suggest however, pagination is used. To display the next set of results. See offset. 


offset


This should be used in combination with limit 


Example URL: http://lmxwebsite.landmax.pro/api/lettings?limit=25&offset=25


sort


You can order results by using the following arguments: 


sort=latest

sort=price




Querying Individual property records


You can query a property record by using its ID. Just add the ID to the path: 


Example id: L0013


Example URL: http://lmxwebsite.landmax.pro/api/lettings/l0013



Search Parameters 


You can constrain the results by adding search in the path: 


Example URL: http://lmxwebsite.landmax.pro/api/search?type=letting&category=0&minBedroom=2&maxBedroom=3&area=&minPrice=1000&maxPrice=2000


type


You can filter type by the following arguments: 


type=letting

type=sale


category


category=         (Any)

category=0        (Houses)

category=1        (Flats)

category=2        (Bungalows)

category=3        (Mobile/ Park Homes)

category=4        (Land)

category=5        (Character Property)

category=6        (Garage/ Parking)

category=7        (Retirement Property)

category=8        (House Flat Share)

category=9        (Commercial)


minBedroom


maxBedroom


area


Areas are defined in your landmax.pro account - See settings > LookUp Values > Address Areas


minPrice


maxPrice





Example Response for List:


{
  "success": true,
  "results": 17,
  "rows": [
    {
      "id": "L0013",
      "lettingProposal": true,
      "title": "3 bedroom flat to let",
      "price": 300,
      "pricePcm": 300,
      "priceRaw": 30000,
      "propertyShortDescription": "Brand newly refurbished extremely large two double bedroom maisonette for rent. Situated in one of greens most premium locations, two double bedrooms, large living room, kitchen, wet room bathroom and lovely garden. Extremely clean and bright with lots of space.",
      "proposalDescription": "Room Available in brand newly refurbished extremely large two double bedroom maisonette for rent. Situated in one of greens most premium locations, two double bedrooms, large living room, kitchen, wet room bathroom and lovely garden. Extremely clean and bright with lots of space.",
      "bedroomCount": "3 bedroom",
      "bedrooms": "3",
      "bathrooms": "2",
      "receptions": "2",
      "availableFrom": "01/09/2016",
      "availableFromRaw": 1472688000000,
      "propertyCategory": "flat",
      "tenure": "f0ec4f10-5be5-40d3-9bc8-16691e327024",
      "address": {
        "line1": "3 Bakers Mews",
        "line2": "",
        "town": "LONDON",
        "area": "Westminster",
        "country": "UK",
        "postCode": "W1U 3HB",
        "coordinates": {
          "latitude": 51.51693,
          "longitude": -0.1540262
        }
      },
      "addressStr": "3 Bakers Mews, Westminster, LONDON, W1U 3HB",
      "priceType": "pcm",
      "priceQualifier": "default",
      "depositAmount": 40000,
      "featured": false,
      "letType": "short_term",
      "publishAs": "Let Agreed",
      "videoytId": "APPaonp-ajQ",
      "photos": [
        {
          "description": "80-HR-6.jpg",
          "url": "https://lh3.googleusercontent.com/NqDxrnV-tEwG9tRR470FtihVMZjP8C_wpWuCQrgcsKLDVy-WIyew1UUKySnuaQtTHbY3G-OOQdtTpkcWvjvHqQ"
        },
        {
          "description": "80-HR-7.jpg",
          "url": "https://lh3.googleusercontent.com/UEGCZmfOoJnbMfFtPsyng7hSyFmDAEoPDBz0NKvuAHHiprLLzvyB1JuyVNhZaQWQc1NphKQBwsX1ezRa59mchg"
        },
        {
          "description": "114-HR-3.jpg",
          "url": "https://lh3.googleusercontent.com/MUYSvtLrf2rryMSRvlxptUMlPKBllozI1XgrR8s_vTbfc2OA4cM7niymsHad43pGPhh-H4PJplk1b7V9nGaVrVs"
        },
        {
          "description": "115-HR-3.jpg",
          "url": "https://lh3.googleusercontent.com/zSH8fMwhuFJfjwxTA0ZQVpRG6iWTndl2NCi7Go0CB_A5dJPNN6hMp4PXj36sJGYXKJ6YBz9TWWGrNzco1EYNqpg"
        },
        {
          "description": "115-HR-4.jpg",
          "url": "https://lh3.googleusercontent.com/EkhCeN5_4BiCfev4JceqeatPcKTxJH9hl-Gjwwo9TMK-PZti9TXBB2Db7_mWlva5hAGl6sfxjP7hrpnedhJ7"
        },
        {
          "description": "document_example.png",
          "url": "https://lh3.googleusercontent.com/CuJp3ZlEYtfnnmPVYNHi3DlvRdBk4Z6Oz0SkIriw6UMSVOpRZJYfGfR_JVc8Dinx8mbLK9ygsVI5ZKYtC1xTh0Y"
        },
        {
          "description": "free_example.png",
          "url": "https://lh3.googleusercontent.com/jb1RtTjtJ9lu8SGQxs_3HlWe6wiDv5CqD9yAuFQZL85kEtLCpQgX4yAbeTGO1SYHNptqLmH9Iq_L9E3gb1I-1g"
        },
        {
          "description": "template_example.png",
          "url": "https://lh3.googleusercontent.com/TPSoy8W-P_xrqqxnOxUwTa9C3jf0v8hVvu9LizbYfy0zv52VphoCuw9n34aqfB2F89NQwMwOCMq0oxIpbsrM"
        }
      ]
    },



Example Response for single proposal : 


// 20170329111627
// http://lmxwebsite.landmax.pro/api/lettings/l0013

{
  "id": "L0013",
  "lettingProposal": true,
  "title": "3 bedroom flat to let",
  "price": 300,
  "pricePcm": 300,
  "priceRaw": 30000,
  "propertyShortDescription": "Brand newly refurbished extremely large two double bedroom maisonette for rent. Situated in one of greens most premium locations, two double bedrooms, large living room, kitchen, wet room bathroom and lovely garden. Extremely clean and bright with lots of space.",
  "proposalDescription": "Room Available in brand newly refurbished extremely large two double bedroom maisonette for rent. Situated in one of greens most premium locations, two double bedrooms, large living room, kitchen, wet room bathroom and lovely garden. Extremely clean and bright with lots of space.",
  "bedroomCount": "3 bedroom",
  "bedrooms": "3",
  "bathrooms": "2",
  "receptions": "2",
  "availableFrom": "01/09/2016",
  "availableFromRaw": 1472688000000,
  "propertyCategory": "flat",
  "tenure": "f0ec4f10-5be5-40d3-9bc8-16691e327024",
  "address": {
    "line1": "3 Bakers Mews",
    "line2": "",
    "town": "LONDON",
    "area": "Westminster",
    "country": "UK",
    "postCode": "W1U 3HB",
    "coordinates": {
      "latitude": 51.51693,
      "longitude": -0.1540262
    }
  },
  "addressStr": "3 Bakers Mews, Westminster, LONDON, W1U 3HB",
  "priceType": "pcm",
  "priceQualifier": "default",
  "depositAmount": 40000,
  "featured": false,
  "letType": "short_term",
  "publishAs": "Let Agreed",
  "videoytId": "APPaonp-ajQ",
  "photos": [
    {
      "description": "80-HR-6.jpg",
      "url": "https://lh3.googleusercontent.com/NqDxrnV-tEwG9tRR470FtihVMZjP8C_wpWuCQrgcsKLDVy-WIyew1UUKySnuaQtTHbY3G-OOQdtTpkcWvjvHqQ"
    },
    {
      "description": "80-HR-7.jpg",
      "url": "https://lh3.googleusercontent.com/UEGCZmfOoJnbMfFtPsyng7hSyFmDAEoPDBz0NKvuAHHiprLLzvyB1JuyVNhZaQWQc1NphKQBwsX1ezRa59mchg"
    },
    {
      "description": "114-HR-3.jpg",
      "url": "https://lh3.googleusercontent.com/MUYSvtLrf2rryMSRvlxptUMlPKBllozI1XgrR8s_vTbfc2OA4cM7niymsHad43pGPhh-H4PJplk1b7V9nGaVrVs"
    },
    {
      "description": "115-HR-3.jpg",
      "url": "https://lh3.googleusercontent.com/zSH8fMwhuFJfjwxTA0ZQVpRG6iWTndl2NCi7Go0CB_A5dJPNN6hMp4PXj36sJGYXKJ6YBz9TWWGrNzco1EYNqpg"
    },
    {
      "description": "115-HR-4.jpg",
      "url": "https://lh3.googleusercontent.com/EkhCeN5_4BiCfev4JceqeatPcKTxJH9hl-Gjwwo9TMK-PZti9TXBB2Db7_mWlva5hAGl6sfxjP7hrpnedhJ7"
    },
    {
      "description": "document_example.png",
      "url": "https://lh3.googleusercontent.com/CuJp3ZlEYtfnnmPVYNHi3DlvRdBk4Z6Oz0SkIriw6UMSVOpRZJYfGfR_JVc8Dinx8mbLK9ygsVI5ZKYtC1xTh0Y"
    },
    {
      "description": "free_example.png",
      "url": "https://lh3.googleusercontent.com/jb1RtTjtJ9lu8SGQxs_3HlWe6wiDv5CqD9yAuFQZL85kEtLCpQgX4yAbeTGO1SYHNptqLmH9Iq_L9E3gb1I-1g"
    },
    {
      "description": "template_example.png",
      "url": "https://lh3.googleusercontent.com/TPSoy8W-P_xrqqxnOxUwTa9C3jf0v8hVvu9LizbYfy0zv52VphoCuw9n34aqfB2F89NQwMwOCMq0oxIpbsrM"
    }
  ],
  "longDescription": "A superior specification throughout includes a fitted Symphony kitchen with integrated appliances and granite worktops; wardrobe fitted in the master bedroom; ceramic floor tiles in the kitchen and bathrooms. The apartment has one double bedrooms and a private walk-out balcony.  <br>  <br>The Library is well under 10 minutes walk from Willesden Green Tube Station in Zone 2 on the Jubilee Line. From here there are direct connections to key interchanges including Baker Street, Waterloo, London Bridge and Canary Wharf.  <br>  <br>Call Regent Letting directly to arrange a viewing for these exclusive apartments. We are able to do evening and weekend viewings. Applicants are required to register details before any viewings are booked.  <br>  <br>Please note all furnishings visible in photos may not be present at time of viewing. Furnishings may differ/change once occupancy is granted. Computer Generated Images are for indicative purposes only. Interior photos are/maybe of similar property in the development.  <br>  <br>",
  "taxBand": "h",
  "extraInfo": {
    "PropertyDetailsEntertainment": [
      "Television",
      "Sky Digital",
      "Swimming pool",
      "Broadband Enabled Area"
    ],
    "PropertyDetailsSafetyFeatures": [
      "Burglar Alarm",
      "Fire Alarm",
      "HMO License",
      "Landlord Accredited Property",
      "Monoxide Detector",
      "Fire Doors",
      "Fire Extinguishers",
      "Fire Blanket"
    ]
  },
  "keyFeatures": [
    "Room 1",
    "Furnished",
    "Offering abundant living space",
    "Underground Parking on request",
    "Luxurious bathroom suite"
  ],
  "epcs": [
    {
      "description": null,
      "url": "https://lh3.googleusercontent.com/gmj0lh94_pC8y9K_G1NnnJJFvn3pjy2qI58xIcA1yleGk2JBNc4gsxhiNImRrJ7yPfpeUxotuLq81BDJwxiwYjM"
    },
    {
      "description": "",
      "url": "https://lmxwebsite.landmax.pro/files/xF9F0lz-oy9xeAkHiSJG_1g5Jwdf36cLxbbmMTl8ctdFVXJm1Kc8pPV6HyfAl0JME7heAT-VHuSqA2feZ-GcFh6CsneKPxUvfHdpFahVXpY/epc.pdf"
    }
  ],
  "floorPlans": [
    {
      "description": "",
      "url": "https://lh3.googleusercontent.com/tNSh2B8bJR3QsPgrYIBLaSUxVAyupmBC37C01JuFVFjwkF4h28XRLikfhJ1yx32J87yYGv-z9l5VNCjf2mSS"
    }
  ]
}