bikeraccoonAPI

This is the source code for both the GBFS tracking app and API server hosted at api.raccoon.bike

GBFS Tracker

Many bike share systems worldwide provide real-time access to system information via the GBFS specification. For more information about GBFS, see the GBFS github repo. GBFS provides the number of bikes and docks at each station and the number of available floating bikes, but it does not provide trip information. By monitoring the number of available bikes in a system and tracking changes over time this tool estimates the number of trips in a system each hour. For a more detailed explanation of how a previous implementation of this tool works, see this blog post.

It's important to keep in mind that the trip counts infered by this tracker are estimates only and may vary substantially from official counts.

Bike Raccoon API

New in version 2.0

Change in API resonse

Improved handling of free_bikes feed

The original version queried both station_status.json and free_bikes.json and saved free bike trips by creating a "station" called "free_bikes". This does not accurately represent how GBFS feeds work in theory or practice. The station_status and free_bike feeds can be independant or overlapping in different situations.

Now we treat the station_status and free_bikes feeds independently and require the user to specify "station" or "free_bike" feed parameter the when querying system activity. We leave to the user to determine whether it's appropriate to combine both feeds when computing total trips in a system.

In GBFS v3.0 the free_bike_status.json feed is rename vehicle_status.json

Vehicle Types

We are now tracking vehicle types when available, in both station_status and free_bike_status feeds. Specify the vehicle parameter with the relevant vehicle_id to filter trips by vehicle type.

Vehicle types for each system can be accessed via the "vehicle" endpoint

Endpoints

To access the data collected by the tracker, we provide the following HTTP endpoints. All endpoints return JSON text.

• systems

  Returns a list of systems being tracked along with some system metadata.

  Example: https://api.raccoon.bike/systems

• stations

  Returns a list of stations for a given system along with station metadata.

  Parameters: system: the system name (as specified in the systems endpoint)

  Example: https://api.raccoon.bike/stations?system=bike_share_toronto

• vehicles

  Returns a list of vehicle types for a given system.

  Parameters: system: the system name (as specified in the systems endpoint)

  Example: https://api.raccoon.bike/stations?system=bike_share_toronto

• activity

  Returns trip activity data

  Parameters:

  • system: the system name (as specified in the systems endpoint)
  • feed: The source feed for the data, either "station" or "free_bike"
  • start: The starting datetime, format: YYYYMMDDHH
  • end: The ending datetime (inclusive), format: YYYYMMDDHH
  • frequency: The period in which to group the data. Options are 'h' (hours, default), 'd' (day), 'm' (month), 'y' (year).
  • station: The station ID of the station (as specified in the stations endpoint). If no station is provided (default), data for the whole system will be returned. If 'all' is provided, data for each station in the system will be returned.
• vehicle: the vehicle ID of the vehicle (as specified in the vehicles endpoint). If no vehicle is provided (default), data for the whole system will be returned. If 'all' is provided, data for each vehicle type in the system will be returned.

Example: https://api.raccoon.bike/activity?system=mobi_vancouver&start=2021012800&end=2021012900&frequency=m&station=0001

License

This software is licensed under the MIT license.

Data provided by the BikeRaccoonAPI is licensed under the Creative Commons BY 4.0 license. You are free to:

• Share — copy and redistribute the material in any medium or format
• Adapt — remix, transform, and build upon the material for any purpose, even commercially.

You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.