Skip to content

Latest commit

 

History

History
198 lines (115 loc) · 18.6 KB

README.md

File metadata and controls

198 lines (115 loc) · 18.6 KB

Mobility Data Specification

Table of Contents

About

The Mobility Data Specification (MDS), a project of the Open Mobility Foundation (OMF), is a set of Application Programming Interfaces (APIs) focused on dockless e-scooters, bicycles, mopeds and carshare. Inspired by projects like GTFS and GBFS, the goals of MDS are to provide a standardized way for municipalities or other regulatory agencies to ingest, compare and analyze data from mobility service providers, and to give municipalities the ability to express regulation in machine-readable formats.

MDS helps cities interact with companies who operate dockless scooters, bicycles, mopeds and carshare in the public right-of-way. MDS is a key piece of digital infrastructure that supports the effective implementation of mobility policies in cities around the world. For a high level overview, see the About MDS page on the OMF website.

MDS Main Logo

MDS is an open-source project. It was originally created by the Los Angeles Department of Transportation (LADOT). In November 2019, stewardship of MDS and the ownership of this repository were transferred to the Open Mobility Foundation. GitHub automatically redirects any links to this repository in the CityOfLosAngeles organization to the openmobilityfoundation instead. MDS continues to be used by LADOT and many other municipalities.

Top

Endpoints

MDS is comprised of six distinct APIs, with multiple endpoints under each API:

MDS Provider Icon

The provider API endpoints are intended to be implemented by mobility providers and consumed by regulatory agencies. When a municipality queries information from a mobility provider, the Provider API has a historical view of operations in a standard format. It was first released in June 2018.


MDS Agency Icon

The agency API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Agency API when events (such as a trip start or vehicle status change) occur in their systems. It was first released in April 2019.


MDS Policy Icon

The policy API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about local rules that may affect the operation of their mobility service or which may be used to determine compliance. It was first released in October 2019.


MDS Geography Icon

The geography API endpoints are intended to be implemented by regulatory agencies and consumed by mobility providers. Providers query the Policy API to get information about geographical regions for regulatory and other purposes. It was first released in October 2019, originally included as part of the Policy specification.


MDS Jurisdiction Icon

The jurisdiction API endpoints are intended to be implemented by regulatory agencies that have a need to coordinate with each other. The jurisdiction endpoints allow cities to communicate boundaries between one another and to mobility providers. It was first released in March 2021.


MDS Metrics Icon

The metrics API endpoints are intended to be implemented by regulatory agencies or their appointed third-party representatives to have a standard way to consistently describe available metrics, and create an extensible interface for querying MDS metrics. It was first released in March 2021.


Modularity

MDS is designed to be a modular kit-of-parts. Regulatory agencies can use the components of the API that are appropriate for their needs. An agency may choose to use only agency, provider, or policy. Other APIs like geography, jurisdiction, and metrics can be used in coordination as described with these APIs or sometimes on their own. Or agencies may select specific elements (endpoints) from each API to help them implement their goals. Development of the APIs takes place under the guidance of either the OMF's City Services or Provider Services Working Groups.

Many parts of the MDS definitions and APIs align across each other. In these cases, consolidated information can be found on the General Information page.

You can read more in our Understanding the different MDS APIs guide.

MDS APIs and Endpoints

GBFS Requirement

All MDS compatible Provider feeds must also expose a public GBFS feed. Compatibility with GBFS 2.0 or greater is advised due to privacy concerns and support for micromobility. See our MDS Vehicles Guide for how MDS Provider /vehicles can be used by regulators instead of the public GBFS /free_bike_status. Additional information on MDS and GBFS can be found in this guidance document.

Top

Get Involved

To stay up to date on MDS releases, meetings, and events, please subscribe to the mds-announce mailing list and read our Community Wiki.

The Mobility Data Specification is an open source project with all development taking place on GitHub. Comments and ideas can be shared by starting a discussion, creating an issue, and specific changes can be suggested by opening a pull request. Before contributing, please review our OMF CONTRIBUTING page and our CODE OF CONDUCT page to understand guidelines and policies for participation .

You can learn more about the polices, methodologies, and tools in the MDS ecosystem in the Mobility Data Management State of Practice wiki. To help cities put the right privacy policies in place, the OMF Privacy, Security, and Transparency Committee has created a comprehensive best-practices document called the MDS Privacy Guide for Cities.

You can also get involved in development by joining an OMF working group. The working groups maintain the OMF GitHub repositories and work through issues and pull requests. Each working group has its own mailing list for non-technical discussion and planning:

Working Group Mailing List Description
Provider Services mds-provider-services Manages the provider API within MDS.
City Services mds-city-services Manages the agency, policy, geography, jurisdiction, and metrics APIs within MDS, as well as the mds-core and mds-compliance-mobile reference implementations.

You can view info about current and past releases, the public OMF calendar, and review planning calls in the wiki.

For questions about MDS please contact by email at info@openmobilityfoundation.org or on our website. Media inquiries to media@openmobilityfoundation.org.

Membership

OMF Members (public agencies and commercial companies) have additional participation opportunities with leadership roles on our Board of Directors, Privacy, Security, and Transparency Committee, Technology Council, and Strategy Committee, as well as the steering committees of all Working Groups.

Read about how to become an OMF member and contact us for more details.

Top

Versions

MDS has a current release (version 1.1.0), previous releases (both recommended and longer recommended for use), and upcoming releases in development. For a full list of releases, their status, recommended versions, and timelines, see the Official MDS Releases page.

The OMF provides guidance on upgrading for cities, providers, and software companies, and sample permit language for cities. See our MDS Version Guidance for best practices on how and when to upgrade MDS as new versions become available. Our complimentary MDS Policy Language Guidance document is for cities writing MDS into their operating policy and includes sample policy language.

Technical Information

The latest MDS release is in the main branch, and development for the next release occurs in the dev branch.

The MDS specification is versioned using Git tags and semantic versioning. See prior releases and the Release Guidelines for more information and version support.

Top

Cities Using MDS

More than 115 cities and public agencies around the world use MDS, and it has been implemented by most major mobility service providers.

Please let us know via our website or in the public discussion area if you are an agency using MDS so we can add you to the city resource list, especially if you have published your policies or documents publicly.

To add yourself to the agency list and add your Policy Requirement link, please let us know via our website or open an Issue or Pull Request.

Top

Providers Using MDS

Over two dozen mobility service providers (MSPs) around the world use MDS, allowing them to create tools around a single data standard for multiple cities.

To add yourself to the provider list, please let us know via our website or open an Issue or Pull Request.

Top

Software Companies Using MDS

An open source approach to data specifications benefits cities and companies by creating a space for collaborative development, reducing costs, and nurturing a healthy, competitive ecosystem for mobility services and software tools. The open model promotes a competitive ecosystem for software tools built by dozens of software companies providing their services to cities, agencies, and providers.

Please let us know if you are using MDS in your company so we can add you to the list.

Top

Use Cases

How cities use MDS depends on a variety of factors: their transportation goals, existing services and infrastructure, and the unique needs of their communities. Cities are using MDS to create policy, enforce rules, manage hundreds of devices, and ensure the safe operation of vehicles in the public right of way. Some examples of how cities are using MDS in practice are:

  • Vehicle Caps: Determine total number of vehicles per operator in the right of way
  • Distribution Requirements: Ensure vehicles are distributed according to equity requirements
  • Injury Investigation: Investigate injuries and collisions with other objects and cars to determine roadway accident causes
  • Restricted Area Rides: Find locations where vehicles are operating or passing through restricted areas
  • Resident Complaints: Investigate and validate complaints from residents about operations, parking, riding, speed, etc, usually reported through 311
  • Infrastructure Planning: Determine where to place new bike/scooter lanes and drop zones based on usage and demand, start and end points, and trips taken

A list of use cases is useful to show what's possible with MDS, to list what other cities are accomplishing with the data, to see many use cases up front for privacy considerations, and to use for policy discussions and policy language. More details and examples can be seen on the OMF website and our Wiki Database.

Please let us know if you have recommended updates or use cases to add.

Top

Related Projects

Community projects are those efforts by individual contributors or informal groups that take place outside Open Mobility Foundation’s formalized process, complementing MDS. These related projects often push new ideas forward through experimental or locally-focused development, and are an important part of a thriving open source community. Some of these projects may eventually be contributed to and managed by the Open Mobility Foundation.

The OMF's Communitiy Projects page has an every growing list of projects related to MDS, and see our Privacy Committee's State of Practice for more examples.

Please let us know if you create open source or private tools for implementing or working with MDS data.

Top