User Guide

Let’s Start with Home Page
Use Next and Previous buttons to navigate and learn more about the features.

DATASETS
We have various types of datasets available for you to use across different categories from different providers. You can access all of these in this menu.

PROVIDERS
You can view the list of all data providers in DATA.GOV.HK with the number of datasets associated with them on the Providers page.

HELP
Help has everything you need to know regarding using DATA.GOV.HK from user guides to frequently asked questions about DATA.GOV.HK.

DEVELOPER CENTER
Developer center has everything you need to know regarding the API specification and CKAN API.

COMMUNITY
Explore the City Dashboard, Consolidated Annual Open Data Plans (Spatial Data Plans included), and more about Open Data in the Community menu.

DOWNLOAD QUEUE
You can add historical datasets and data resources to the download queue as you browse through and download them later.

SEARCH
You can search DATA.GOV.HK for data through any keyword

APPLICATIONS
Applications that have used open data from DATA.GOV.HK are shown here. You can learn and understand how open data can be used.

FEEDBACK
At any point in time, you can send us your questions or concerns.

Learn About Historical Data Download
Use Next and Previous buttons to navigate and learn more about the features.

GET HISTORICAL DATA
Most Dataset and Data resources have historical data.
To get Historical Data, you need to enter the desired Date Range and Click on Get Data.

DOWNLOAD HISTORICAL DATA
On Clicking Get Data, You get the total no. of files and the size information and the options to directly download Historical Data or add them to the Queue and download later.

API STRINGS
The API Strings will be displayed below for all the historical data.
You can also copy the API Strings by using the “COPY API STRINGS” link on top for your ease

HELP
If you need any help regarding how to use API Strings, Click on the API Specifications link to know more about it.

Learn how to use API Builder
Use Next and Previous buttons to navigate and learn more about the features.

API Builder
You can enter the parameters and set a rule to get the data that you need.

ADD RULE
You can add multiple rules to extract data, click on Get Result to get the Data.

API QUERY STRING
On Clicking Get Result, you will be provided with the result and also the API String to get the result.
You can also copy the String using the “COPY API STRING” link on the top right.

EXPORT RESULT
You have the option to export data in different formats CSV, JSON and XML.

Learn about Download Queue
Use Next and Previous buttons to navigate and learn more about the features.

ADDING TO THE QUEUE
You can add historical datasets to the queue.
Click on the “Add to Queue” button to add the data that you need to the Queue.

NOTICE
After adding the data to the download queue, a notice pop-up window will be shown. You can undo the action or simply close it.

DOWNLOAD QUEUE
Once you add the data to the Queue, the Download Queue button on the top will show a red dot, you can click on it to view all the items that you have added in the queue.

IN THE DOWNLOAD QUEUE
You can see all historical datasets and resources that you have added previously and you can download them all together.

INFORMATION
The details of how many files and formats have been added are provided.

DELETE ITEMS
You can manage the download queue by deleting the items that are not required

Learn how to use Bookmarks function
Use Next and Previous buttons to navigate and learn more about the Bookmarks features.

Bookmark a dataset when searching datasets
When searching datasets, you can bookmark a dataset to the bookmark list by clicking the bookmark icon at the right-hand side of a dataset.

Bookmark a dataset when browsing datasets
When browsing datasets, you can bookmark a dataset to the bookmark list by clicking the bookmark icon at the right-hand side of the dataset title.

View bookmarked datasets
To view bookmarked datasets, click the “Bookmarks” menu item at the top menu bar or the “Bookmarks” icon of the floating menu located at the right-hand side of the web page.

Visit bookmarked datasets
To visit bookmarked datasets, clicks the hyperlink located below the dataset title of a dataset.

Export bookmarked datasets
To export bookmarked datasets as a CSV file, selects the datasets you would like to export and clicks the “Export Selected Bookmark(s)” button.

Remove bookmarked datasets
To remove bookmarked datasets, clicks the rubbish bin icon at the right-hand side of a bookmarked dataset.