hkopendata

## Intro This section will collect API published by organizations that are neither government department or banks. Currently, only API from Hongkong Post (香港郵政) is available. __UPDATE:__ Bus and rail information are available since v1.1.0. ## Hongkong Post (post) - `searchBox()` Street Box information - `searchPOBox()` PO Box information - `searchOffice()` Post Office information - `searchMobileOffice()` Mobile Post Office information - `searchStation()` iPostal Station information - `searchRate(params)` Postage Rate information __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-17]` | 0 | Type of information | 0 - Local Ordinary Mail 1 - Local Registered Mail 2 - Local Parcel 3 - Local Courier Post 4 - Local Smart Post 5 - Local Bulk Mail 6 - Local Bulk Periodicals Services 7 - Overseas Air/Surface Mail 8 - Overseas Air/Surface Registered Mail 9 - Overseas Surface Parcel 10 - Overseas Air Parcel 11 - Overseas Speedpost 12 - Overseas E-Express 13 - Overseas iMail Services 14 - Overseas Bulk Lightweight Air Mail 15 - Overseas Bulk Air Mail 16 - Overseas Bulk Periodicals Services 17 - Business Reply Services | ## Bus (bus) __IMPORTANT:__ Please be careful when specifying `params.route` and `params.stop`. Some search types require __ID__ while some require __NAME__ (eg. 1A, K51). - `searchCTB(params)` / `searchNWFB(params)` Bus information from Citybus (城巴) or New World First Bus (新巴) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-4]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Estimated Time Arrival 3 - Stop Info 4 - Company Info | | `params.route` | false | string | | Route | Route __NAME__. Required when `params.type` equals `1` or `2` | | `params.stop` | false | string | | Stop | Stop __ID__. Required when `params.type` equals `2` or `3` | | `params.dir` | false | number `[0-1]` | | Direction | 0 - Inbound 1 - Outbound Required when `params.type` equals `1` | - `searchNLB(params)` Bus information from New Lantao Bus (新大嶼山巴士) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-2]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Estimated Time Arrival | | `params.route` | false | string | | Route | Route __ID__. Required when `params.type` equals `1` or `2` | | `params.stop` | false | string | | Stop | Stop __ID__. Required when `params.type` equals `2` | - `searchMTR(params)` Bus information from LRT Feeder (港鐵巴士) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-2]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Fare 3 - Estimated Time Arrival (Currently no data available) | | `params.route` | false | string | | Route | Route __NAME__. Required when `params.type` equals `1`, `2` or `3` | - `searchKMB(params)` Bus information from Kowloon Bus (九巴) | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-5]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Stop Info 3 - ETA (specific stop of route) 4 - ETA (specific stop of all routes) 5 - ETA (all stops of specific route) | | `params.route` | false | string | | Route | Route __NAME__. Required when `params.type` equals `1`, `3` or `5` | | `params.service` | false | string | | Route Service Type | Required when `params.type` equals `1`, `3` or `5` | | `params.dir` | false | number `[0-1]` | | Direction | 0 - Inbound 1 - Outbound Required when `params.type` equals `1` | | `params.stop` | false | string | | Stop | Stop __ID__. Required when `params.type` equals `2`, `3` or `4` | - `searchGMB(params)` Bus information from Green Minibus (綠色專線小巴) | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-5]` | 0 | Type of information | 0 - Route Info 1 - Routes of Stop 2 - Stops of Route 3 - Stop Info 4 - ETA (specific stop of route) 5 - ETA (specific stop of all routes) | | `params.region` | false | string | | Region | 0 - Hong Kong Island 1 - Kowloon 2 - New Territories | | `params.route` | false | string | | Route | Route __NAME__. | | `params.routeId` | false | string | | Route | Route __ID__. | | `params.routeSeq` | false | string | | Route | Route __SEQUENCE__. | | `params.stop` | false | string | | Stop | Stop __ID__. | | `params.stopSeq` | false | string | | Stop | Stop __SEQUENCE__. | | Purpose | `params.type` | Requirement | | --- | --- | --- | | All route name in specific region | `0` | `params.region` | | Specific route info in specific region | `0` | Provide either set of data: 1. `params.region` and `params.route` 2. `params.routeId` | | All routes in specific stop | `1` | `params.stop` | | All stops in specific direction of route | `2` | `params.routeId` and `params.routeSeq` | | Stop Info | `3` | `params.stop` | | ETA of a specific stop of a specific direction of a route | `4` | `params.routeId`, `params.routeSeq` and `params.stopSeq` | | ETA of a specific stop of a __ALL__ directions of a route | `4` | `params.routeId` and `params.stop` | | ETA of a specific stop of a __ALL__ routes | `5` | `params.stop` | ## Rail (rail) __IMPORTANT:__ Please be careful when specifying `params.route` and `params.stop`. Some search types require __ID__ while some require __NAME/CODE__ (eg. WRL, 614P). - `searchIC()` Rail information from Intercity Train (城際直通車 - 廣九/滬九/京九) - `searchMTR(params)` Rail information from MTR Lines (地鐵/東鐵/西鐵) and Airport Express (機場快綫) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-4]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Estimated Time Arrival 3 - Fares of MTR lines 4 - Fares of Airport Express | | `params.route` | false | string | | Route | Route __CODE__. Required when `params.type` equals `1` or `2` | | `params.stop` | false | string | | Stop | Stop __CODE__. Required when `params.type` equals `2` | | `params.from` | false | string | | Origin Stop | Stop __ID__. Required when `params.type` equals `3` or `4` | | `params.to` | false | string | | Destination Stop | Stop __ID__. Required when `params.type` equals `3` or `4` | | `params.dir` | false | number `[0-3]` | 0 | Direction | 0 - Down 1 - UP 2 - Down (branch) 3 - Up (branch) Accepted when `params.type` equals `0`, `1` or `2`. Value `2` and `3` only applicable to East Rail Line (LoK Ma Chau) and Tseung Kwan O Line (LOHAS Park) | | `params.lang` | false | string (`en`/`tc`) | en | Language of the result | Only applicable when `params.type` is `2` and an error message exists | - `searchLRT(params)` Rail information from LRT Lines (輕鐵) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-2]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Fares 3 - Estimated Time Arrival | | `params.route` | false | string | | Route | Route __NAME__. Required when `params.type` equals `1` | | `params.from` | false | string | | Origin Stop | Stop __ID__. Required when `params.type` equals `2` | | `params.to` | false | string | | Destination Stop | Stop __ID__. Required when `params.type` equals `2` | | `params.dir` | false | number `[0-1]` | 0 | Direction | 0 - Down 1 - UP 2 - Down (branch) 3 - Up (branch) Accepted when `params.type` equals `0` or `1` | | `params.stop` | false | string | | Stop | Stop __ID__. Required when `params.type` equals `3` | - `searchTram(params)` Rail information from Tramways (電車) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-1]` | 0 | Type of information | 0 - Route Info 1 - Stops of All Route | | `params.route` | false | string | | Route | Route __NAME__. Accepted when `params.type` equals `0` | | `params.stop` | false | string | | Stop | Stop __CODE__. Accepted when `params.type` equals `1` | | `params.dir` | false | number `[0-1]` | 0 | Direction | 0 - Eastbound 1 - Westbound Accepted when `params.type` equals `1` | | `params.lang` | false | string (`en`/`tc`/`sc`) | en | Language of the result | | ## Ferry (ferry) __IMPORTANT:__ Some methods rely on the data in `/downloads/hk-ferry.json`. It is recommended to download the file and place it to `/data`. - `searchSF(params)` Ferry information from Star Ferry (天星小輪) __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-2]` | 0 | Type of information | 0 - Route Info 1 - Timetable 2 - Fare | | `params.route` | true | number `[0-1]` | 0 | Route | 0 - Central to Tsim Sha Tsui 1 - Wan Chai to Tsim Sha Tsui | | `params.dir` | false | number `[0-1]` | 0 | Direction | 0 - Inbound 1 - Outbound | | `params.lang` | false | string (`en`/`tc`/`sc`) | en | Language of the result | | - `searchCB(params)` Ferry information of cross border ferry __IMPORTANT:__ This method uses data in `/downloads/hk-ferry.json`. It is not compulsory but recommended to download the file. __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.dir` | false | number `[0-1]` | 0 | Direction | 0 - Arrival 1 - Departure | | `params.lang` | false | string (`en`/`tc`/`sc`) | en | Language of the result | | - `searchLF(params)` Ferry information of local licensed ferry __IMPORTANT:__ This method uses data in `/downloads/hk-ferry.json`. It is __COMPULSORY__ to download the file. It would __NOT__ function if the file does not exist. __IMPORTANT:__ The route information does not update automatically as it is copied from the source documentation PDF. Make a pull request or notify me to update if anything has changed. __Parameters__ | Name | Required | Accepted | Default | Description | Remarks | | --- | --- | --- | --- | --- | --- | | `params.type` | true | number `[0-4]` | 0 | Type of information | 0 - Route Info 1 - Stops of Route 2 - Timetable 3 - Fare 4 - ETA[^1] | | `params.route` | true | number `[0-23]` | 0 | Route | 0 - Central to Sok Kwu Wan 1 - Central to Yung Shue Wan 2 - Central to Peng Chau 3 - Central to Mui Wo 4 - Peng Chau to Cheung Chau 5 - Central to Cheung Chau 6 - Central to Discovery Bay 7 - Ma Wan to Central 8 - Ma Wan to Tsuen Wan 9 - North Point to Hung Hom 10 - North Point to Kowloon City 11 - North Point to Kwun Tong 12 - Sai Wan Ho to Kwun Tong 13 - Sai Wan Ho to Sam Ka Tsuen 14 - Discovery Bay to Mui Wo 15 - Tuen Mun to Tai O 16 - Aberdeen to Sok Kwu Wan 17 - Aberdeen to Yung Shue Wan 18 - Central to Hung Hom 19 - Ma Liu Shui to Tap Mun 20 - Ma Liu Shui to Tung Ping Chau 21 - Tap Mun to Wong Shek 22 - Kwun Tong to Mui Wo[^2] 23 - North Point to Kwun Tong[^2] 24 - Water Taxi[^1] | | `params.lang` | false | string (`en`/`tc`/`sc`) | en | Language of the result | | | `params.section` | false | number | | Specific section of the route | Only work with `ETA`. Find the full section list [here](#section-list). | ##### Section List | Route | Route Name | Sections | | --- | --- | --- | | `0` | Central to Sok Kwu Wan | 0 - Central to Sok Kwu Wan 1 - Sok Kwu Wan to Central | `1` | Central to Yung Shue Wan | 0 - Central to Yung Shue Wan 1 - Yung Shue Wan to Central | `2` | Central to Peng Chau | 0 - Central to Peng Chau 1 - Peng Chau to Central 2 - Peng Chau to Hei Ling Chau 3 - Hei Ling Chau to Peng Chau | `3` | Central to Mui Wo | 0 - Central to Mui Wo 1 - Mui Wo to Central | `4` | Peng Chau to Cheung Chau | 0 - Peng Chau to Mui Wo 1 - Mui Wo to Peng Chau 2 - Mui Wo to Chi Ma Wan 3 - Chi Ma Wan to Mui Wo 4 - Chi Ma Wan to Cheung Chau 5 - Cheung Chau to Chi Ma Wan 6 - Cheung Chau to Mui Wo 7 - Mui Wo to Cheung Chau | `5` | Central to Cheung Chau | 0 - Central to Cheung Chau 1 - Cheung Chau to Central | `9` | North Point to Hung Hom | 0 - North Point to Hung Hom 1 - Hung Hom to North Point | `10` | North Point to Kowloon City | 0 - North Point to Kowloon City 1 - Kowloon City to North Point | `11` | North Point to Kwun Tong | 0 - North Point to Kwun Tong 1 - Kwun Tong to North Point 2 - Kwun Tong to Kai Tak 3 - Kai Tak to Kwun Tong | `15` | Tuen Mun to Tai O | 0 - Tuen Mun to Tung Chung 1 - Tung Chung to Tuen Mun 2 - Tuen Mun to Sha Lo Wan 3 - Sha Lo Wan to Tuen Mun 4 - Tung Chung to Sha Lo Wan 5 - Sha Lo Wan to Tung Chung 6 - Tung Chung to Tai O 7 - Tai O to Tung Chung 8 - Sha Lo Wan to Tai O 9 - Tai O to Sha Lo Wan 10 - Tuen Mun to Tai O 11 - Tai O to Tuen Mun | `18` | Central to Hung Hom | 0 - Central to Hung Hom 1 - Hung Hom to Central | `24` | Water Taxi | 0 - Whole Trip [^1]: Available since `v1.7.0`. [^2]: For Dangerous Goods Vehicles.