All
 
What is the HKTVmall Open Databank?
  • HKTVmall Open Databank is an open data platform to disseminate various types of eCommerce data with free access for both commercial and non-commercial purposes subject to the Terms and Conditions of Use as published on HKTVmall Open Databank. We encourage users to understand more about consumer behavior through available data.
Why HKTVmall Open Databank?
  • HKTVmall is the largest online shopping mall in Hong Kong, providing a “one-stop shop” platform to the consumers, retailers and suppliers in Hong Kong, including online shopping marketplace, logistics & delivery services, O2O physical concept stores and impressive customer experience. We believe that leveraging HKTVmall’s 360 customer view facilitates technology development for the benefit of Hong Kong’s digitalization.
What is the scope of HKTVmall Open Databank?
  • HKTVmall sales and traffic data (without personal information) will be released for the period of past 13 months to encourage technology development of more applications and promote partnership opportunities. We will also aim to make more datasets, for example, logistic and warehouse inventory data available on HKTVmall Open Databank in the future.
What can I do with the Data shared in the HKTVmall Open Databank?
  • On HKTVmall Open Databank, all datasets are provided in digital formats including CSV and API connector. We encourage more innovations through maximizing the use of data about online shopping customers in Hong Kong. Except the re-sale of data, there is no restriction on the uses of the data as long as the users comply with the respective Terms and Conditions of Use of HKTVmall Open Databank as well as laws and regulations.
Do I need to pay a fee for using the HKTVmall Open Databank?
  • HKTVmall will not charge any fee for commercial or non-commercial use of data on HKTVmall Open Databank.
What are the key functionalities of the HKTVmall Open Databank?
  • Application Programming Interface (API) – query data via API to your storage platform
  • Download Data - access data if you prefer an easier way to analyse data that we have consolidated to be easy and user friendly to read
  • Timeframe Filter – select a specific set of data according to your desired date period for API
  • Category Selection – select a specific type of data according to your desired category
  • Power BI - conduct further analysis and gain visualisation of your data using this business intelligence platform (merchants only)
  • Seamless Integration with Merchant platform - quickly access between the Open Databank and MMS portal whenever (merchants only)
  • Stores Filter - have the option to analyse a specific store of your data (merchants only)
If I am a public user, how can I register for a new account?
  • In order to download data from HKTVmall Open Databank, you have to register for a new account. On the registration page, create an account with your email address and password and provide all required information. Once you have completed the registration process, you will receive a confirmation email where you will be asked to verify your email address. Our system administrator will then approve your registration when you can begin downloading data from HKTVmall Open Databank.
If I am a HKTVmall merchant, how can I register for a new account?
  • Merchants with existing MMS accounts can simply login to your MMS account where you can directly navigate to HKTVmall Open Databank for registration. Once you have completed the registration process, you will receive a confirmation email where you will be asked to verify your email address. If your application is approved by our system administrator, you can begin downloading data from HKTVmall Open Databank.
I registered for a new account but got rejected, what should I do?
  • There are multiple reasons for the disapproval of your account registration; You should refer to the email that was sent to your email address for details; Should there be any other concerns, please email databank@hktv.com.hk and we will get back to you as soon as possible.
Can I share my account with other users?
  • Account sharing shall not be permitted, system administrators have the right to revoke user access if any suspicious activity is detected; All users shall be required to register for an account and login to their approved accounts if you want to access the data on HKTVmall Open Databank.
What kind of data is available?
  • Data will be available from both our database and Google Analytics. The main categories of HKTVmall data available are:
  • Address
  • Product Category
  • Product Comments
  • Price Promotions
  • Marketing (Promotion Coupon ● Unique Code)
  • Marketing (Promotion Coupon ● Common Code)
  • Marketing (Paid Voucher)
  • Memberships
  • Subscription
  • Payment
  • HKTV Mall Dollars
  • Product
  • Transactions
  • Wishlist
  • Refund, Return, Replacement
  • Shared Shopping Carts
  • Delivery Rating
  • Online Stores
  • O2O Stores
  • User
  • Sale
  • Website & App Traffic ( Event )
  • Website & App Traffic ( Promotion )
  • Website & App Traffic ( Product )
  • Website & App Traffic ( Product List )
  • Website & App Traffic ( Page & screenview )
  • For the specific content in each data category, please refer to the data dictionary on API or Download Page of each category. The accessibility to different types of data may differ depending on whether you are a public user or merchant.
How do I download the data from HKTVmall Open Databank?
  • The download button should be available on the top right corner of the page after you choose CSV format in the filter menu.
How do I select the specific timeframe of data I want?
  • Click the filter icon on the left menu and select the specific date of data you want. You need to provide the start date and end date of your desired timeframe.
How do I select the category of data I want?
  • Click the filter icon on the left menu and select the category of data you want.
How does API subscription work?
  • Utilise the token that can be generated from your account to call for API. Note that only logged-in users will be allowed to call for API. Depending on the tool you use, you will be required to utilise the endpoint URL and input the parameters. Eventually, you can integrate the results with your selected application.
Will I be notified of updates?
  • You can find the latest updates in the notice board on the Home Page of HKTVmall Open Databank platform.
Why are some data not available?
  • There is a possibility that the data you have requested for is unavailable due to an update in the data schema. For instance, if new attributes were added to a table, there is a possibility that you will see empty data tables for the time period before the schema was updated. For CSV files, please note that old data files will not be regenerated.
Are there more recently available data on HKTVmall Open Databank?
  • No. The data listed in HKTVmall Open Databank are usually the most recent available.
General
 
