This documentation site primarily describes Transitland v2. Some components of Transitland v1 are deprecated but still active, including the Transitland v1 Datastore API.
Transitland brings together many sources of transit data to build a directory of operators and feeds that can be edited by transit enthusiasts and developers.
Here is a diagram of the overall Transitland v1 and v2 technical architecture:
Comparing the APIs
Transitland v1 and v2 provide a range of APIs. All are powered by the same underlying database cluster. Each has a different set of capabilities and constraints:
|API||Status||Root Endpoint||API Key Required||Cost||Uses|
|Transitland v2 Map Vector Tiles||production||free (with rate limits)||Powers the map. Build your own web maps of stop locations and route geometries. In Mapbox Vector Tile (MVT) format.|
|Transitland v2 REST API||production||free (with rate limits)||Fast and easy queries for accessing common data.|
|Transitland v2 GraphQL API||production||paid||The most flexible API for performing a wide variety of queries and analyses. May be slower than v2 REST API for certain queries. May require support for advanced uses.|
|Transitland v1 Datastore API||deprecated||free (with rate limits)||Original API for exploring data and powering apps. Has some performance limitations.|
Signing up for an API Key
Transitland APIs all require an API key to access. To get an API key, follow these steps:
Open to the sign-up page
If you already have an Interline account (you will have one if you use Interline OSM Extracts) click Sign in in the upper right corner.
Pick a free or paid subscription plan.
Press the Order button and watch your email inbox (or your spam folder) for a notification.
You may retrieve your API key at any time by signing into your Interline account. If it's your first time signing in, press Sign in using your Interline account and then press Forgot password? to set an initial password.
If you selected a Professional plan, Interline staff will be in touch to process payment. You will be able to get started using your new API key at the Free plan rates, in the meantime. Once payment is received, the limits will be increased on that API key.
Use your API key by adding it to any Transitland API request using a query parameter or header using one of the following keys:
apikey[our recommended default]
Here is an example request:
xxx is replaced with your API key.
How to Participate
Transitland welcome many types of participation:
- Please help us to expand the coverage of existing public feeds in the Transitland Atlas.
- Use Transitland APIs to power your own maps, apps, trip planning tools, analyses, and other projects. Share your creations with us by posting to Transitland's "show & tell" discussion board on GitHub.
- Share Transitland with your favorite transit agency — whether it's one you ride, you work for, or one you just really like.
- If you have further questions, see the support options.