GBFS feed
Every Herd network publishes a public GBFS feed. It is what Google Maps, Transit and other trip planners read to show your hubs and bikes. There is nothing to switch on.
- Version: GBFS 2.3
- Auth: none
- Discovery file:
/gbfs/{network}/gbfs.json - Each feed:
/gbfs/{network}/{feed}.json
A network that is hidden or disabled returns 404.
| Feed | Refresh (ttl) |
Contents |
|---|---|---|
system_information |
1 hour | Network name, and its website, phone and email when set |
vehicle_types |
1 hour | Two types: bike (human powered) and ebike (electric assist) |
station_information |
1 hour | One station per hub, with its area as a polygon. Capacity is included when known |
station_status |
1 minute | Bikes available at each hub, by vehicle type |
free_bike_status |
1 minute | Parked bikes available to rent, with position |
system_pricing_plans |
1 hour | The plans riders can currently buy |
system_alerts |
1 minute | The network’s current system message, if there is one |
geofencing_zones |
1 hour | No-ride, no-parking and designated-parking areas, and speed caps |
Things to know
Section titled “Things to know”- Only rentable bikes are counted. A bike that is offline, in the shop, being rebalanced or on
a ride does not appear in
station_statusorfree_bike_status. bike_idrotates. The id infree_bike_statuschanges after every trip, as the specification requires, so a bike cannot be followed from one ride to the next.- One language per network. The discovery file is keyed by the network’s default language.
- Caching. Every response carries
Cache-Control: public, max-age=<ttl>and the standard GBFS envelope (last_updated,ttl,version,data). Polling faster than thettlreturns the same data. - GBFS 3.x (
vehicle_status) is not published yet.
Listing your feed
Section titled “Listing your feed”To appear in trip planners, submit the discovery URL to the MobilityData systems catalog. Most consumers pick feeds up from there.