Search for properties and projects using the search criteria
1 min
POST
http://localhost:8080/api/v0/search
Body Parameters
- bodySearchRequestrequiredDescription
- countriesstring[]Example
- citiesstring[]Example
- areasstring[]Example
- numberOfRoomsstring[]Example
- minPriceinteger<int32>
- maxPriceinteger<int32>
- minSizeinteger<int32>
- maxSizeinteger<int32>
- isCitizenshipEligibleboolean
- isReadyForDeliveryboolean
- isReadyForTitleDeedboolean
- projectTypesstring[]Example
- paymentPlansstring[]Example
- facilitiesstring[]Example
- featuresstring[]Example
Responses
200
- SearchResponse
- projectsproject[]required
- idstringExample
- namestringExample
- descriptionstringExample
- countrystringExample
- citystringExample
- lastUpdatedAtstringExample
- latnumber<double>required
- lngnumber<double>required
- titleDeedStatusstring<Ready | Not_Ready>required
- areastringrequired
- typestring<Commercial | Villa | Land | Apartment | Office | Shop | Building | Hotel | Farm | Penthouse | Residential | Warehouse>required
- titleDeedDatestring<date>
- numberOfFloorsinteger<int32>
- citizenshipEligibleboolean
- readyForDeliverybooleanrequired
- deliveryDatestring<date>
- imageUrlsstring[]requiredExample
- videoUrlsstring[]requiredExample
- facilitiesfacility[]required
- idstringrequired
- namestringrequired
- propertiesproperty[]required
- idstringrequired
- namestringrequired
- descriptionstringrequired
- minPricenumberrequired
- maxPricenumberrequired
- measurementstringrequired
- numberOfRoomsstring<OnePlusOne | TwoPlusOne | ThreePlusOne | FourPlusOne>required
- sizeinteger<int64>required
- lastUpdatedAtstring<date-time>required
- currencystringrequired
- paymentPlanstring<Cash | Installment | Installment_with_down_payment | Down_payment>required
- downPaymentPercentagenumber<double>
- installmentMonthCountinteger<int32>
- featuresfeature[]required
- idstringrequired
- namestringrequired
- imageUrlsstring[]requiredExample
- videoUrlsstring[]requiredExample
- planUrlsstring[]requiredExample
400
- ErrorResponse
- successbooleanrequired
- codeinteger<int32>required
- messagesobjectExample
- timestring<date-time>required
403
- ErrorResponse
- successbooleanrequired
- codeinteger<int32>required
- messagesobjectExample
- timestring<date-time>required
500
- ErrorResponse
- successbooleanrequired
- codeinteger<int32>required
- messagesobjectExample
- timestring<date-time>required
curl
curl --request POST \
--url http://localhost:8080/api/v0/search \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'POST',
headers: myHeaders,
redirect: 'follow'
};
fetch("http://localhost:8080/api/v0/search", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("http://localhost:8080/api/v0/search")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = http.request(request)
puts response.read_body
python
import requests
import json
url = "http://localhost:8080/api/v0/search"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
200
{
"SearchResponse": {
"summary": "Successful operation with some results or no results matching the search criteria",
"description": "SearchResponse",
"value": {
"projects": [
{
"id": "9Q8YG862",
"name": "Istanbul Life",
"description": "Istanbul Life is a project that is located in Istanbul",
"country": "Turkey",
"city": "Istanbul",
"lastUpdatedAt": "2023-03-26T14:53:52",
"lat": 40.9814,
"lng": 29.0247,
"titleDeedStatus": "Ready",
"area": "Kadikoy",
"type": "Residential",
"citizenshipEligible": true,
"readyForDelivery": true,
"imageUrls": [
"https://d18iwq8rvfnbhk.cloudfront.net/images/Project/1/images-cb4ae8be-5b0e-4342-9231-45b804f300df"
],
"videoUrls": [
"https://d18iwq8rvfnbhk.cloudfront.net/videos/Project/1/videos-c1e40a41-2716-4dfc-830e-884c7ab3f9e9"
],
"facilities": [
"Sauna",
"Jacuzzi",
"Pool",
"Gym",
"Tennis",
"Squash",
"Spa",
"Restaurant",
"Bar",
"Cafe",
"Playground"
],
"properties": [
{
"id": "7VD318Z4",
"name": "1+1",
"description": "Our 1+1 apartments are located in Istanbul",
"minPrice": 2000000,
"maxPrice": 2200000,
"measurement": "sqm2",
"numberOfRooms": "OnePlusOne",
"size": 46,
"lastUpdatedAt": "2023-03-26T15:01:35",
"currency": "TRY",
"paymentPlan": "Cash",
"features": [
"Balcony",
"American Kitchen",
"Kitchenette",
"Sea View",
"Balcony"
],
"imageUrls": [
"https://d18iwq8rvfnbhk.cloudfront.net/images/images-8e9853dd-639b-419b-8c74-98f9eb850b97"
],
"videoUrls": [
"https://d18iwq8rvfnbhk.cloudfront.net/videos/videos-8e9853dd-639b-419b-8c74-98f9eb850b97"
],
"planUrls": [
"https://d18iwq8rvfnbhk.cloudfront.net/plans/properties/9Q8YG862/plans-79a932fb-57a6-45e8-b14d-5c09d15857bd",
"https://d18iwq8rvfnbhk.cloudfront.net/plans/properties/9Q8YG862/plans-fae7ac01-03cf-4ecf-aa47-7071122fd355"
]
}
]
}
]
}
}
}400
{
"ErrorResponse": {
"summary": "Bad request, Some of the parameters are not valid",
"description": "ErrorResponse",
"value": {
"success": false,
"code": 1,
"message": "Some of the parameters are not valid"
}
}
}403
// Access Denied, you don't have the right permissions
{
"success": false,
"code": "",
"messages": {},
"time": ""
}500
// System Exception, please contact the administrator
{
"success": false,
"code": "",
"messages": {},
"time": ""
}