curl --request POST \
--url https://api.anysite.io/api/midland/estates/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"count": 5000,
"timeout": 300,
"lang": "zh-hk",
"unit": "feet",
"currency": "HKD",
"min_building_age": 499,
"max_building_age": 499,
"text": "<string>",
"estate_name": "<string>",
"exclude_estate_name": "<string>",
"estate_ids": [
"<string>"
],
"exclude_estate_ids": [
"<string>"
],
"include_phases": true,
"property_types": [],
"categories": [],
"developer": "<string>",
"sort": "default",
"region_id": "<string>",
"subregion_ids": [
"<string>"
],
"district_ids": [
"<string>"
],
"sm_district_ids": [
"<string>"
],
"combined_district_ids": [
"<string>"
],
"int_district_ids": [
"<string>"
],
"int_sm_district_ids": [
"<string>"
],
"street_ids": [
"<string>"
],
"mtr_ids": [
"<string>"
],
"walking_duration": 2,
"school_net": "<string>",
"university_ids": [],
"min_net_ft_price": 1,
"max_net_ft_price": 1,
"min_ft_price": 1,
"max_ft_price": 1,
"facility_groups": [],
"garden_features": [
"MISCF00067"
],
"nearby_facilities": []
}
'import requests
url = "https://api.anysite.io/api/midland/estates/search"
payload = {
"count": 5000,
"timeout": 300,
"lang": "zh-hk",
"unit": "feet",
"currency": "HKD",
"min_building_age": 499,
"max_building_age": 499,
"text": "<string>",
"estate_name": "<string>",
"exclude_estate_name": "<string>",
"estate_ids": ["<string>"],
"exclude_estate_ids": ["<string>"],
"include_phases": True,
"property_types": [],
"categories": [],
"developer": "<string>",
"sort": "default",
"region_id": "<string>",
"subregion_ids": ["<string>"],
"district_ids": ["<string>"],
"sm_district_ids": ["<string>"],
"combined_district_ids": ["<string>"],
"int_district_ids": ["<string>"],
"int_sm_district_ids": ["<string>"],
"street_ids": ["<string>"],
"mtr_ids": ["<string>"],
"walking_duration": 2,
"school_net": "<string>",
"university_ids": [],
"min_net_ft_price": 1,
"max_net_ft_price": 1,
"min_ft_price": 1,
"max_ft_price": 1,
"facility_groups": [],
"garden_features": ["MISCF00067"],
"nearby_facilities": []
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
count: 5000,
timeout: 300,
lang: 'zh-hk',
unit: 'feet',
currency: 'HKD',
min_building_age: 499,
max_building_age: 499,
text: '<string>',
estate_name: '<string>',
exclude_estate_name: '<string>',
estate_ids: ['<string>'],
exclude_estate_ids: ['<string>'],
include_phases: true,
property_types: [],
categories: [],
developer: '<string>',
sort: 'default',
region_id: '<string>',
subregion_ids: ['<string>'],
district_ids: ['<string>'],
sm_district_ids: ['<string>'],
combined_district_ids: ['<string>'],
int_district_ids: ['<string>'],
int_sm_district_ids: ['<string>'],
street_ids: ['<string>'],
mtr_ids: ['<string>'],
walking_duration: 2,
school_net: '<string>',
university_ids: [],
min_net_ft_price: 1,
max_net_ft_price: 1,
min_ft_price: 1,
max_ft_price: 1,
facility_groups: [],
garden_features: ['MISCF00067'],
nearby_facilities: []
})
};
fetch('https://api.anysite.io/api/midland/estates/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/midland/estates/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'count' => 5000,
'timeout' => 300,
'lang' => 'zh-hk',
'unit' => 'feet',
'currency' => 'HKD',
'min_building_age' => 499,
'max_building_age' => 499,
'text' => '<string>',
'estate_name' => '<string>',
'exclude_estate_name' => '<string>',
'estate_ids' => [
'<string>'
],
'exclude_estate_ids' => [
'<string>'
],
'include_phases' => true,
'property_types' => [
],
'categories' => [
],
'developer' => '<string>',
'sort' => 'default',
'region_id' => '<string>',
'subregion_ids' => [
'<string>'
],
'district_ids' => [
'<string>'
],
'sm_district_ids' => [
'<string>'
],
'combined_district_ids' => [
'<string>'
],
'int_district_ids' => [
'<string>'
],
'int_sm_district_ids' => [
'<string>'
],
'street_ids' => [
'<string>'
],
'mtr_ids' => [
'<string>'
],
'walking_duration' => 2,
'school_net' => '<string>',
'university_ids' => [
],
'min_net_ft_price' => 1,
'max_net_ft_price' => 1,
'min_ft_price' => 1,
'max_ft_price' => 1,
'facility_groups' => [
],
'garden_features' => [
'MISCF00067'
],
'nearby_facilities' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/midland/estates/search"
payload := strings.NewReader("{\n \"count\": 5000,\n \"timeout\": 300,\n \"lang\": \"zh-hk\",\n \"unit\": \"feet\",\n \"currency\": \"HKD\",\n \"min_building_age\": 499,\n \"max_building_age\": 499,\n \"text\": \"<string>\",\n \"estate_name\": \"<string>\",\n \"exclude_estate_name\": \"<string>\",\n \"estate_ids\": [\n \"<string>\"\n ],\n \"exclude_estate_ids\": [\n \"<string>\"\n ],\n \"include_phases\": true,\n \"property_types\": [],\n \"categories\": [],\n \"developer\": \"<string>\",\n \"sort\": \"default\",\n \"region_id\": \"<string>\",\n \"subregion_ids\": [\n \"<string>\"\n ],\n \"district_ids\": [\n \"<string>\"\n ],\n \"sm_district_ids\": [\n \"<string>\"\n ],\n \"combined_district_ids\": [\n \"<string>\"\n ],\n \"int_district_ids\": [\n \"<string>\"\n ],\n \"int_sm_district_ids\": [\n \"<string>\"\n ],\n \"street_ids\": [\n \"<string>\"\n ],\n \"mtr_ids\": [\n \"<string>\"\n ],\n \"walking_duration\": 2,\n \"school_net\": \"<string>\",\n \"university_ids\": [],\n \"min_net_ft_price\": 1,\n \"max_net_ft_price\": 1,\n \"min_ft_price\": 1,\n \"max_ft_price\": 1,\n \"facility_groups\": [],\n \"garden_features\": [\n \"MISCF00067\"\n ],\n \"nearby_facilities\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/midland/estates/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 5000,\n \"timeout\": 300,\n \"lang\": \"zh-hk\",\n \"unit\": \"feet\",\n \"currency\": \"HKD\",\n \"min_building_age\": 499,\n \"max_building_age\": 499,\n \"text\": \"<string>\",\n \"estate_name\": \"<string>\",\n \"exclude_estate_name\": \"<string>\",\n \"estate_ids\": [\n \"<string>\"\n ],\n \"exclude_estate_ids\": [\n \"<string>\"\n ],\n \"include_phases\": true,\n \"property_types\": [],\n \"categories\": [],\n \"developer\": \"<string>\",\n \"sort\": \"default\",\n \"region_id\": \"<string>\",\n \"subregion_ids\": [\n \"<string>\"\n ],\n \"district_ids\": [\n \"<string>\"\n ],\n \"sm_district_ids\": [\n \"<string>\"\n ],\n \"combined_district_ids\": [\n \"<string>\"\n ],\n \"int_district_ids\": [\n \"<string>\"\n ],\n \"int_sm_district_ids\": [\n \"<string>\"\n ],\n \"street_ids\": [\n \"<string>\"\n ],\n \"mtr_ids\": [\n \"<string>\"\n ],\n \"walking_duration\": 2,\n \"school_net\": \"<string>\",\n \"university_ids\": [],\n \"min_net_ft_price\": 1,\n \"max_net_ft_price\": 1,\n \"min_ft_price\": 1,\n \"max_ft_price\": 1,\n \"facility_groups\": [],\n \"garden_features\": [\n \"MISCF00067\"\n ],\n \"nearby_facilities\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/midland/estates/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"count\": 5000,\n \"timeout\": 300,\n \"lang\": \"zh-hk\",\n \"unit\": \"feet\",\n \"currency\": \"HKD\",\n \"min_building_age\": 499,\n \"max_building_age\": 499,\n \"text\": \"<string>\",\n \"estate_name\": \"<string>\",\n \"exclude_estate_name\": \"<string>\",\n \"estate_ids\": [\n \"<string>\"\n ],\n \"exclude_estate_ids\": [\n \"<string>\"\n ],\n \"include_phases\": true,\n \"property_types\": [],\n \"categories\": [],\n \"developer\": \"<string>\",\n \"sort\": \"default\",\n \"region_id\": \"<string>\",\n \"subregion_ids\": [\n \"<string>\"\n ],\n \"district_ids\": [\n \"<string>\"\n ],\n \"sm_district_ids\": [\n \"<string>\"\n ],\n \"combined_district_ids\": [\n \"<string>\"\n ],\n \"int_district_ids\": [\n \"<string>\"\n ],\n \"int_sm_district_ids\": [\n \"<string>\"\n ],\n \"street_ids\": [\n \"<string>\"\n ],\n \"mtr_ids\": [\n \"<string>\"\n ],\n \"walking_duration\": 2,\n \"school_net\": \"<string>\",\n \"university_ids\": [],\n \"min_net_ft_price\": 1,\n \"max_net_ft_price\": 1,\n \"min_ft_price\": 1,\n \"max_ft_price\": 1,\n \"facility_groups\": [],\n \"garden_features\": [\n \"MISCF00067\"\n ],\n \"nearby_facilities\": []\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "MidlandEstateCard",
"name": "<string>",
"url": "<string>",
"is_hos": true,
"developer": "<string>",
"first_op_at": 123,
"image": "<string>",
"sell_count": 123,
"rent_count": 123,
"total_unit_count": 123,
"total_block_count": 123,
"primary_school_net": "<string>",
"is_index_component": true,
"index_net_ft_price": 123,
"index_net_ft_price_change_percent": 123,
"parent_estate_id": "<string>",
"parent_estate_name": "<string>",
"market_stat": {
"@type": "MidlandMarketStat",
"net_ft_price": 123,
"previous_net_ft_price": 123,
"net_ft_price_change_percent": 123,
"ft_price": 123,
"previous_ft_price": 123,
"ft_price_change_percent": 123,
"net_ft_rent": 123,
"transaction_count": 123,
"transaction_amount": 123
},
"monthly_prices": [],
"yearly_transaction_count": 123,
"yearly_transaction_amount": 123,
"yearly_net_ft_price": 123,
"yearly_net_ft_price_change_percent": 123,
"geo": {
"@type": "MidlandGeo",
"region": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"subregion": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"sm_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"combined_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"int_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"int_sm_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"lux_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
}
},
"location": {
"@type": "MidlandLocation",
"latitude": 123,
"longitude": 123
},
"amenities": [],
"sale_listings_url": "<string>",
"rent_listings_url": "<string>",
"transaction_history_url": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/midland/estates/search
Search Hong Kong residential estates (屋苑) indexed by Midland Realty. Filters cover free text, estate name matching and exclusion, explicit estate ids, whether phases are merged or listed separately, ownership class, curated themes, developer, the eight-level geography, street and MTR station with walking time, primary school net, universities, average price per gross or saleable area unit, building age, estate facility groups, special unit features and required nearby amenities, plus ordering by price, deal volume, deal value or building age. Each estate carries live sale and rental listing counts, total units and blocks, the developer, occupation date, the saleable-area price with month-on-month change, the last twelve monthly average prices, yearly deal count, amount and price change, the geography chain, coordinates, walkable amenities, the primary school net and whether the estate is a component of the Midland Property Price Index.
Price: 20 credits per 1000 results
curl --request POST \
--url https://api.anysite.io/api/midland/estates/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"count": 5000,
"timeout": 300,
"lang": "zh-hk",
"unit": "feet",
"currency": "HKD",
"min_building_age": 499,
"max_building_age": 499,
"text": "<string>",
"estate_name": "<string>",
"exclude_estate_name": "<string>",
"estate_ids": [
"<string>"
],
"exclude_estate_ids": [
"<string>"
],
"include_phases": true,
"property_types": [],
"categories": [],
"developer": "<string>",
"sort": "default",
"region_id": "<string>",
"subregion_ids": [
"<string>"
],
"district_ids": [
"<string>"
],
"sm_district_ids": [
"<string>"
],
"combined_district_ids": [
"<string>"
],
"int_district_ids": [
"<string>"
],
"int_sm_district_ids": [
"<string>"
],
"street_ids": [
"<string>"
],
"mtr_ids": [
"<string>"
],
"walking_duration": 2,
"school_net": "<string>",
"university_ids": [],
"min_net_ft_price": 1,
"max_net_ft_price": 1,
"min_ft_price": 1,
"max_ft_price": 1,
"facility_groups": [],
"garden_features": [
"MISCF00067"
],
"nearby_facilities": []
}
'import requests
url = "https://api.anysite.io/api/midland/estates/search"
payload = {
"count": 5000,
"timeout": 300,
"lang": "zh-hk",
"unit": "feet",
"currency": "HKD",
"min_building_age": 499,
"max_building_age": 499,
"text": "<string>",
"estate_name": "<string>",
"exclude_estate_name": "<string>",
"estate_ids": ["<string>"],
"exclude_estate_ids": ["<string>"],
"include_phases": True,
"property_types": [],
"categories": [],
"developer": "<string>",
"sort": "default",
"region_id": "<string>",
"subregion_ids": ["<string>"],
"district_ids": ["<string>"],
"sm_district_ids": ["<string>"],
"combined_district_ids": ["<string>"],
"int_district_ids": ["<string>"],
"int_sm_district_ids": ["<string>"],
"street_ids": ["<string>"],
"mtr_ids": ["<string>"],
"walking_duration": 2,
"school_net": "<string>",
"university_ids": [],
"min_net_ft_price": 1,
"max_net_ft_price": 1,
"min_ft_price": 1,
"max_ft_price": 1,
"facility_groups": [],
"garden_features": ["MISCF00067"],
"nearby_facilities": []
}
headers = {
"access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
count: 5000,
timeout: 300,
lang: 'zh-hk',
unit: 'feet',
currency: 'HKD',
min_building_age: 499,
max_building_age: 499,
text: '<string>',
estate_name: '<string>',
exclude_estate_name: '<string>',
estate_ids: ['<string>'],
exclude_estate_ids: ['<string>'],
include_phases: true,
property_types: [],
categories: [],
developer: '<string>',
sort: 'default',
region_id: '<string>',
subregion_ids: ['<string>'],
district_ids: ['<string>'],
sm_district_ids: ['<string>'],
combined_district_ids: ['<string>'],
int_district_ids: ['<string>'],
int_sm_district_ids: ['<string>'],
street_ids: ['<string>'],
mtr_ids: ['<string>'],
walking_duration: 2,
school_net: '<string>',
university_ids: [],
min_net_ft_price: 1,
max_net_ft_price: 1,
min_ft_price: 1,
max_ft_price: 1,
facility_groups: [],
garden_features: ['MISCF00067'],
nearby_facilities: []
})
};
fetch('https://api.anysite.io/api/midland/estates/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.anysite.io/api/midland/estates/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'count' => 5000,
'timeout' => 300,
'lang' => 'zh-hk',
'unit' => 'feet',
'currency' => 'HKD',
'min_building_age' => 499,
'max_building_age' => 499,
'text' => '<string>',
'estate_name' => '<string>',
'exclude_estate_name' => '<string>',
'estate_ids' => [
'<string>'
],
'exclude_estate_ids' => [
'<string>'
],
'include_phases' => true,
'property_types' => [
],
'categories' => [
],
'developer' => '<string>',
'sort' => 'default',
'region_id' => '<string>',
'subregion_ids' => [
'<string>'
],
'district_ids' => [
'<string>'
],
'sm_district_ids' => [
'<string>'
],
'combined_district_ids' => [
'<string>'
],
'int_district_ids' => [
'<string>'
],
'int_sm_district_ids' => [
'<string>'
],
'street_ids' => [
'<string>'
],
'mtr_ids' => [
'<string>'
],
'walking_duration' => 2,
'school_net' => '<string>',
'university_ids' => [
],
'min_net_ft_price' => 1,
'max_net_ft_price' => 1,
'min_ft_price' => 1,
'max_ft_price' => 1,
'facility_groups' => [
],
'garden_features' => [
'MISCF00067'
],
'nearby_facilities' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.anysite.io/api/midland/estates/search"
payload := strings.NewReader("{\n \"count\": 5000,\n \"timeout\": 300,\n \"lang\": \"zh-hk\",\n \"unit\": \"feet\",\n \"currency\": \"HKD\",\n \"min_building_age\": 499,\n \"max_building_age\": 499,\n \"text\": \"<string>\",\n \"estate_name\": \"<string>\",\n \"exclude_estate_name\": \"<string>\",\n \"estate_ids\": [\n \"<string>\"\n ],\n \"exclude_estate_ids\": [\n \"<string>\"\n ],\n \"include_phases\": true,\n \"property_types\": [],\n \"categories\": [],\n \"developer\": \"<string>\",\n \"sort\": \"default\",\n \"region_id\": \"<string>\",\n \"subregion_ids\": [\n \"<string>\"\n ],\n \"district_ids\": [\n \"<string>\"\n ],\n \"sm_district_ids\": [\n \"<string>\"\n ],\n \"combined_district_ids\": [\n \"<string>\"\n ],\n \"int_district_ids\": [\n \"<string>\"\n ],\n \"int_sm_district_ids\": [\n \"<string>\"\n ],\n \"street_ids\": [\n \"<string>\"\n ],\n \"mtr_ids\": [\n \"<string>\"\n ],\n \"walking_duration\": 2,\n \"school_net\": \"<string>\",\n \"university_ids\": [],\n \"min_net_ft_price\": 1,\n \"max_net_ft_price\": 1,\n \"min_ft_price\": 1,\n \"max_ft_price\": 1,\n \"facility_groups\": [],\n \"garden_features\": [\n \"MISCF00067\"\n ],\n \"nearby_facilities\": []\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("access-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.anysite.io/api/midland/estates/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 5000,\n \"timeout\": 300,\n \"lang\": \"zh-hk\",\n \"unit\": \"feet\",\n \"currency\": \"HKD\",\n \"min_building_age\": 499,\n \"max_building_age\": 499,\n \"text\": \"<string>\",\n \"estate_name\": \"<string>\",\n \"exclude_estate_name\": \"<string>\",\n \"estate_ids\": [\n \"<string>\"\n ],\n \"exclude_estate_ids\": [\n \"<string>\"\n ],\n \"include_phases\": true,\n \"property_types\": [],\n \"categories\": [],\n \"developer\": \"<string>\",\n \"sort\": \"default\",\n \"region_id\": \"<string>\",\n \"subregion_ids\": [\n \"<string>\"\n ],\n \"district_ids\": [\n \"<string>\"\n ],\n \"sm_district_ids\": [\n \"<string>\"\n ],\n \"combined_district_ids\": [\n \"<string>\"\n ],\n \"int_district_ids\": [\n \"<string>\"\n ],\n \"int_sm_district_ids\": [\n \"<string>\"\n ],\n \"street_ids\": [\n \"<string>\"\n ],\n \"mtr_ids\": [\n \"<string>\"\n ],\n \"walking_duration\": 2,\n \"school_net\": \"<string>\",\n \"university_ids\": [],\n \"min_net_ft_price\": 1,\n \"max_net_ft_price\": 1,\n \"min_ft_price\": 1,\n \"max_ft_price\": 1,\n \"facility_groups\": [],\n \"garden_features\": [\n \"MISCF00067\"\n ],\n \"nearby_facilities\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/midland/estates/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"count\": 5000,\n \"timeout\": 300,\n \"lang\": \"zh-hk\",\n \"unit\": \"feet\",\n \"currency\": \"HKD\",\n \"min_building_age\": 499,\n \"max_building_age\": 499,\n \"text\": \"<string>\",\n \"estate_name\": \"<string>\",\n \"exclude_estate_name\": \"<string>\",\n \"estate_ids\": [\n \"<string>\"\n ],\n \"exclude_estate_ids\": [\n \"<string>\"\n ],\n \"include_phases\": true,\n \"property_types\": [],\n \"categories\": [],\n \"developer\": \"<string>\",\n \"sort\": \"default\",\n \"region_id\": \"<string>\",\n \"subregion_ids\": [\n \"<string>\"\n ],\n \"district_ids\": [\n \"<string>\"\n ],\n \"sm_district_ids\": [\n \"<string>\"\n ],\n \"combined_district_ids\": [\n \"<string>\"\n ],\n \"int_district_ids\": [\n \"<string>\"\n ],\n \"int_sm_district_ids\": [\n \"<string>\"\n ],\n \"street_ids\": [\n \"<string>\"\n ],\n \"mtr_ids\": [\n \"<string>\"\n ],\n \"walking_duration\": 2,\n \"school_net\": \"<string>\",\n \"university_ids\": [],\n \"min_net_ft_price\": 1,\n \"max_net_ft_price\": 1,\n \"min_ft_price\": 1,\n \"max_ft_price\": 1,\n \"facility_groups\": [],\n \"garden_features\": [\n \"MISCF00067\"\n ],\n \"nearby_facilities\": []\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "MidlandEstateCard",
"name": "<string>",
"url": "<string>",
"is_hos": true,
"developer": "<string>",
"first_op_at": 123,
"image": "<string>",
"sell_count": 123,
"rent_count": 123,
"total_unit_count": 123,
"total_block_count": 123,
"primary_school_net": "<string>",
"is_index_component": true,
"index_net_ft_price": 123,
"index_net_ft_price_change_percent": 123,
"parent_estate_id": "<string>",
"parent_estate_name": "<string>",
"market_stat": {
"@type": "MidlandMarketStat",
"net_ft_price": 123,
"previous_net_ft_price": 123,
"net_ft_price_change_percent": 123,
"ft_price": 123,
"previous_ft_price": 123,
"ft_price_change_percent": 123,
"net_ft_rent": 123,
"transaction_count": 123,
"transaction_amount": 123
},
"monthly_prices": [],
"yearly_transaction_count": 123,
"yearly_transaction_amount": 123,
"yearly_net_ft_price": 123,
"yearly_net_ft_price_change_percent": 123,
"geo": {
"@type": "MidlandGeo",
"region": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"subregion": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"sm_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"combined_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"int_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"int_sm_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
},
"lux_district": {
"@type": "MidlandRef",
"id": "<string>",
"name": "<string>"
}
},
"location": {
"@type": "MidlandLocation",
"latitude": 123,
"longitude": 123
},
"amenities": [],
"sale_listings_url": "<string>",
"rent_listings_url": "<string>",
"transaction_history_url": "<string>"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
1 <= x <= 1000020 <= x <= 1500zh-hk, zh-cn, en feet, meter HKD, CNY 0 <= x <= 9990 <= x <= 99911111private, hos, tps pet, university, northern_metro, above_mtr 1default, tx_count_desc, tx_amount_desc, bldg_age, bldg_age_desc, net_ft_price, net_ft_price_desc 111111111x >= 11U01, U02, U03, U04, U05, U06, U07, U08, U09, U10, U11, U12, U13 x >= 0x >= 0x >= 0x >= 0FM02, FM12, FM01, FM07, FM10, FM05, FM09, FM13, FM14 MISCF00067 carpark, mall, recreation, mtr, hospital, park Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes