Documentation for the General Bikeshare Feed Specification, a standardized data feed for shared mobility system availability.
Please note that GBFS is now hosted at github.com/MobilityData/gbfs.
- What is GBFS?
- How to Participate
- Current Version
- Guiding Principles
- Specification Versioning
- Systems Catalog - Systems Implementing GBFS
- GBFS JSON Schemas
- GBFS and Other Shared Mobility Resources
- Relationship Between GBFS and MDS
The General Bikeshare Feed Specification, known as GBFS, is the open data standard for shared mobility. GBFS makes real-time data feeds in a uniform format publicly available online, with an emphasis on findability. GBFS is intended to make information publicly available online; therefore information that is personally identifiable is not currently and will not become part of the core specification.
GBFS was created in 2014 by Mitch Vars with collaboration from public, private sector and non-profit shared mobility system owners and operators, application developers, and technology vendors. Michael Frumin, Jesse Chan-Norris and others made significant contributions of time and expertise toward the development of v1.0 on behalf of Motivate International LLC (now Lyft). The North American Bikeshare Association’s endorsement, support, and hosting was key to its success starting in 2015. In 2019, NABSA chose MobilityData to govern and facilitate the improvement of GBFS. MobilityData hosts a GBFS Resource Center and a public GBFS Slack channel - you are welcome to contact us there or at [email protected] with questions.
GBFS is intended as a specification for real-time, read-only data - any data being written back into individual shared mobility systems are excluded from this spec.
The specification has been designed with the following concepts in mind:
- Provide the status of the system at this moment
- Do not provide information whose primary purpose is historical
The data in the specification contained in this document is intended for consumption by clients intending to provide real-time (or semi-real-time) transit advice and is designed as such.
GBFS is an open source project developed under a consensus-based governance model. Contributors come from across the shared mobility industry, public sector, civic technology and elsewhere. GBFS is not owned by any one person or organization. The specification is not fixed or unchangeable. As the shared mobility industry evolves, it is expected that the specification will be extended by the GBFS community to include new features and capabilities over time.
Comments or questions can be addressed to the community by opening an issue. Proposals for changes or additions to the specification can be made through pull requests. Questions can also be addressed to the community via the public GBFS Slack channel or to the shared mobility staff at MobilityData: [email protected].
If you are new to engaging with the community on this repository, firstly welcome! Here is a brief overview of how to contribute to the specification:
- Anyone can raise an issue.
- Anyone can open a pull request - make sure PRs in line with our Guiding Principles.
- If you are wanting to open a pull request but don't know how, MobiilityData is happy to help. Get in touch at [email protected].
- Discussions on pull requests must be a minimum of 7 calendar days.
- Votes are open for a total of 10 calendar days, anyone can vote.
- A successful vote must have at least 3 votes, not including the pull request author.
- A successful vote must include a vote from a GBFS producer and a GBFS consumer.
Find a real-world example of the governance in action here. For a more in depth look at the change and contribution process, go to governance.md.
MobiltyData has compiled a project roadmap with a list of major features, changes and other work coming up in the near future.
| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|---|---|---|---|---|---|
| v3.0 | MAJOR | April 11, 2024 | ✅ Current Version | v3.0 Schema | v3.0 Article |
| Version | Type | Release Target | Status |
|---|---|---|---|
| No current upcoming major versions |
Release Candidates will receive Current Version status when they have been fully implemented in public feeds.
| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|---|---|---|---|---|---|
| v3.1-RC | MINOR | May 22, 2024 | ✅ Ready for implementation | v3.1-RC Schema | v3.1-RC Release Notes |
Past versions with Supported status MAY be patched to correct bugs or vulnerabilities but new features will not be introduced.
Past versions with Deprecated status will not be patched and their use SHOULD be discontinued.
| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|---|---|---|---|---|---|
| v2.3 | MINOR | April 5, 2022 | ✅ Supported | v2.3 Schema | v2.3 Release Notes |
| v2.2 | MINOR | March 19, 2021 | ✅ Supported | v2.2 Schema | v2.2 Article |
| v2.1 | MINOR | March 18, 2021 | ✅ Supported | v2.1 Schema | v2.1 Article |
| v2.0 | MAJOR | March 16, 2020 | ✅ Supported | v2.0 Schema | v2.0 Article |
| v1.1 | MINOR | March 16, 2020 | ❌ Deprecated | v1.1 Schema | |
| v1.0 | MAJOR | Prior to October 2019 | ❌ Deprecated | v1.0 Schema |
The complete GBFS version history is available in the Release Notes.
To enable the evolution of GBFS, including changes that would otherwise break backwards-compatibility with consuming applications, GBFS uses semantic versioning.
Semantic versions are established by a git tag in the form of vX.Y where X.Y is the version name. A whole integer increase is used for breaking changes (MAJOR changes). A decimal increase is used for non-breaking changes (MINOR changes or patches). MINOR versions may introduce new features as long as those changes are OPTIONAL and do not break backwards compatibility.
Examples of breaking changes include:
- Changes to requirements, like adding or removing a REQUIRED endpoint or field, or changing an OPTIONAL endpoint or field to REQUIRED.
- Changing the data type or semantics of an existing field.
Examples of non-breaking changes include:
- Adding an OPTIONAL endpoint or field
- Adding new enum values
- Modifying documentation or specification language in a way that clarifies semantics or recommended practices
- GBFS documentation will include a list of current and supported MAJOR and MINOR versions. Supported versions SHALL NOT span more than two MAJOR versions. Past versions that are beyond the two most recent MAJOR versions will be deprecated 180 days after the latest MAJOR version becomes official.
- See the Governance for Version Release Cycles.
To preserve the original vision of GBFS, the following guiding principles should be taken into consideration when proposing extensions to the spec:
-
GBFS is a specification for real-time or semi-real-time, read-only data. The spec is not intended for historical or archival data such as trip records. The spec is about public information intended for shared mobility users.
-
GBFS is targeted at providing transit information to the shared mobility end user. Its primary purpose is to power tools for riders that will make shared mobility more accessible to users. GBFS is about public information. Producers and owners of GBFS data should take licensing and discoverability into account when publishing GBFS feeds.
-
Changes to the spec should be backwards-compatible, when possible. Caution should be taken to avoid making changes to the spec that would render existing feeds invalid.
-
Speculative features are discouraged. Each new addition to the spec adds complexity. We want to avoid additions to the spec that do not provide additional value to the shared mobility end user.
There are hundreds of shared mobility systems publishing GBFS worldwide. This list contains all known systems publishing GBFS feeds and is maintained by the GBFS community. This is an incomplete list. If you have or are aware of a system that doesn’t appear on the list please add it.
If you would like to add a system, please fork this repository and submit a Pull Request. To open a Pull Request, please do the following:
- Create an account on GitHub if you do not already have one
- Fork this repository
- Create a new branch, and
- Propose your changes by opening a new pull request
Please keep this list alphabetized by country and system name. Alternatively, fill out this contribution form for a Github-less contribution.
| Field Name | REQUIRED | Definition |
|---|---|---|
| Country Code | REQUIRED | ISO 3166-1 alpha-2 code designating the country where the system is located. For a list of valid codes see here. |
| Name | REQUIRED | Name of the mobility system. This MUST match the name field in system_information.json |
| Location | REQUIRED | Primary city in which the system is located, followed by the 2-letter state code for US systems. The location name SHOULD be in English if the location has an English name (eg: Brussels). |
| System ID | REQUIRED | ID for the system. This MUST match the system_id field in system_information.json. |
| URL | REQUIRED | URL for the system from the url field in system_information.json. If the url field is not included in system_information.json this SHOULD be the primary URL for the system operator. |
| Auto-Discovery URL | REQUIRED | URL for the system's gbfs.json auto-discovery file. |
| Supported Versions | REQUIRED | List of GBFS version(s) under which the feed is published. Multiple values are separated by a semi-colon surrounded with 1 space on each side for readability (" ; "). |
| Authentication Info | Conditionally REQUIRED | If authentication is required, this MUST contain a URL to a human-readable page describing how the authentication should be performed and how credentials can be created, or directly contain the public key-value pair to append to the feed URLs. |
Complete JSON schemas for each version of GBFS can be found here.
Including APIs, datasets, validators, research, and software can be found here.
There are many similarities between GBFS and MDS (Mobility Data Specification), however, their intended use cases are different. GBFS is a real-time or near real-time specification for public data primarily intended to provide transit advice through consumer-facing applications. MDS is not public data and is intended for use only by mobility regulators. Publishing a public GBFS feed is a requirement of all MDS compatible Provider APIs.
The copyright for GBFS is held by the MobilityData.