LandsofAmerica REST API Version 2.0.2 - September 8, 2016

Resources:

types DELETE PATCH PUT POST GET /types/{type}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns various types needed for working with the LOA API. Valid types are 'sort', 'property', 'location', 'status', 'dt' (date values), 'listing'. Values are returned as an array of structures containing their ID and a text label. Below is an example of a request to /types/property. There may be other data included with the return values. For example, property types will include boolean values to distinguish between Land and Water types.

Sample return value:

200 OK

 [ 
   {
      "WaterType": 1,
      "ID": 1024,
      "LandType": 0,
      "type": "Beachfront"
   },
   {
      "WaterType": 0,
      "ID": 64,
      "LandType": 1,
      "type": "Commercial Land"
   },
   {
      "WaterType": 0,
      "ID": 1,
      "LandType": 1,
      "type": "Farms"
   },...
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

member DELETE PATCH PUT POST GET /member/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns the details for a single member based on their Account ID.

Sample return value:

200 OK

{ 
   "companyAddress": {
      "state": "TX",
      "zip": 78130,
      "streetLine2": "",
      "city": "Landville",
      "street": "5000 Land Drive Road"
   },
   "companyName": "Land for Sale, Inc.",
   "address": {
      "state": "TX",
      "zip": 78613,
      "streetLine2": "",
      "city": "Cedar Park",
      "street": "122 Breakaway Road"
   },
   "isALC": false,
   "isALCAdvanced": false,
   "images": {
      "badge": {
         "thumbnail": "//cdn.landsofamerica.com/acct/98/B20140701115-t.jpg",
         "large": "//cdn.landsofamerica.com/acct/98/B20140701115-s.jpg"
      },
      "portrait": {
         "thumbnail": "//cdn.landsofamerica.com/acct/98/P20140523112-t.jpg",
         "large": "//cdn.landsofamerica.com/acct/98/P20140523112-s.jpg"
      },
      "logo": {
         "thumbnail": "//cdn.landsofamerica.com/acct/98/L20110121115-t.jpg",
         "large": "//cdn.landsofamerica.com/acct/98/L20110121115-s.jpg"
      }
   },
   "isSeller": true,
   "accountID": 98,
   "phoneNumber": "888-BUY-LAND",
   "isFree": false,
   "isPremium": true,
   "email": "demo@demo.com",
   "contactName": "John T Land",
   "active": true
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

logos DELETE PATCH PUT POST GET /logos/{size}/{color}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns an approved LandsofAmerica logo for use on pages that interact with the API. You should not call this resource on every page request, but should make a single request to this resource when your application initializes, and then cache the results and reuse them on each appropriate page. Requests to this resource do count against your rate limit.

Valid sizes are 'thumbnail', 'small', 'medium', and 'large'.
Value colors are 'black', 'white', and 'transparent'.

Sample return value:

200 OK

{ 
   "link": "https://www.landsofamerica.com",
   "alt": "Land for sale on Lands of America",
   "height": 28,
   "securesrc": "https://api.landsofamerica.com/images/white-thumbnail.png",
   "nofollow": false,
   "src": "https://api.landsofamerica.com/images/white-thumbnail.png",
   "width": 128
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

states DELETE PATCH PUT POST GET /locations/states

Request Body:

Loading...

Response:

GET
Returns an array of all US states.

Sample return value:

200 OK

 [ 
   {
      "west": -91.0001985,
      "countyLabel": "County",
      "stateID": 1,
      "north": 34.6996134,
      "state": "Alabama",
      "south": 29.8725535,
      "east": -82.8043975,
      "stateCode": "AL"
   },
   {
      "west": -179,
      "countyLabel": "Borough",
      "stateID": 2,
      "north": 72.1016881,
      "state": "Alaska",
      "south": 51.4555169,
      "east": -121.7098512,
      "stateCode": "AK"
   },
   {
      "west": -115.1916316,
      "countyLabel": "County",
      "stateID": 4,
      "north": 36.3822871,
      "state": "Arizona",
      "south": 31.6495479,
      "east": -106.9958306,
      "stateCode": "AZ"
   },
   ...
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

stateRegions DELETE PATCH PUT POST GET /locations/state/{id:\d+}/regions

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns an array of regions for the State ID provided.

Sample return value:

200 OK

 [ 
   {
      "stateID": 2,
      "regionName": "North",
      "regionID": 172
   },
   {
      "stateID": 2,
      "regionName": "South Central",
      "regionID": 174
   },
   {
      "stateID": 2,
      "regionName": "Southeast",
      "regionID": 173
   },
   {
      "stateID": 2,
      "regionName": "Southwest",
      "regionID": 175
   }
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

stateLakes DELETE PATCH PUT POST GET /locations/state/{id:\d+}/lakes

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns an array of lakes for the State ID provided.

Sample return value:

200 OK

 [ 
   {
      "stateID": 9,
      "county": "Windham",
      "stateName": "Connecticut",
      "longitude": -72.0028521,
      "countyID": 3996,
      "lakename": "Abbott Pond",
      "latitude": 41.8867644,
      "lakeID": 220120
   },
   {
      "stateID": 9,
      "county": "New Haven",
      "stateName": "Connecticut",
      "longitude": -73.1109433,
      "countyID": 4152,
      "lakename": "Abbotts Pond",
      "latitude": 41.5437076,
      "lakeID": 142449
   },
   {
      "stateID": 9,
      "county": "Windham",
      "stateName": "Connecticut",
      "longitude": -71.8167373,
      "countyID": 3996,
      "lakename": "Acme Pond",
      "latitude": 41.8462097,
      "lakeID": 165884
   },
   ...
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

stateCounties DELETE PATCH PUT POST GET /locations/state/{id:\d+}/counties

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns an array of counties for the state ID provided.

Sample return value:

200 OK

 [
   
   {
      "countyLabel": "County",
      "stateID": 48,
      "FIPS": 48001,
      "county": "Anderson",
      "longitude": -95.6457951,
      "regionName": "Southwest",
      "countyID": 6024,
      "stateCode": "TX",
      "latitude": 31.776932,
      "regionID": 10
   },
   {
      "countyLabel": "County",
      "stateID": 48,
      "FIPS": 48003,
      "county": "Andrews",
      "longitude": -102.7135121,
      "regionName": "Southwest",
      "countyID": 5963,
      "stateCode": "TX",
      "latitude": 32.342627,
      "regionID": 7
   },
   {
      "countyLabel": "County",
      "stateID": 48,
      "FIPS": 48005,
      "county": "Angelina",
      "longitude": -94.645035,
      "regionName": "Southwest",
      "countyID": 6103,
      "stateCode": "TX",
      "latitude": 31.2704698,
      "regionID": 11
   },
   ...
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

stateCities DELETE PATCH PUT POST GET /locations/state/{id:\d+}/cities

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns an array of cites for the State ID provided.

Sample return value:

200 OK

 [ 
   {
      "stateID": 2,
      "state": "Alaska",
      "cityID": 78,
      "longitude": -176.6580556,
      "cityname": "Adak",
      "latitude": 51.88
   },
   {
      "stateID": 2,
      "state": "Alaska",
      "cityID": 54780,
      "longitude": -152.7652264,
      "cityname": "Afognak",
      "latitude": 58.0221236
   },
   {
      "stateID": 2,
      "state": "Alaska",
      "cityID": 54781,
      "longitude": -164.4355556,
      "cityname": "Aguikchuk",
      "latitude": 60.475
   },
   ...
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

state DELETE PATCH PUT POST GET /locations/state/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns the details for a single state with the ID provided.

Sample return value:

200 OK

 { 
   "west": -179,
   "countyLabel": "Borough",
   "stateID": 2,
   "north": 72.1016881,
   "state": "Alaska",
   "south": 51.4555169,
   "east": -121.7098512,
   "stateCode": "AK"
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

regionCounties DELETE PATCH PUT POST GET /locations/region/{id:\d+}/counties

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns an array of counties for the region ID provided.

Sample return value:

200 OK

 [ 
   {
      "countyLabel": "County",
      "stateID": 20,
      "FIPS": 20001,
      "county": "Allen",
      "longitude": -95.3102505,
      "regionName": "Southeast",
      "countyID": 4915,
      "stateCode": "KS",
      "latitude": 37.9435853,
      "regionID": 122
   },
   {
      "countyLabel": "County",
      "stateID": 20,
      "FIPS": 20003,
      "county": "Anderson",
      "longitude": -95.3102505,
      "regionName": "Southeast",
      "countyID": 4826,
      "stateCode": "KS",
      "latitude": 38.2809328,
      "regionID": 122
   },
   {
      "countyLabel": "County",
      "stateID": 20,
      "FIPS": 20011,
      "county": "Bourbon",
      "longitude": -94.8105955,
      "regionName": "Southeast",
      "countyID": 4916,
      "stateCode": "KS",
      "latitude": 37.7957092,
      "regionID": 122
   },
   ...
]
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

region DELETE PATCH PUT POST GET /locations/region/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns the details for a single region.

Sample return value:

200 OK

 
{
   "stateID": 2,
   "regionName": "North",
   "regionID": 172
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

lake DELETE PATCH PUT POST GET /locations/lake/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns the details for a single lake with the ID provided.

Sample return value:

200 OK

 { 
   "stateID": 9,
   "county": "Windham",
   "stateName": "Connecticut",
   "longitude": -72.0028521,
   "countyID": 3996,
   "lakename": "Abbott Pond",
   "latitude": 41.8867644,
   "lakeID": 220120
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

county DELETE PATCH PUT POST GET /locations/county/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns the details for a single county with the ID provided.

Sample return value:

200 OK

 { 
   "countyLabel": "County",
   "stateID": 31,
   "FIPS": 31083,
   "county": "Harlan",
   "longitude": -99.456155,
   "countyID": 4365,
   "stateCode": "NE",
   "latitude": 40.1665848,
   "regionID": 84
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

city DELETE PATCH PUT POST GET /locations/city/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns the details for a single city with the ID provided.

Sample return value:

200 OK

 { 
   "stateID": 27,
   "state": "Minnesota",
   "cityID": 4365,
   "longitude": -93.2860626,
   "cityname": "Cedar",
   "latitude": 45.319687
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.

showcaselisting DELETE PATCH PUT POST GET /listings/showcase/{id:\d+}/{scid:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns a JSON representation of a single listing. See the listing resourceEmbeddable images are for detailed information on argument sand return values.
required string APIKey
The API Key for your account. This value is required for all interactions with the API.
optional boolean includeImages (default: false)
If true, returns an array of photo tour images for the listing. The main photo for the listing will always be returned.
optional boolean includeDocuments (default: false)
If true, returns an array of documents for the listing
optional boolean includeAmenities (default: false)
If true, a structure of amenity data will be provided

showcase DELETE PATCH PUT POST GET /listings/showcase

Request Body:

Loading...

Response:

GET
Returns showcase properties for the site associated with your account. Results are returned in a random order with each request. The return values mirror the listings resource, but all paging variables will be empty.
Sample return value

200 OK

 { 
   "prevPage": "",
   "records": 10030,
   "currentPage": 1,
   "pages": 669,
   "nextPage": "https://api.landsofamerica.com/v2/listings/?hp=250000&status=P%2CPP&listingtype=1%2C2&lp=100000&listingsperpage=15&sortid=23&stateid=48&pageNumber=2",
   "breadcrumb": " Active  and Under Contract  Texas  Lands for sale  Â» From $100,000.00 to $250,000.00"
   "data": [
      {
         "propertyType": "Commercial",
         "isPlatinum": 1,
         "price": 250000,
         "state": "Texas",
         "listingID": 1384513,
         "listingTitle": "Large Acreage in a Fancy County0",
         "listingDate": "June, 11 2013 00:00:00",
         "isALC": 0,
         "isALCAdvanced": 0,
         "baths": "",
         "stateCode": "TX",
         "latitude": 35.2273372,
         "phone": "1-806-256-1616",
         "thumbnail": "//cdn.landsofamerica.com/inv/1384513/1384513-1306111542576620-t.jpeg",
         "county": "Wheeler",
         "zip": 79079,
         "auctionDate": "",
         "auctionID": "",
         "acres": 2.22,
         "company": "Shannon'srt66 Realty",
         "stateID": 48,
         "youTube": "",
         "address": "1206 N Main",
         "countyID": 5448,
         "cityID": 123,
         "lakeID": "",
         "accountBadge": "",
         "accountPortrait": "",
         "isFree": 0,
         "bedrooms": "",
         "homesqft": "",
         "city": "Shamrock",
         "longitude": -100.24902759999998,
         "contactName": "Monroe Shannon",
         "acctID": 7206,
         "rowNumber": 1,
         "propertyTypeID": 11
      },
      {
         "propertyType": "Acreage",
         "isPlatinum": 1,
         "price": 250000,
         "state": "Texas",
         "listingID": 1147815,
         "listingTitle": "Large Acreage in a Fancy County00:00",
         "listingDate": "December, 20 2012 00:00:00",
         "isALC": 0,
         "isALCAdvanced": 0,
         "baths": "",
         "stateCode": "TX",
         "latitude": 34.508401,
         "phone": "806-236-1453",
         "thumbnail": "//cdn.landsofamerica.com/inv/1147815/1147815-1212201440579902-t.JPG",
         "county": "Hall",
         "zip": 79233,
         "auctionDate": "",
         "auctionID": "",
         "acres": 278,
         "company": "Clift Land Brokers",
         "stateID": 48,
         "youTube": "",
         "address": "CR 24 and Hwy 86",
         "countyID": 5598,
         "cityID": 456,
         "lakeID": "",
         "accountBadge": "",
         "accountPortrait": "//cdn.landsofamerica.com/acct/64099/P20130715045009-t.jpg",
         "isFree": 0,
         "bedrooms": "",
         "homesqft": "",
         "city": "Estelline",
         "longitude": -100.524727,
         "contactName": "Joseph W. Rapp",
         "acctID": 64099,
         "rowNumber": 2,
         "propertyTypeID": 2
      },
      {
         "propertyType": "Commercial",
         "isPlatinum": 1,
         "price": 250000,
         "state": "Texas",
         "listingID": 981895,
         "listingTitle": "Large Acreage in a Fancy County",
         "listingDate": "May, 11 2011 00:00:00",
         "lastModified": "May, 11 2011 00:00:00",
         "isALC": 0,
         "isALCAdvanced": 0,
         "baths": "",
         "stateCode": "TX",
         "latitude": 34.189517,
         "phone": "806-847-7400",
         "thumbnail": "//cdn.landsofamerica.com/inv/981895/981895-1111041728324345-t.jpg",
         "county": "Hale",
         "zip": 79072,
         "auctionDate": "",
         "auctionID": "",
         "acres": 0.12,
         "company": "Street Real Estate",
         "stateID": 48,
         "youTube": "",
         "address": "4308 Olton Rd",
         "countyID": 5675,
         "cityID": 789,
         "lakeID": "",
         "accountBadge": "//cdn.landsofamerica.com/acct/5463/B20121128023925-t.jpg",
         "accountPortrait": "//cdn.landsofamerica.com/acct/5463/P20121128024618-t.jpg",
         "isFree": 0,
         "bedrooms": "",
         "homesqft": "",
         "city": "Plainview",
         "longitude": -101.755402,
         "contactName": "Johnny & Kim Street",
         "acctID": 5463,
         "rowNumber": 3,
         "propertyTypeID": 11
      },
      ...
   ]
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.
optional boolean largerThumbnails (default: 0)
If true, a larger thumbnail image is provided.

listing DELETE PATCH PUT POST GET /listings/{id:\d+}

URI Tokens: (required)

Request Body:

Loading...

Response:

GET
Returns a JSON representation of a single listing. Embeddable images are provided without the protocol in order to facilitate display on http or https domains.

Notes on boundary points
We use Google's Encoded Polyline format for transmitting complex property boundaries in as small a format as possible. These encoded boundaries can be used directly with the Google Maps API, or the boundaries can be expanded to be used in other mapping systems. While we do not provide algorithms for expanding the encoded polylines, there are numerous online resources and open source projects for doing just that.

Sample return value with bad listing ID:

404 Not Found

 { 
   "errors": [
      {
         "Invalid Listing ID": "The listing id provided could not be found."
      }
   ]
}
Sample return value with invactive listing:

405 Not Allowed

 { 
   "errors": [
      {
         "Listing Inactive": "This listing is no longer available."
      }
   ]
}
Sample return value with valid active listing:

200 OK

{ 
   "propertyTypes": {
      "id": 64,
      "label": "Commercial"
   },
   "price": {
      "numeric": 11775432,
      "formatted": "$11,775,432"
   },
   "locationIDs": {
      "stateID": 48,
      "cityID": 27143,
      "countyID": 6277
   },
   "listingID": 1234567,
   "listingTitle": "Large Acreage in a Fancy County",
   "loa_URL": "https://www.landsofamerica.com/listing/1234567",
   "listing_URL": "https://api.landsofamerica.com/v2/listings/1234567",
   "images": [
      {
         "thumbnail": {
            "height": 75,
            "ID": 49796023,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301105303444-t.jpg",
            "width": 115
         },
         "popup": {
            "height": 500,
            "ID": 49796020,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301105303444-p.jpg",
            "width": 692
         },
         "large": {
            "height": 397,
            "ID": 49796021,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301105303444-l.jpg",
            "width": 550
         },
         "description": "",
         "label": "Ranch Cover.jpg"
      },
      {
         "thumbnail": {
            "ID": 49795863,
            "height": 75,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301105182541-t.jpg",
            "width": 115
         },
         "popup": {
            "ID": 49795860,
            "height": 500,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301105182541-p.jpg",
            "width": 692
         },
         "large": {
            "ID": 49795861,
            "height": 397,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301105182541-l.jpg",
            "width": 550
         },
         "description": "",
         "label": "Ranch Collage.jpg"
      },
      {
         "thumbnail": {
            "ID": 49796463,
            "height": 75,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301106178153-t.jpg",
            "width": 115
         },
         "popup": {
            "ID": 49796460,
            "height": 500,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301106178153-p.jpg",
            "width": 692
         },
         "large": {
            "ID": 49796461,
            "height": 397,
            "SRC": "//cdn.landsofamerica.com/inv/1234567/1234567-1305301106178153-l.jpg",
            "width": 550
         },
         "description": "",
         "label": "IMG_1574.jpg"
      },
   ],
   "hasBoundaries": true,
   "type_listings_URL": "https://api.landsofamerica.com/v2/listings/?propertyTypes=64",
   "member_URL": "https://api.landsofamerica.com/v2/members/12345",
   "status": "Available",
   "seller": {
      "phone": "(123) 456-7890",
      "company": "Ranch Seller and Son",
      "portrait": "//cdn.landsofamerica.com/acct/12345/P20130621024430-s.jpg",
      "name": "Ranch Seller",
      "logo": "//cdn.landsofamerica.com/acct/12345/12345Agency.jpg",
      "address": {
         "state": "TX",
         "zip": 78746,
         "streetLine2": "",
         "city": "Austin",
         "streetLine1": "123 Any Street"
      },
      "resource": "/members/12345",
      "acctID": 12345,
      "fax": "(123) 456-7890"
   },
   "county_listings_URL": "https://api.landsofamerica.com/v2/listings/?countyID=6277",
   "amenities": {
      "Land": {
         "Topography": [
            "Bottom",
            "Flood Plain",
            "Rolling",
            "Varied"
         ],
         "Barn Information": [
            "Barn(s)"
         ],
         "Proposed Use": [
            "Agriculture",
            "Hunting/Fishing"
         ],
         "Minerals Available": [
            "Oil & Gas",
            "Water",
            "Wind"
         ],
         "Minerals - % Water Owned": [
            100
         ],
         "Present Use": [
            "Agriculture",
            "Hunting/Fishing"
         ],
         "Game": [
            "Dove",
            "Ducks",
            "Quail",
            "Turkey",
            "Whitetail Deer"
         ],
         "Road Frontage Desc": [
            "State"
         ],
         "Minerals - % Oil & Gas Owned": [
            25
         ],
         "Minerals - % Wind Owned": [
            100
         ],
         "Soil": [
            "Limestone"
         ]
      }
   },
   "directions": "",
   "city_listings_URL": "https://api.landsofamerica.com/v2/listings/?cityID=27143",
   "acres": 8441.17,
   "documents": [
      {
         "description": "Ranch Aerial Map.jpg",
         "URL": "https://s3.amazonaws.com/loa.data/inv/1234567/Ranch%20Aerial%20Map%2Ejpg"
      },
      {
         "description": "Ranch Brochure.pdf",
         "URL": "https://s3.amazonaws.com/loa.data/inv/1234567/Ranch%20Brochure%2Epdf"
      },
      {
         "description": "Ranch Topo Map.jpg",
         "URL": "https://s3.amazonaws.com/loa.data/inv/1234567/Ranch%20Topo%20Map%2Ejpg"
      }
   ],
   "encodedBoundaries": "y|lrDdmjaRvDgQhEkL~GaKb]k\\hG{G_^e~A`m@}Q}Jcf@xr@kTyA{H_EtAcK{d@fm@_q@|e@ij@bZu[dg@qPuXgnA_y@j[cDxLaTbDmXlNgD\\up@_o@_CBoNeVqHgDe{@f^qJkDuEUcF|FmSqGsGrD}H\\gSa]um@xx@kB~@`Nnc@|@~Dm]|cCrUnhAnVxgA|f@x~BnFxCzGv@fGl@lCp@tAx@fFKtCO`GbAvGdAvFbBzDd@lDf@dHj@xEZ",
   "virtualTour": "http://www.avirtualtourlink.com/",
   "state_listings_URL": "https://api.landsofamerica.com/v2/listings/?countyID=48",
   "description": "We are very proud to offer for sale the exceptional...",
   "youTube": "",
   "address": {
      "county": "Uvalde",
      "state": "Texas",
      "zip": 78801,
      "city": "Uvalde",
      "street": "123 Main Street"
   },
   "lng": -99.95834577057394,
   "isAuction": false,
   "lat": 29.393540502585836,
   "member_listings_URL": "https://api.landsofamerica.com/v2/listings/?acctID=12345",
   "flyer": "https://www.landsofamerica.com/shared/includes/createFlyer.cfm?inv_id=1234567",
   "hasHouse": true,
   "homeDetails": {
      "beds": 3,
      "baths": 2,
      "sqft": "5439"
   }
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.
optional boolean includeImages (default: false)
If true, returns an array of photo tour images for the listing. The main photo for the listing will always be returned.
optional boolean includeDocuments (default: false)
If true, returns an array of documents for the listing
optional boolean includeAmenities (default: false)
If true, a structure of amenity data will be provided

listings DELETE PATCH PUT POST GET /listings

Request Body:

Loading...

Response:

GET
required string APIKey
optional numeric pageNumber (default: 1)
optional numeric listingsPerPage (default: 15)
optional numeric lp
optional numeric hp
optional numeric lpa
optional numeric hpa
optional numeric la
optional numeric ha
optional numeric lbed
optional numeric hbed
optional numeric lbath
optional numeric hbath
optional numeric lhsqft
optional numeric hhsqft
optional string countyID
optional string regionID
optional numeric cityID
optional numeric stateID
optional numeric lakeID
optional numeric distance
optional string listingType (default: 1,2,3)
optional string status (default: P,PP)
optional string dt
optional date addf
optional date addt
optional string kw
optional numeric sortid (default: 23)
optional string propertyTypes
optional numeric acctid
optional numeric zip
optional boolean includeDescription (default: 0)
optional boolean largerThumbnails (default: 0)
optional string bounds
optional boolean includeBoundaries (default: 0)
optional boolean hasHouse

lead DELETE PATCH PUT POST GET /lead

Request Body:

Loading...

Response:

POST
Allows the posting of a new Lead on a single property. If there is missing data, then a success value of false will be returned, along with an array of errors. If the lead is accepted, then a 201 response will be returned along with a success value of true.

Sample successful return value:

201 Created

{ 
   "success": true
}

Sample unsuccessful return value:

400 Bad Request

 { 
   "success": false,
   "errors": [
      {
         "Contact name missing": "The value for contact name was not provided"
      },
      {
         "Email address invalid": "The value for Email address is not in a valid format"
      }
   ]
}
required string APIKey
The API Key for your account. This value is required for all interactions with the API.
optional numeric listingID (default: 0)
The numeric ID of the listing. This value is required and will be validated against current listings.
optional string contactName (default: "")
The first name of the contact (required). Maximum length: 100 characters.
optional string emailAddress (default: "")
The email address of the contact (required). Maximum length: 100 characters.
optional string comment (default: "")
The comment received from the contact (required). Maximum length: 1000 characters.
optional string phoneNumber (default: "")
The phone number of the contact (required). Maximum length: 30 characters.
optional boolean sendNotification (default: True)
If allowed for your API key, determines whether the email notification for the lead will be sent or not. Defaults to True.
optional string leadSourceID (default: "")
If provided, records the location of the form on the created lead

Resources are listed in matching order. From top to bottom, the first URI to match the request is used.