curl --request POST \
--url https://api.anysite.io/api/centaline/estates/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"count": 2,
"timeout": 300,
"lang": "hk",
"keyword": "<string>",
"hma_ids": [
"<string>"
],
"estates": [
"<string>"
],
"order": "Ascending",
"primary_school_nets": [
"<string>"
],
"estate_usages": [],
"facilities": [],
"developers": [
"<string>"
],
"min_price_per_sqft": 1,
"max_price_per_sqft": 1,
"min_building_age": 1,
"max_building_age": 1,
"sort": "Ranking"
}
'import requests
url = "https://api.anysite.io/api/centaline/estates/search"
payload = {
"count": 2,
"timeout": 300,
"lang": "hk",
"keyword": "<string>",
"hma_ids": ["<string>"],
"estates": ["<string>"],
"order": "Ascending",
"primary_school_nets": ["<string>"],
"estate_usages": [],
"facilities": [],
"developers": ["<string>"],
"min_price_per_sqft": 1,
"max_price_per_sqft": 1,
"min_building_age": 1,
"max_building_age": 1,
"sort": "Ranking"
}
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: 2,
timeout: 300,
lang: 'hk',
keyword: '<string>',
hma_ids: ['<string>'],
estates: ['<string>'],
order: 'Ascending',
primary_school_nets: ['<string>'],
estate_usages: [],
facilities: [],
developers: ['<string>'],
min_price_per_sqft: 1,
max_price_per_sqft: 1,
min_building_age: 1,
max_building_age: 1,
sort: 'Ranking'
})
};
fetch('https://api.anysite.io/api/centaline/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/centaline/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' => 2,
'timeout' => 300,
'lang' => 'hk',
'keyword' => '<string>',
'hma_ids' => [
'<string>'
],
'estates' => [
'<string>'
],
'order' => 'Ascending',
'primary_school_nets' => [
'<string>'
],
'estate_usages' => [
],
'facilities' => [
],
'developers' => [
'<string>'
],
'min_price_per_sqft' => 1,
'max_price_per_sqft' => 1,
'min_building_age' => 1,
'max_building_age' => 1,
'sort' => 'Ranking'
]),
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/centaline/estates/search"
payload := strings.NewReader("{\n \"count\": 2,\n \"timeout\": 300,\n \"lang\": \"hk\",\n \"keyword\": \"<string>\",\n \"hma_ids\": [\n \"<string>\"\n ],\n \"estates\": [\n \"<string>\"\n ],\n \"order\": \"Ascending\",\n \"primary_school_nets\": [\n \"<string>\"\n ],\n \"estate_usages\": [],\n \"facilities\": [],\n \"developers\": [\n \"<string>\"\n ],\n \"min_price_per_sqft\": 1,\n \"max_price_per_sqft\": 1,\n \"min_building_age\": 1,\n \"max_building_age\": 1,\n \"sort\": \"Ranking\"\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/centaline/estates/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 2,\n \"timeout\": 300,\n \"lang\": \"hk\",\n \"keyword\": \"<string>\",\n \"hma_ids\": [\n \"<string>\"\n ],\n \"estates\": [\n \"<string>\"\n ],\n \"order\": \"Ascending\",\n \"primary_school_nets\": [\n \"<string>\"\n ],\n \"estate_usages\": [],\n \"facilities\": [],\n \"developers\": [\n \"<string>\"\n ],\n \"min_price_per_sqft\": 1,\n \"max_price_per_sqft\": 1,\n \"min_building_age\": 1,\n \"max_building_age\": 1,\n \"sort\": \"Ranking\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/centaline/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\": 2,\n \"timeout\": 300,\n \"lang\": \"hk\",\n \"keyword\": \"<string>\",\n \"hma_ids\": [\n \"<string>\"\n ],\n \"estates\": [\n \"<string>\"\n ],\n \"order\": \"Ascending\",\n \"primary_school_nets\": [\n \"<string>\"\n ],\n \"estate_usages\": [],\n \"facilities\": [],\n \"developers\": [\n \"<string>\"\n ],\n \"min_price_per_sqft\": 1,\n \"max_price_per_sqft\": 1,\n \"min_building_age\": 1,\n \"max_building_age\": 1,\n \"sort\": \"Ranking\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "CentalineEstateSummary",
"url": "<string>",
"name": "<string>",
"phase_name": "<string>",
"address": "<string>",
"estate_structure": "<string>",
"developer": "<string>",
"management_company": "<string>",
"phase_count": 123,
"building_count": 123,
"unit_count": 123,
"min_building_age": 123,
"max_building_age": 123,
"first_occupation_at": 123,
"last_occupation_at": 123,
"sale": {
"@type": "CentalinePriceTrend",
"saleable_price_per_sqft": 123,
"saleable_price_per_sqft_change_percent": 123,
"gross_price_per_sqft": 123,
"gross_price_per_sqft_change_percent": 123,
"min_price": 123,
"max_price": 123,
"min_saleable_price_per_sqft": 123,
"max_saleable_price_per_sqft": 123,
"listing_count": 123,
"transaction_count": 123
},
"rent": {
"@type": "CentalinePriceTrend",
"saleable_price_per_sqft": 123,
"saleable_price_per_sqft_change_percent": 123,
"gross_price_per_sqft": 123,
"gross_price_per_sqft_change_percent": 123,
"min_price": 123,
"max_price": 123,
"min_saleable_price_per_sqft": 123,
"max_saleable_price_per_sqft": 123,
"listing_count": 123,
"transaction_count": 123
},
"school_net": {
"@type": "CentalineSchoolNet",
"primary_school_net": "<string>",
"primary_school_url": "<string>",
"secondary_school_district": "<string>",
"secondary_school_url": "<string>"
},
"scope": {
"@type": "CentalineScope",
"region": "<string>",
"region_code": "<string>",
"district": "<string>",
"district_code": "<string>",
"area": "<string>",
"area_code": "<string>",
"hma": "<string>",
"hma_id": "<string>",
"hma_description": "<string>",
"image": "<string>"
},
"media": {
"@type": "CentalineMediaFlags",
"has_media": true,
"has_photos": true,
"has_street_view": true,
"has_sphere": true,
"has_video": true,
"has_virtual_tour": true,
"has_floor_plan": true,
"has_planning_diagram": true,
"has_unit_plan": true,
"has_aerial_view": true,
"has_building_3d_model": true
},
"latitude": 123,
"longitude": 123,
"image": "<string>",
"updated_at": 123
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}/centaline/estates/search
Search the Centaline directory of Hong Kong residential estates (屋苑). Filter by free-text keyword, Housing Market Area, estate type code, primary school net, ownership category, clubhouse facilities, developer, average price per saleable sq ft and building age, ordered by ranking, price per sq ft or building age. Each estate carries its type code, name, address, developer and management company, phase/building/unit counts, occupation date range, current sale and rent price levels with month-on-month trend and listing/transaction counts, school nets, district hierarchy and coordinates.
Price: 1 credit
curl --request POST \
--url https://api.anysite.io/api/centaline/estates/search \
--header 'Content-Type: application/json' \
--header 'access-token: <api-key>' \
--data '
{
"count": 2,
"timeout": 300,
"lang": "hk",
"keyword": "<string>",
"hma_ids": [
"<string>"
],
"estates": [
"<string>"
],
"order": "Ascending",
"primary_school_nets": [
"<string>"
],
"estate_usages": [],
"facilities": [],
"developers": [
"<string>"
],
"min_price_per_sqft": 1,
"max_price_per_sqft": 1,
"min_building_age": 1,
"max_building_age": 1,
"sort": "Ranking"
}
'import requests
url = "https://api.anysite.io/api/centaline/estates/search"
payload = {
"count": 2,
"timeout": 300,
"lang": "hk",
"keyword": "<string>",
"hma_ids": ["<string>"],
"estates": ["<string>"],
"order": "Ascending",
"primary_school_nets": ["<string>"],
"estate_usages": [],
"facilities": [],
"developers": ["<string>"],
"min_price_per_sqft": 1,
"max_price_per_sqft": 1,
"min_building_age": 1,
"max_building_age": 1,
"sort": "Ranking"
}
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: 2,
timeout: 300,
lang: 'hk',
keyword: '<string>',
hma_ids: ['<string>'],
estates: ['<string>'],
order: 'Ascending',
primary_school_nets: ['<string>'],
estate_usages: [],
facilities: [],
developers: ['<string>'],
min_price_per_sqft: 1,
max_price_per_sqft: 1,
min_building_age: 1,
max_building_age: 1,
sort: 'Ranking'
})
};
fetch('https://api.anysite.io/api/centaline/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/centaline/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' => 2,
'timeout' => 300,
'lang' => 'hk',
'keyword' => '<string>',
'hma_ids' => [
'<string>'
],
'estates' => [
'<string>'
],
'order' => 'Ascending',
'primary_school_nets' => [
'<string>'
],
'estate_usages' => [
],
'facilities' => [
],
'developers' => [
'<string>'
],
'min_price_per_sqft' => 1,
'max_price_per_sqft' => 1,
'min_building_age' => 1,
'max_building_age' => 1,
'sort' => 'Ranking'
]),
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/centaline/estates/search"
payload := strings.NewReader("{\n \"count\": 2,\n \"timeout\": 300,\n \"lang\": \"hk\",\n \"keyword\": \"<string>\",\n \"hma_ids\": [\n \"<string>\"\n ],\n \"estates\": [\n \"<string>\"\n ],\n \"order\": \"Ascending\",\n \"primary_school_nets\": [\n \"<string>\"\n ],\n \"estate_usages\": [],\n \"facilities\": [],\n \"developers\": [\n \"<string>\"\n ],\n \"min_price_per_sqft\": 1,\n \"max_price_per_sqft\": 1,\n \"min_building_age\": 1,\n \"max_building_age\": 1,\n \"sort\": \"Ranking\"\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/centaline/estates/search")
.header("access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"count\": 2,\n \"timeout\": 300,\n \"lang\": \"hk\",\n \"keyword\": \"<string>\",\n \"hma_ids\": [\n \"<string>\"\n ],\n \"estates\": [\n \"<string>\"\n ],\n \"order\": \"Ascending\",\n \"primary_school_nets\": [\n \"<string>\"\n ],\n \"estate_usages\": [],\n \"facilities\": [],\n \"developers\": [\n \"<string>\"\n ],\n \"min_price_per_sqft\": 1,\n \"max_price_per_sqft\": 1,\n \"min_building_age\": 1,\n \"max_building_age\": 1,\n \"sort\": \"Ranking\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.anysite.io/api/centaline/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\": 2,\n \"timeout\": 300,\n \"lang\": \"hk\",\n \"keyword\": \"<string>\",\n \"hma_ids\": [\n \"<string>\"\n ],\n \"estates\": [\n \"<string>\"\n ],\n \"order\": \"Ascending\",\n \"primary_school_nets\": [\n \"<string>\"\n ],\n \"estate_usages\": [],\n \"facilities\": [],\n \"developers\": [\n \"<string>\"\n ],\n \"min_price_per_sqft\": 1,\n \"max_price_per_sqft\": 1,\n \"min_building_age\": 1,\n \"max_building_age\": 1,\n \"sort\": \"Ranking\"\n}"
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"@type": "CentalineEstateSummary",
"url": "<string>",
"name": "<string>",
"phase_name": "<string>",
"address": "<string>",
"estate_structure": "<string>",
"developer": "<string>",
"management_company": "<string>",
"phase_count": 123,
"building_count": 123,
"unit_count": 123,
"min_building_age": 123,
"max_building_age": 123,
"first_occupation_at": 123,
"last_occupation_at": 123,
"sale": {
"@type": "CentalinePriceTrend",
"saleable_price_per_sqft": 123,
"saleable_price_per_sqft_change_percent": 123,
"gross_price_per_sqft": 123,
"gross_price_per_sqft_change_percent": 123,
"min_price": 123,
"max_price": 123,
"min_saleable_price_per_sqft": 123,
"max_saleable_price_per_sqft": 123,
"listing_count": 123,
"transaction_count": 123
},
"rent": {
"@type": "CentalinePriceTrend",
"saleable_price_per_sqft": 123,
"saleable_price_per_sqft_change_percent": 123,
"gross_price_per_sqft": 123,
"gross_price_per_sqft_change_percent": 123,
"min_price": 123,
"max_price": 123,
"min_saleable_price_per_sqft": 123,
"max_saleable_price_per_sqft": 123,
"listing_count": 123,
"transaction_count": 123
},
"school_net": {
"@type": "CentalineSchoolNet",
"primary_school_net": "<string>",
"primary_school_url": "<string>",
"secondary_school_district": "<string>",
"secondary_school_url": "<string>"
},
"scope": {
"@type": "CentalineScope",
"region": "<string>",
"region_code": "<string>",
"district": "<string>",
"district_code": "<string>",
"area": "<string>",
"area_code": "<string>",
"hma": "<string>",
"hma_id": "<string>",
"hma_description": "<string>",
"image": "<string>"
},
"media": {
"@type": "CentalineMediaFlags",
"has_media": true,
"has_photos": true,
"has_street_view": true,
"has_sphere": true,
"has_video": true,
"has_virtual_tour": true,
"has_floor_plan": true,
"has_planning_diagram": true,
"has_unit_plan": true,
"has_aerial_view": true,
"has_building_3d_model": true
},
"latitude": 123,
"longitude": 123,
"image": "<string>",
"updated_at": 123
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
API token from the dashboard
Headers
Body
x >= 120 <= x <= 1500hk, sc, en Ascending, Descending RE, HOS, PRH, Other SwimmingPool, IndoorSwimmingPool, ChildrensPool, Gymnasium, ChildrenPlaygroundPlayRoom, PlaygroundPlayroom, SaunnaRoom, SteamBathRoom, Jacuzzi, TennisCourt, SquashCourt, BadmintonCourt, TableTennis, SnookerRoom, GolfDrivingRange, BallRoom, ReadingStudyRoom x >= 0x >= 0x >= 0x >= 0Ranking, NUnitPrice, BuildingAge 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