API Example - HomePrice

HomePrice Valuation API V2 Service Documentation

Available in plan Standard 002 and Advanced 002:

Action Get all Estates
Request Example GET https://api2.homepricehk.com/getEstates?key=[your_api_key]
Request Data
  • key: (string) The API Key provided by HomePrice
Response Example {"status":"ok","estates":[{"id":3,"nc":"富榮大廈","ne":"Fortune Mansion","rc":"荃灣","re":"Tsuen Wan"},{"id":4,"nc":"麗晶花園","ne":"Richland Gardens","rc":"九龍灣","re":"Kowloon Bay"},{"id":5,"nc":"幸俊苑","ne":"Hang Chun Court","rc":"長沙灣","re":"Cheung Sha Wan"},{"id":6055,"nc":"太古城","ne":"Taikoo Shing","rc":"鰂魚涌","re":"Quarry Bay"}]}
Response Data
  • status: (string) Status of API call, "ok" if normal.
  • estates: Array of Estate objects
  • estates.id: (int) Unique Estate Id
  • estates.nc: (string) Estate name in Chinese
  • estates.ne: (string) Estate name in English
  • estates.rc: (string) Estate region in Chinese
  • estates.re: (string) Estate region in English
Action Get all Buildings within an Estate
Request Example GET https://api2.homepricehk.com/getBuildings?estate=6055&key=[your_api_key]
Request Data
  • estate: (int) The Estate Id
  • key: (string) The API Key provided by HomePrice
Response Example {"status":"ok","buildings":[{"id":886,"nc":"逸天閣","ne":"Yat Tien Mansion","pnc":"海天花園","pne":"Horizon Gardens"},{"id":1151,"nc":"天山閣","ne":"Tien Shan Mansion","pnc":"高山臺","pne":"Kao Shan Terrace"},{"id":1190,"nc":"廬山閣","ne":"Lu Shan Mansion","pnc":"高山臺","pne":"Kao Shan Terrace"},{"id":17241,"nc":"元宮閣","ne":"Yuan Kung Mansion","pnc":"金殿臺","pne":"Kam Din Terrace"}]}
Response Data
  • status: (string) Status of API call, "ok" if normal.
  • buildings: Array of Building objects
  • buildings.id: (int) Unique Building Id
  • buildings.nc: (string) Building name in Chinese
  • buildings.ne: (string) Building name in English
  • buildings.pnc: (string) Building phase name in Chinese
  • buildings.pne: (string) Building phase name in English
Action Get basic valuation of all Units within a Buildings
Request Example GET https://api2.homepricehk.com/getUnits?building=17241&key=[your_api_key]
Request Data
  • building: (int) The Building Id
  • key: (string) The API Key provided by HomePrice
Response Example {"status":"ok","units":[{"f":3,"u":"A","v":1200},{"f":3,"u":"B","v":1280},{"f":3,"u":"C","v":1271},{"f":27,"u":"A","v":1443}]}
Response Data
  • status: (string) Status of API call, "ok" if normal.
  • units: Array of Unit objects
  • units.f: (int) Unit's floor number
  • units.u: (string) Unit's flat name
  • unit.v: (int) Unit's current valuation, in 10,000 HKD. (e.g. 1234 = 12,340,000 HKD)

Available in plan Advanced 002:

Action Get detailed valution of a unit
Request Example GET https://api2.homepricehk.com/getUnitDetail?building=17241&floor=27&unit=A&key=[your_api_key]
Request Data
  • building: (int) The Building Id
  • floor: (int) The unit's floor number
  • unit: (string) The unit's flat name
  • key: (string) The API Key provided by HomePrice
Response Example {"status":"ok","v":1443,"size":709,"trend":[{"2022-05-01":1443},{"2022-04-01":1422},{"2022-03-01":1422},{"2000-01-01":390}]}
Response Data
  • status: (string) Status of API call, "ok" if normal.
  • v: (int) Unit's current valuation, in 10,000 HKD. (e.g. 1234 = 12,340,000 HKD)
  • size: (int) Unit's saleable area in square feet
  • trend: Array of Date (string, as key) and Valuation (int, as value)