Overview
A Herd network exposes four integration surfaces. Pick by who is asking and what they need.
| Surface | Who it is for | Access | What it carries |
|---|---|---|---|
| GBFS feed | Trip planners, map apps, the public | Open, no key | Hubs, available bikes, pricing, zones |
| MDS Provider API | City and regulator data teams | API key you create | Vehicles, trips, trip events |
| REST API | Your own dashboards and tools | API key you create | Vehicles, hubs, completed rides |
| Webhooks | Your own systems that react to events | Endpoint you register | Ride started, ride ended, bike mode changes |
Addresses
Section titled “Addresses”Every path in this section is relative to your network’s API host. Herd gives you the host and
your network slug when your network is set up. The slug is the short lowercase name that
appears in feed URLs, written here as {network}.
What these surfaces do not do
Section titled “What these surfaces do not do”So you can plan around them:
- All four are read-only. Nothing here unlocks a bike, edits a rider or issues a refund.
- No surface carries rider identity. Rides are reported without names, emails or account ids.
- There is no CSV export over the API. The console’s Analytics page is where staff download data.
- There are no rate limits today. Please poll no faster than each feed’s
ttl; limits may be added later and will be announced here first.