Wheels Router API¶

Wheels Router is a free, unlimited, provider-neutral public API service for multi-modal trip planning in Hong Kong.

Overview¶

Wheels Router uses the Wheels Router Engine, the same engine used by Wheels, to plan multi-modal trips across Hong Kong. It's the fastest routing API (as in routing speed) available, optimized for Hong Kong's public transportation network.

Supported Transport Modes¶

Powered by the Hong Kong Community GTFS, Wheels Router supports:

Light Rail
MTR
MTR Bus
Citybus
KMB
Green minibus
Major ferry routes
And all other means of transportation supported by the feed.
Ferry, Discovery Bay, and Park Island bus are planned.

API Endpoint¶

Engine:

https://engine.justusewheels.com/

Route shapes:

https://shapes.justusewheels.com/

Rate Limits¶

20 requests per 2 minutes

Need higher rate limits? Join our Discord and ask in the #router-api channel!

Client Requirements¶

PLEASE, PLEASE enable gzip if you're using a library like reqwest that by default doesn't handle Content-Encoding: gzip. Wheels Router Engine currently operates under limited funding thanks to my red pocket money, and enabling gzip helps saves bandwidth by a lot ^-^

Please provide a valid HTTP Referer or User-Agent identifying the application (stock User-Agents as set by http libraries will not do).

Use In Your App¶

Check out the API Reference to start making requests, it's completely free. We have an OTP competible Transmodel GraphQL API aswell alongside our own JSON api.

Commercial Usage¶

Wheels Router is free for commercial usage as long as your company is not exceeding $100k in yearly income. For commercial use enquiries or other questions, please contect me at anson [at] justusewheels [dot] com.

Support¶

Have questions or need help?

💬 Join our Discord: #router-api channel
🔓 Need rate limit whitelist? Ask in Discord!

Built with ❤️ by Wheels

Made and hosted in Hong Kong