brightness_auto brightness_4 brightness_5

Easter Bunny Tracker - URL Arguments Documentation

Last updated: June 24, 2020


Note: The URL arguments feature has been removed from Version 5 of track.easterbunny.cc in an effort to streamline the codebase of the tracker, and remove feature bloat. We encourage you to set up the tracker settings from the settings window of the tracker.

We will be implementing a new default zoom level feature in Version 5 of track.easterbunny.cc, if you did use the zl argument from URL arguments.

It is possible that URL arguments may return in a future version of track.easterbunny.cc. If you are affected by the removal of URL arguments, you can contact us for your feedback.

For archival purposes, and given that Version 4.5.4 will stay up until early 2021, the original contents of this page are being preserved.


track.easterbunny.cc Version 4.5.0 includes a new feature to pass URL arguments to manipulate settings of the tracker along with the zoom level. We implemented this feature to make it easier to stream the tracker in environments where direct interaction with the tracker isn't possible, and for advanced users.

In this document, we're using arguments/value terminology. If you've ever heard of URL parameters, or a URL query string, this is the same thing.

URL arguments are a string of argument and value pairs trailing a URL. To start defining URL arguments, the ? character is used following the URL. After this, you start defining arguments and values, separating them with the = character and without any spaces. For instance, if you wanted to pass the argument "foo" with value "bar" to our main page, you would input this as the URL:

https://track.easterbunny.cc/?foo=bar

If you want to pass more than one argument/value pair, you can use the & symbol to indicate the end of one argument/value pair, and the start of another one. For instance, if I wanted to pass the foo/bar pair from above, and another argument "eggs" with value "ham", you would join the two with the & symbol mentioned earlier. Here's how this would look.

https://track.easterbunny.cc/?foo=bar&eggs=ham

URL arguments can only be passed on track.easterbunny.cc/, and track.easterbunny.cc/countdown/. Pages such as this one, the FAQs, etc. don't accept URL arguments, and won't change tracker settings if they do receive arguments. Arguments passed to the countdown page are passed to the main page when a redirection occurs (such as when tracking starts), and vice versa in the other direction (such as hitting the main page but tracking hasn't started). If you define the same argmuent twice, the value that is closest to the ? symbol will be used.

The available arguments are as follows.
reset - Controls resetting tracker settings
This argument can take on two values for controlling how the tracker settings are reset.
- default (?reset=default or &reset=default) to change the tracker settings to default settings
- stream (?reset=stream or &reset=stream) to change the tracker settings to optimal livestreaming settings

When passing the reset argument, all other arguments will be ignored. If you want to change settings after passing the reset argument, you'll need to load the page again with those arguments.

Once the settings reset has taken place, in most cases, all arguments will be removed from the URL. However, if the tracker cannot automatically remove all arguments after the reset, make sure you remove the argument yourself.
zl - Controls zoom level & default zoom level of the map
This argument can take on an integer between 0 and 20, plus the ! symbol to indicate a partial zoom override. For instance,
- 4 (?zl=4 or &zl=4) will set the tracker on load and default zoom level to 4 (full override).
- 9 (?zl=9 or &zl=9) will set the tracker on load and default zoom level to 9 (full override).
- 4! (?zl=4! or &zl=4!) will set only the tracker on load zoom level to 4 (partial override).
- 9! (?zl=9! or &zl=9!) will set only the tracker on load zoom level to 9 (partial override).
For the zoom levels to be affected, this argument must always be present.

A full override means that when the tracker is loaded (or transitions from pre-tracking to tracking), it will zoom to the zoom level indicated in the argument. Additionally, if you recenter the map on the Easter Bunny, the tracker will use the zoom level you provided to set the zoom level when the recenter occurs.

A partial override means that when the tracker is loaded (or transitions from pre-tracking to tracking), it will zoom to the zoom level indicated in the argument. However, if you recenter the map on the Easter Bunny, the tracker will zoom to either zoom level 5 on a mobile device, and zoom level 6 on all other devices.

A lower zoom level means that the map will be more zoomed out. A higher zoom level means that the map will be more zoomed in. As according to Google, this list shows the approximate level of detail to expect at different zoom levels:
  • 1: World
  • 5: Landmass/continent
  • 10: City
  • 15: Streets
  • 20: Buildings
If you need to figure out what zoom level you'd like to use, you can measure the clicks in and out when using the zoom keys on the bottom right of the tracker. On mobile devices, start at 5 for the zoom level, and 6 for all other devices. As you zoom in, add to the number by 1. As you zoom out, subtract from the number by 1.
appearance - Controls the appearance of the tracker
This argument can take on three values corresponding to the appearance of the tracker.
- automatic (?appearance=automatic or &appearance=automatic) will set the tracker appearance to automatic, which is determined by your device's appearance settings.
- light (?appearance=light or &appearance=light) will set the tracker appearance to light mode.
- dark (?appearance=dark or &appearance=dark) will set the tracker appearance to dark mode.

When streaming the tracker, it's best to set this argument to a specific appearance mode (light or dark). This is so if your device goes in and out of light/dark mode automatically (on a timer or with the sunrise/sunset), the appearance of the tracker doesn't change with that when streaming.
ebarrival - Controls visibility of the Easter Bunny arrival time estimate
This argument can take on two values to turn this feature on/off.
- on (?ebarrival=on or &ebarrival=on) will show the Easter Bunny arrival time estimate in the Next Stop box.
- off (?ebarrival=off or &ebarrival=off) will hide the Easter Bunny arrival time estimate in the Next Stop box.

When streaming the tracker, it's best to set this argument to off, as to not reveal your location.
mapmode - Controls the map mode of the tracker
This argument can take on three values to change the different map modes of the tracker.
- street (?mapmode=street or &mapmode=street) will change the tracker map mode to street mode.
- satellite (?mapmode=satellite or &mapmode=satellite) will change the tracker map mode to satellite mode.
- hybrid (?mapmode=hybrid or &mapmode=hybrid) will change the tracker map mode to hybrid mode.
ebbounce - Controls the Easter Bunny bouncing effect
This argument can take on two values to turn this feature on/off.
- on (?ebbounce=on or &ebbounce=on) will turn the bouncing effect on.
- off (?ebbounce=off or &ebbounce=off) will turn the bouncing effect off.

When streaming the tracker, you may want to consider setting this argument to off, as some viewers may get distracted by the bouncing effect.
wssi - Controls visibility of the weather summary in the stop information window
This argument can take on two values to turn this feature on/off.
- on (?wssi=on or &wssi=on) will show the weather summary in the stop information window.
- off (?wssi=off or &wssi=off) will hide the weather summary in the stop information window.


Questions?

If you have any questions about how the URL arguments feature works, we're here to help you! We understand that it can be a bit confusing!

You can tweet us (@bunny_tracking) if you have any questions. If you don't use Twitter, you can also email us: support (at) easterbunny (dot) cc


Follow us on Twitter (@bunny_tracking)
Follow the Easter Bunny's journey on Twitter (@bunny_updates)
Return to the tracker