Skip to main content

​
Overview

One URL opens a pre-filled route everywhere:
  • On iOS with the app installed, the link opens the planner in the app with the route filled in.
  • On Android with a recent version of the app installed, it does the same.
  • Everywhere else, including devices without the app, it opens the web planner.
No API key or account is needed, and the link works for riders who are not signed in. The parameters are the same query string documented on Embeds: the origin_* and dest_* trios, up to eight stopN_* stops, supersafe, nighttime, departure_time, parking, and operator. One difference from embeds: the origin is optional here. A link carrying only a destination starts the route from the rider’s current location. A link can also carry an origin named exactly Current location. The app then starts the route from the device’s live position and treats the link’s origin_lng and origin_lat as a placeholder, which lets you send a rider a ride from wherever they are while still drawing it from an approximate point elsewhere. In the web planner that origin asks the browser for the rider’s location.
That example routes the rider from wherever they are to the South Bank for a 22:30 departure, ending at a Forest e-bike bay with a short walk to the destination.

​
App scheme

To target the app directly, the same path and parameters work on the app scheme:
A scheme link never opens the web planner. On a device without the app it goes nowhere, so only use it where you handle that case yourself; the https://cyclemate.club/search form is the safe default.

​
Good to know

  • A waypoint travels as a trio: longitude, latitude, and a display name. A waypoint missing any of the three is ignored.
  • departure_time is a bare wall-clock string ("YYYY-MM-DDTHH:mm") in the route city’s timezone. Do not append a timezone offset or a Z.
  • Coordinates are read to 6 decimal places.
  • Links to https://cyclemate.club/search open in the app only once the rider’s device has picked up our latest link configuration, which happens automatically on install and update.
  • A link opened inside another app’s browser (an email client, a social app) loads the web planner even when our app is installed. The planner then offers Open in Cyclemate beneath the route summary, which hands the same route to the app.