Adding an MDS Provider ID
MDS uses Provider IDs through the spec to designate specific providers in a unique, consistent, and comprehensive way.
If you are a new mobility service provider or a data solution provider and need an MDS ID you must add a unique provider_id to our providers.csv file.
You can do this by opening a Pull Request or an Issue here on GitHub.
If you are comfortable with GitHub, you can create a pull request to add a new row of information needed for your company, in CSV format:
provider_name,mode_id,provider_id,url,mds_api_url,gbfs_api_url
Examples:
Bird,micromobility,2411d395-04f2-47c9-ab66-d09e9e3c3251,https://www.bird.co,https://mds.bird.co,https://mds.bird.co/gbfs
Spin,micromobility,70aa475d-1fcd-4504-b69c-2eeb2107f7be,https://www.spin.app,https://web.spin.pm/api/mds/v1,
Fields:
-
provider_name- Short name of your company with proper capitalization. -
mode_id- The mode that this provider supports. Use the mode short identifier (e.g.micromobility). Register a unique ID for each mode you support. -
provider_id- A random UUID version 4. There are lots of ways to generate a unique UUID, like using this website. -
url- URL to the home page of your company. -
mds_api_url- Full https:// URL where your root MDS feeds are located. -
gbfs_api_url- Full https:// URL where your public GBFS feeds are located.
Important
If it's your first time contributing, you must sign the Contributor License Agreement. Click the button on your Pull Request page and follow the instructions. We cannot merge your changes until this is complete.
Once it looks good on our end, we will merge it to the dev branch so it's live and you can start referring to and using it. This may take a few days.
Alternatively and possibly easier, you can open an Issue here and describe what you'd like to have added, and then the OMF Staff can create a pull request and update it for you.
Once it looks good on your end, we will merge it to the dev branch so it's live and you can start referring to and using it.
It may take a few days for us to create a branch and setup a pull request. If you would like to expedite the process, please create a pull request instead of an issue.
You can start start referring to and using your ID as soon as it's live in the dev branch. In the next MDS release, the OMF will push it to the main (default) branch as well.
When complete, we will also add you to our OMF website "MDS Users" page list of Mobility Providers Using MDS.
Once you are up and running with your private MDS feeds for agencies, note that there is a requirement to have public GBFS feeds as well to be MDS compliant.
Please come back and add your GBFS URL to the end of your providers.csv listing when it's live.
Note that GBFS has a similar file called systems.csv, and you should add yourself there too when you get your feeds up and running.
If you need help, please contact the OMF Staff.
