# Properties api description
## Get list of properties
`GET` API_URL/api/v1/properties
**Available params**
*requerst without params return 25 latest properties*
| Key | Description |
| --- | --- |
| `city` | String, search by city field |
| `state` | String, search by state field |
| `housingType` | String, list of available types available at API_URL/api/v1/properties/housing_types|
| `startPrice` |Integer, should be used with `endPrice` to search in price range|
| `endPrice` | Integer, should be used with `startPrice` to search in price range|
|`areaCenterLat`| Float, Example: 33.3709492|
|`areaCenterLon`| Float, Example: -82.0923939|
|`areaRadius`| Integer, 1 = 1 mile, avalable to using with search by area center |
||Pagination and size of response|
|`size`| Integer, count of properties |
|`rooms`| Integer, number of rooms|
|`baths`| Integer, number of bathsroom|
|`page`| Integer, number of page with size(25 by default)|
**return status code 200 OK**
**response body:**
```json
{
"data": [
...
{
"id": "5c8889fb22616d74ebc68713",
"type": "properties",
"attributes": {
"address": "810 Mitchell Street",
"city": "Augusta",
"state": "GA",
"zipCode": "30907",
"listPrice": 118900.0,
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_1.jpg",
"beds": 3,
"baths": 2,
"sqFt": 1317.0,
"slug": "810-mitchell-street-augusta-ga-30907",
"originalListingDate": "03/13/2019",
"lastChangedDate": "03/13/2019",
"coordinates": {
"latitude": 33.5276322,
"longitude": -82.0468219
},
"additionalPhotos": [
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_2.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_3.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_4.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_5.jpg"
],
"watchlisted": false
},
"relationships": {
"realtor": {
"data": {
"id": "5c6d7f7922616d52d16c7d84",
"type": "realtor"
}
}
}
...
],
"included": [
...
{
"id": "5c6d7f7922616d52d16c7d84",
"type": "realtor",
"attributes": {
"fullName": "Nick Punjabi",
"email": "Nick@VanderMorganRealty.com ",
"phone": "702-606-6600",
"slug": "nick_punjabi",
"photo": "https://s3.garagelabs.dev/listd/uploads/nick_punjabi.jpg"
},
...
]
},
"meta": {
"total": 2089,
"pagination": {
"total_pages": 42,
"current_page": 1,
"next_page": 2,
"prev_page": null
}
}
}
```
## Get property data
*slug identifier is used*
`GET` API_URL/api/v1/properties/810-mitchell-street-augusta-ga-30907
**return status code 200 OK**
**response:**
```json
{
"data": {
"id": "5c8889fb22616d74ebc68713",
"type": "property",
"attributes": {
"county": "RICHMOND",
"directions": "From Steven's Creek Rd. Turn on to Dennis Rd. Then turn right onto Mitchell, and the house will be on the left.",
"listingPictures": [
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_1.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_2.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_3.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_4.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_5.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_6.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_7.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_8.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_9.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_10.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_11.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_12.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_13.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_14.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_15.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_16.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_17.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_18.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_19.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_20.jpg",
"https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_21.jpg"
],
"interiorFeatures": [
"Other-See Remarks",
"Smoke Detector",
"Washer/Dryer Connection",
"Recently Painted",
"Cable Available",
"Pantry"
],
"exteriorFeatures": [
"Landscaped-Full",
"Outbuildings Remain",
"Other-See Remarks",
"Fenced Yard"
],
"parkingFeatures": "Parking Pad",
"description": "ABSOLUTELY Adorable 3 bed 2 full bath home in WEST AUGUSTA. This home has been well cared for and lovingly updated through the years. The ROOF IS NEW, newer double hung Vinyl windows, LOW MAINTENANCE VINYL EXTERIOR, Nice laminate floors, ceiling fans in the great room and bedrooms, pantry in the kitchen. FRESHLY painted a light grey throughout the home with bright white trim. The home is VERY clean and has a good layout thats feels big and open. This property has a BIG lot with parking for your boat or RV or even just storage. The owners have used that area for a dedicated/secure dog run in the past. If you are looking for an exceptional WEST AUGUSTA GA location, close to I-20, Riverwatch PKWY, Downtown Augusta or any of the surrounding areas- This is a super convenient location.",
"cooling": "Ceiling Fan(s),Central",
"heating": "Gas Pack",
"flooring": "Laminate,Other-See Remarks",
"yearBuilt": 1978,
"lotAcres": null,
"featured": [
{
"addressOne": "810 Mitchell Street",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 118900.0,
"originalListingDate": "2019-03-13 00:17:31",
"slug": "810-mitchell-street-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_1.jpg"
},
{
"addressOne": "805 Mitchell Street",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 125700.0,
"originalListingDate": "2018-06-29 17:33:52",
"slug": "805-mitchell-street-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/429290_Photo_1.jpg"
},
{
"addressOne": "3004 Silverwood Drive",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 130000.0,
"originalListingDate": "2019-02-23 05:05:29",
"slug": "3004-silverwood-drive-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/437689_Photo_1.jpg"
},
{
"addressOne": "2016 Reserve Lane",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 129000.0,
"originalListingDate": "2019-05-15 21:40:02",
"slug": "2016-reserve-lane-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/441338_Photo_1.jpg"
},
{
"addressOne": "2006 Reserve Lane",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 129000.0,
"originalListingDate": "2018-08-07 19:40:19",
"slug": "2006-reserve-lane-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/430887_Photo_1.jpg"
},
{
"addressOne": "16 Macaulay Place",
"baths": 3,
"beds": 3,
"city": "Augusta",
"listPrice": 129000.0,
"originalListingDate": "2019-06-10 23:38:22",
"slug": "16-macaulay-place-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/442548_Photo_1.jpg"
},
{
"addressOne": "2122 Buckhaven Drive",
"baths": 3,
"beds": 3,
"city": "Augusta",
"listPrice": 127000.0,
"originalListingDate": "2019-04-18 21:52:23",
"slug": "2122-buckhaven-drive-augusta-ga-30909",
"state": "GA",
"zipCode": "30909",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/440053_Photo_1.jpg"
},
{
"addressOne": "2026 Helmsdale Lane",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 124900.0,
"originalListingDate": "2019-05-23 19:21:22",
"slug": "2026-helmsdale-lane-augusta-ga-30909",
"state": "GA",
"zipCode": "30909",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/441729_Photo_1.jpg"
},
{
"addressOne": "2652 York Drive",
"baths": 2,
"beds": 2,
"city": "Augusta",
"listPrice": 114900.0,
"originalListingDate": "2019-05-17 22:13:34",
"slug": "2652-york-drive-augusta-ga-30909",
"state": "GA",
"zipCode": "30909",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/441472_Photo_1.jpg"
},
{
"addressOne": "203 York Way",
"baths": 2,
"beds": 2,
"city": "Augusta",
"listPrice": 115000.0,
"originalListingDate": "2019-05-21 21:35:19",
"slug": "203-york-way-augusta-ga-30909",
"state": "GA",
"zipCode": "30909",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/441616_Photo_1.jpg"
}
],
"originalListingImages": [
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_1.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_2.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_3.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_4.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_5.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_6.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_7.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_8.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_9.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_10.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_11.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_12.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_13.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_14.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_15.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_16.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_17.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_18.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_19.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_20.jpg",
"https://s3.amazonaws.com/rets-rabbit-werx/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_21.jpg"
]
},
"relationships": {
"realtor": {
"data": {
"id": "5c6d7f7922616d52d16c7d84",
"type": "realtor"
}
}
}
},
"included": [
{
"id": "5c6d7f7922616d52d16c7d84",
"type": "realtor",
"attributes": {
"fullName": "Nick Punjabi",
"email": "Nick@VanderMorganRealty.com ",
"phone": "702-606-6600",
"slug": "nick_punjabi",
"photo": "https://s3.garagelabs.dev/listd-staging/user/photo/5c6d7ed922616d52d16c7d82//uploads/nick_punjabi.jpg",
"latestProperties": [
{
"addressOne": "810 Mitchell Street",
"baths": 2,
"beds": 3,
"city": "Augusta",
"listPrice": 118900.0,
"originalListingDate": "2019-03-13 00:17:31",
"slug": "810-mitchell-street-augusta-ga-30907",
"state": "GA",
"zipCode": "30907",
"iconPropertyImageUrl": "https://listd.com/property-images/7c79320535a0ec0508e52f0fe13e84a5/438444_Photo_1.jpg"
},
{
"addressOne": "3006 KatieLane",
"baths": 2,
"beds": 4,
"city": "Joplin",
"listPrice": 214900.0,
"originalListingDate": null,
"slug": "3006-katielane-joplin-mo-64801",
"state": "MO",
"zipCode": "64801",
"iconPropertyImageUrl": "http://cdn.photos.sparkplatform.com/ogar/20190620183136751065000000-o.jpg"
},
{
"addressOne": "21850 JudeLane",
"baths": 0,
"beds": 0,
"city": "Webb City",
"listPrice": 35000.0,
"originalListingDate": null,
"slug": "21850-judelane-webb-city-mo-64870",
"state": "MO",
"zipCode": "64870",
"iconPropertyImageUrl": "http://cdn.photos.sparkplatform.com/ogar/20190712183023674990000000-o.jpg"
},
{
"addressOne": "2328 Willard",
"baths": 2,
"beds": 3,
"city": "Joplin",
"listPrice": 132900.0,
"originalListingDate": null,
"slug": "2328-willard-joplin-mo-64804",
"state": "MO",
"zipCode": "64804",
"iconPropertyImageUrl": "http://cdn.photos.sparkplatform.com/ogar/20190712142747778341000000-o.jpg"
}
]
}
}
]
}
```
**Description of image fields:**
`listingPictures` images are used as previews (they are optimized and reduced)
`originalListingIImages` images with original size and quality without any manipulations(for example to full screen view )
## Add property to user watch list
*request should be authorized*
`POST` API_URL/api/v1/properties/**:property_slug**/watchlist
*request does not require any additional parameters*
**response status code OK 200**
**response body: nil**
## Remove property from watch list
*request should be authorized*
`DELETE` API_URL/api/v1/properties/**:property_slug**/watchlist
*request does not require any additional parameters*
**response status code No Content 204**
**response body: nil**
## Create inquiry about property
*request can be sent as an authorized user or an unauthorized user*
`POST` API_URL/api/v1/properties/**:property_slug**/inquiry
**Available params**
| Parameter | Description | Required |
| ------------ | ------------ | ------------ |
| `name` | String, user name | `true` if user unauthorized |
| `email` | String, user email | `true` if user unauthorized |
| `phone` | String, user phone | `true` if user unauthorized |
| `message` | String, Example: AGENT_NAME, tell me more about property PROPERTY_ADDRESS | `true` |
**response status code OK 200**
**response body: nil**
## Share property
*request can be sent as an authorized user or an unauthorized user*
`POST` API_URL/api/v1/properties/**:property_slug**/sharings
**Available params**
| Parameter | Description | Required |
| ------------ | ------------ | ------------ |
| `to_email` | String, user name | `true` |
| `from_email` | String, user email | `true` if user unauthorized |
| `to_user_name` | String, user phone | `true` |
| `from_user_name` | String, user phone | `true` if user unauthorized |
**response status code OK 200**
**response body: nil**
## Update property
*request should be authorized*
*user should have additional role*
`POST` API_URL/api/v1/properties/**:property_slug**
**Available params**
*Additional role `edit_seo`*
| Parameter | Description |
| ------------ | ------------ |
| `meta_title` | String, title, property address by default |
| `meta_keywords` | String, keywords, comma separated |
| `meta_description` | String, description, property description by default |
*Additional role `edit_property`*
*Description will be updated*
| Parameter | Description |
| ------------ | ------------ |
| `description` | String |
| `list_price` | String |
| `sq_ft` | String |
| `beds` | String |
| `baths` | String|
| `lot_acres` | String |
| `year_built` | String |
| `cooling` | String |
| `heating` | String |
| `flooring` | String |
| `interior_features` | String |
| `exterior_features` | String |
Additional role `edit_photo`
*Description will be updated*
*Here we pass a sorted array of urls of photos, after uploading of a new photo, it is placed on the first place of the array*
| Parameter | Description |
| ------------ | ------------ |
| `listing_pictures` | Array |
**response status code OK 200**
**response body: updated property data**
## Upload new property image
*request should be authorized*
*user should have additional role `edit_photo`*
endpoint accepts **form-data**
`POST` API_URL/api/v1/properties/**:property_slug**/photos
**Available params**
| Parameter | Description |
| ------------ | ------------ |
| `file` | Image file, supported formats: jpeg, jpg, png |
**response status code 200 OK**
**response body: **
Sign in with Wallet
Connect another wallet