Request format for Address Lookup Service (JSON Output)

Download

Data Resource Details

Dataset
Address Lookup Service
Data Providers
Digital Policy Office
Data Category
Housing
Format
JSON
API
Available
Update Frequency
Monthly

Description

GET request:

https://www.als.gov.hk/lookup?q=<input address in free text format>

POST request:

POST /lookup HTTP/1.1
Host: www.als.gov.hk
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Content-Length: <number of bytes in the body of the request>

q=<input address in free-text format>

Notes:

This web service allows data consumers to look up address records using simple address element information [for example (a) building name, (b) street name and number or (c) estate name and block number]. The service will also search for addresses with spelling or pronunciation similar to the user input information for reference use.

  • Input parameters:
  • "q" – input address element information (mandatory; URL-encoded(percent-encoded));
  • "n" – maximum number of records to be returned (optional; range: 1-200; default: 200);
  • "t" – tolerance on returned record scores (optional; range: 0-80; default: 35);
  • "b" – enable/disable basic searching mode, default disabled (optional; range: 0 or 1; default: 0).
  • The request and response are encoded in UTF-8.
  • The data output format, language (Chinese / English / Both Chinese and English) and compression method can be specified using the HTTP header parameters: Accept=application/json, Accept-Language=en,zh-Hant and Accept-Encoding=gzip
  • Please refer to the "Data Dictionary" for details.
loading
Loading...

Additional Information of Data Resource

Date Created
2020-02-28
Date Published
2020-02-28
Content Language
English, Traditional Chinese

Access to save data on the browser is disabled, some functions may not be available.

Please enable the access to unlock the full functionality of the website.