Transitland developers: We're pleased to release the Transitland v2 REST API for public, production use. Please start transitioning any apps/maps/scripts/etc using the v1 Datastore APIs to the new REST API. It's faster, more reliable, and provides some interesting new functionality. Sign-up is free.

Feeds and feed versions

Transitland is built on publicly available GTFS data contributed by our user community to the Transitland Atlas. Detailed information is kept on each Feed, and updated whenever a new version of each Feed is discovered. Feed versions are archived for download (as .zip files) and imported into the Transitland Datastore for API querying by operators, stops, routes, schedules, etc.

Feeds

A Feed represents a unique GTFS data source. Each Feed has a URL to a publicly accessible GTFS archive, a mapping of GTFS agency_id values to Transitland Operators, the geographic extent of the Feed, and the details of the Feed's license.

Feed data model

AttributeTypeDescription
onestop_idOnestop IDFeed Onestop ID
urlURLPublicly accessible GTFS archive
nameStringFeed name
feed_formatEnumCurrently: gtfs
geometryGeometryConvex hull of Stops in the Feed
last_fetched_atDateTimeLast time the Feed was retrieved
last_imported_atDateTimeLast time the Feed was imported
license_nameStringLicense name, such as MIT
license_use_without_attributionEnumyes, no, unknown
license_create_derived_productEnumyes, no, unknown
license_redistributeEnumyes, no, unknown
license_attribution_textStringRequired attribution text
license_urlURLURL to Feed License
tagsObjectTags
feed_versionsFeed VersionsFeed Version IDs (SHA1) for this Feed
active_feed_versionFeed VersionActive Feed Version ID
operators_in_feedObject arrayMapping of gtfs agency_ids to Operators
changesets_imported_from_this_feedChangesetsChangesets created from Feed

Feeds API

Endpoint: /api/v1/feeds

Feed license information

To learn more about how Transitland classifies the licenses associated with a feed, see this overview of Transitland legal and licensing issues.

Feed versions

Approximately once per day, the URL for each Feed is checked. When a new version of the Feed is found, a Feed Version is created. The ID for each Feed Version is the SHA1 checksum of the GTFS archive.

Feed versions data model

AttributeTypeDescription
sha1SHA1SHA1 checksum of the GTFS archive
md5MD5MD5 checksum of GTFS archive
feedOnestop IDParent Feed Onestop ID
fetched_atDateTimeTime was originally fetched
urlURLURL when fetched
download_urlURLArchived copy of Feed Version, if allowed
feedvalidator_urlURLArchived Google feedvalidator.py report
earliest_calendar_dateDateFirst day of scheduled service
latest_calendar_dateDateLast day of scheduled service
imported_atDateTimeLast time Feed Version was imported
import_levelIntegerImport level (0-4)
import_statusEnumImport status, such as most_recent_succeeded
feed_version_importsIDsFeed Version Import IDs
feed_version_infosIDsFeed Version Info IDs
is_active_feed_versionBooleantrue if Feed Version is active
changesets_imported_from_this_feed_versionChangesetsChangesets created from Feed Version

Feed versions API

Endpoint: /api/v1/feed_versions

Active feed version

The most recent version of a feed that has been imported into the Transitland Datastore is marked as active. The schedule API endpoint only allows querying of the trips and calendars in the active feed version.

The FeedMaintenance service within Transitland Datastore automatically decides when to import a newly fetched feed version. If no need feed version is available when existing ScheduleStopPairs are about to expire, the FeedMaintenance service will extend them into the future.

Most recent feed version

Are you looking for the most recently fetched Feed Version? This is not necessarily the Feed Version where is_active_feed_version=true.

To query for the most recently fetched version of a feed, use an API query like: https://transit.land/api/v1/feed_versions?feed_onestop_id=f-9v6-capitalmetro&per_page=1&sort_key=fetched_at&sort_order=desc (replacing feed_onestop_id as appropriate).

To directly download a copy of the most recently fetched version of a feed, use: https://transit.land/api/v1/feeds/f-9v6-capitalmetro/download_latest_feed_version (replacing the Onestop ID as appropriate). Note that downloading is not allowed for Feeds where license_redistribute=no.

Feed version reports

The Transitland Datastore creates a number of validation and statistical reports for each Feed Version. The currently defined types of reports are:

  • FeedVersionInfoStatistics: General statistics
  • FeedVersionInfoConveyalValidation: Conveyal gtfs-lib validation results

Additionally, the results of Google's feedvalidator.py HTML output will be stored on the Feed Version as feedvalidator_url when available. In the future, this may instead be stored as an additional type of report.

Feed version report data model

AttributeTypeDescription
idIntegerID
typeEnumReport type
feed_version_sha1Feed VersionParent Feed Version
feed_onestop_idOnestop IDParent Feed
dataJSONJSON blob containing report data

Feed version report API

Endpoint: /api/v1/feed_version_infos

Query parameterTypeDescriptionExample
feed_onestop_idOnestop IDFilter by FeedCaltrain
feed_version_sha1Feed VersionFilter by Feed VersionCaltrain, single Feed Version
typeEnumFilter by report typeCaltrain statistics

FeedVersionInfoStatistics reports

This report contains details about the files in the GTFS archive and basic statistics about the CSV columns and values.

  • filenames: The filenames present in the directory of the archive containing the CSV files.
  • statistics: Data for each GTFS CSV file and column, with the total number of rows with data for that column, the unique number of values encountered, as well as the min and max values.
  • scheduled_service: Key-value data for the number of seconds of scheduled service for each date the Feed has scheduled trips.

Example FeedVersionInfoStatistics report

FeedVersionInfoConveyalValidation reports

This report contains the JSON output of Conveyal's gtfs-lib validator.

Example FeedVersionInfoConveyalValidation report

Google feedvalidator.py reports

The HTML output of Google feedvalidator.py. Currently, this is stored on the actual Feed Version record as feedvalidator_url as a link to a copy of the report stored on S3.

Example Feed Version with Google feedvalidator.py report

Feed version update statistics

The Feeds API also provides simple statistics characterizing when & how a Feed is updated. This includes the total number of Feed Versions, the average number of days between publication of new Feed Versions, the average number of service days in each Feed Version schedule, and the average number of days of overlapping schedule between subsequent Feed Versions. Note: because the fetched_at value is used to sort the Feed Versions, manually uploaded files are excluded from statistics.

Example

Endpoint: /api/v1/feeds/:feed_onestop_id/feed_version_update_statistics

Response

AttributeTypeDescription
feed_onestop_idOnestop IDFeed Onestop ID
feed_versions_totalIntegerTotal number of Feed Versions
feed_versions_filteredIntegerTotal, excluding manually updated Feed Versions
feed_versions_filtered_sha1Feed VersionsFiltered Feed Versions ordered by fetched_at
fetched_at_frequencyIntegerAverage days between new Feed Versions
scheduled_service_duration_averageFloatAverage number of days in each schedule
scheduled_service_overlap_averageFloatAverage number of days overlap between subsequent schedules