What is the HKTVmall Open Databank?
  • HKTVmall Open Databank is an open data platform to disseminate various types of eCommerce data with free access for both commercial and non-commercial purposes subject to the Terms and Conditions of Use as published on HKTVmall Open Databank. We encourage users to understand more about consumer behavior through available data.
Why HKTVmall Open Databank?
  • HKTVmall is the largest online shopping mall in Hong Kong, providing a “one-stop shop” platform to the consumers, retailers and suppliers in Hong Kong, including online shopping marketplace, logistics & delivery services, O2O physical concept stores and impressive customer experience. We believe that leveraging HKTVmall’s 360 customer view facilitates technology development for the benefit of Hong Kong’s digitalization.
What is the scope of HKTVmall Open Databank?
  • HKTVmall sales and traffic data (without personal information) will be released for the period of past 13 months to encourage technology development of more applications and promote partnership opportunities. We will also aim to make more datasets, for example, logistic and warehouse inventory data available on HKTVmall Open Databank in the future.
What can I do with the Data shared in the HKTVmall Open Databank?
  • On HKTVmall Open Databank, all datasets are provided in digital formats including CSV and API connector. We encourage more innovations through maximizing the use of data about online shopping customers in Hong Kong. Except the re-sale of data, there is no restriction on the uses of the data as long as the users comply with the respective Terms and Conditions of Use of HKTVmall Open Databank as well as laws and regulations.
Do I need to pay a fee for using the HKTVmall Open Databank?
  • HKTVmall will not charge any fee for commercial or non-commercial use of data on HKTVmall Open Databank.
What are the key functionalities of the HKTVmall Open Databank?
  • Application Programming Interface (API) – query data via API to your storage platform
  • Download Data - access data if you prefer an easier way to analyse data that we have consolidated to be easy and user friendly to read
  • Timeframe Filter – select a specific set of data according to your desired date period for API
  • Category Selection – select a specific type of data according to your desired category
  • Power BI - conduct further analysis and gain visualisation of your data using this business intelligence platform (merchants only)
  • Seamless Integration with Merchant platform - quickly access between the databank and MMS portal whenever (merchants only)
  • Stores Filter - have the option to analyse a specific store of your data (merchants only)
Account
 
If I am a public user, how can I register for a new account?
  • In order to download data from HKTVmall Open Databank, you have to register for a new account. On the registration page, create an account with your email address and password and provide all required information. Once you have completed the registration process, you will receive a confirmation email where you will be asked to verify your email address. Our system administrator will then approve your registration when you can begin downloading data from HKTVmall Open Databank.
If I am a HKTVmall merchant, how can I register for a new account?
  • Merchants with existing MMS accounts can simply login to your MMS account where you can directly navigate to HKTVmall Open Databank for registration. Once you have completed the registration process, you will receive a confirmation email where you will be asked to verify your email address. If your application is approved by our system administrator, you can begin downloading data from HKTVmall Open Databank.
I registered for a new account but got rejected, what should I do?
  • There are multiple reasons for the disapproval of your account registration; You should refer to the email that was sent to your email address for details; Should there be any other concerns, please email databank@hktv.com.hk and we will get back to you as soon as possible.
Can I share my account with other users?
  • Account sharing shall not be permitted, system administrators have the right to revoke user access if any suspicious activity is detected; All users shall be required to register for an account and login to their approved accounts if you want to access the data on HKTVmall Open Databank.
About HKTVmall Open Databank
 
What kind of data is available?
  • Data will be available from both our database and Google Analytics. The main categories of HKTVmall data available are:
  • Address
  • Product Category
  • Product Comments
  • Price Promotions
  • Marketing (Promotion Coupon ● Unique Code)
  • Marketing (Promotion Coupon ● Common Code)
  • Marketing (Paid Voucher)
  • Memberships
  • Subscription
  • Payment
  • HKTV Mall Dollars
  • Product
  • Transactions
  • Wishlist
  • Refund, Return, Replacement
  • Shared Shopping Carts
  • Delivery Rating
  • Online Stores
  • O2O Stores
  • User
  • Sale
  • Website & App Traffic ( Event )
  • Website & App Traffic ( Promotion )
  • Website & App Traffic ( Product )
  • Website & App Traffic ( Product List )
  • Website & App Traffic ( Page & screenview )
  • For the specific content in each data category, please refer to the data dictionary on API or Download Page of each category. The accessibility to different types of data may differ depending on whether you are a public user or merchant.
How do I download the data from HKTVmall Open Databank?
  • The download button should be available on the top right corner of the page after you choose CSV format in the filter menu.
How do I select the specific timeframe of data I want?
  • Click the filter icon on the left menu and select the specific date of data you want. You need to provide the start date and end date of your desired timeframe.
How do I select the category of data I want?
  • Click the filter icon on the left menu and select the category of data you want.
How does API subscription work?
  • Utilise the token that can be generated from your account to call for API. Note that only logged-in users will be allowed to call for API. Depending on the tool you use, you will be required to utilise the endpoint URL and input the parameters. Eventually, you can integrate the results with your selected application.
Data Updates
 
Will I be notified of updates?
  • You can find the latest updates in the notice board on the Home Page of HKTVmall Open Databank platform.
Why are some data not available?
  • There is a possibility that the data you have requested for is unavailable due to an update in the data schema. For instance, if new attributes were added to a table, there is a possibility that you will see empty data tables for the time period before the schema was updated. For CSV files, please note that old data files will not be regenerated.
Are there more recently available data on HKTVmall Open Databank?
  • No. The data listed in HKTVmall Open Databank are usually the most recent available.