en
Location Search API
Description
Location Search API provides HTTP-based API for application developers to find the location by its address, building name, place name or facility name.
Important Notice on Location Search API
In order to maintain the quality of the Map API service, your application shall not invoke the API with large amount of requests within a short period.
API URL
URL Format:
Example URL:
https://geodata.gov.hk/gs/api/[version]/locationSearch?q=[value]
Query Parameters
- [version] specifies the version number of this API, which is currently "v1.0.0". Notes: The version number may be updated in the future. Old version will be removed at any time without notice. Please check this page to get the list of supported version and update your application(s) accordingly.
- "q" specifies the input string to search, such as addresses, building names, place names or facility names.
Response
The data will be returned in JSON format.
Status Codes
This API uses the standard HTTP status code to indicate the status of the API request.
Status Code | Description |
---|---|
200 | OK |
400 | Bad Request. e.g. invalid query parameters |
500 | Internal Server Error |
Build a Query URL
Description | Parameter | Value |
---|---|---|
q |
https://geodata.gov.hk/gs/api/v1.0.0/locationSearch?q=cultural%20centre
Click to Copy text
Contact Information
Contact | |
---|---|
Organisation | Lands Department |
Position | GeoInfo Map Support Team |
Email Address | geoinfomap@landsd.gov.hk |
Text Copied
Text Copy Failed, URL to you to copy: