REST API - Feeds

Feeds

The REST API feeds endpoint provides a fast and flexible way to browse source feeds registered in the Transitland platform.

Request overview

The feeds API provides a number of searching and filtering parameters; results are based on this GraphQL query.


Request parameters

GET/api/v2/rest/feeds Feeds — Search for feeds

GET/api/v2/rest/feeds.{format}Request feeds in specified format

GET/api/v2/rest/feeds/{feed_key}Request a feed by ID or Onestop ID

GET/api/v2/rest/feeds/{feed_key}.{format}Request a feed by ID or Onestop ID in specified format

ParameterTypeDescriptionExample
idinteger
0 ... unlimited
Search for a specific internal ID
feed_keystring

Feed lookup key; can be an integer ID or a Onestop ID
afterinteger

Return records past this record ID
limitinteger
0 ... 100
Maximum number of records to returnlimit=1
format enum
jsongeojsonpng
Response formatformat=geojson
searchstring

Full text searchsearch=caltrain
onestop_idstring

Search for a specific Onestop IDonestop_id=f-9q9-caltrain
specstring enum
gtfsgtfs-rtgbfsmds
Type of data contained in this feedspec=gtfs
fetch_errorstring enum
truefalse
Search for feeds with or without a fetch errorfetch_error=true
tag_keystring

Search for feeds with a tag. Combine with tag_value also query for the value of the tag.tag_key=gtfs_data_exchange
tag_valuestring

Search for feeds tagged with a given value. Must be combined with tag_key.tag_key=unstable_url&tag_value=true
radiusnumber
0 ... 10000
Search for feeds geographically; radius is in meters, requires lon and latlon=-122&lat=37&radius=1000
lonnumber
-180 ... 180
Longitude
latnumber
-90 ... 90
Latitude
bboxstring

Geographic search using a bounding box, with coordinates in (min_lon, min_lat, max_lon, max_lat) order as a comma separated stringbbox=-122.269,37.807,-122.267,37.808
license_commercial_use_allowed enum
yesnounknownexclude_no
Filter entities by feed license 'commercial_use_allowed' value. Please see Source Feed concept for details on license values. 'exclude_no' is equivalent to 'yes' and 'unknown'.
license_share_alike_optional enum
yesnounknownexclude_no
Filter entities by feed license 'share_alike_optional' value. Please see Source Feed concept for details on license values. 'exclude_no' is equivalent to 'yes' and 'unknown'.
license_create_derived_product enum
yesnounknownexclude_no
Filter entities by feed license 'create_derived_product' value. Please see Source Feed concept for details on license values. 'exclude_no' is equivalent to 'yes' and 'unknown'.
license_redistribution_allowed enum
yesnounknownexclude_no
Filter entities by feed license 'redistribution_allowed' value. Please see Source Feed concept for details on license values. 'exclude_no' is equivalent to 'yes' and 'unknown'.
license_use_without_attribution enum
yesnounknownexclude_no
Filter entities by feed license 'use_without_attribution' value. Please see Source Feed concept for details on license values. 'exclude_no' is equivalent to 'yes' and 'unknown'.

Response format

Array of objects
Description Distributed mobility data registry (DMFR) feed
Reference DMFR Schema
id
(integer)
Unique integer ID
onestop_id
(string)
Onestop ID for this feed

Examplef-9q9-bart

name
(string)
A common name for this feed

ExampleBay Area Rapid Transit

spec
(string)
Type of data contained in this feed: GTFS, GTFS-RT, GBFS, or MDS
Enumgtfsgtfs-rtgbfsmds
languages
(string array)
Language(s) included in this feed

Example{ "0": "en-US" }

feed_versions
(object array)
A subset of fields for the feed versions associated with this feed
urls
(object)
URLs that provide data associated with this feed
static_current
(string)
URL for the static feed that represents today's service

Examplehttps://www.bart.gov/dev/schedules/google_transit.zip

static_historic
(string array)
URLs for static feeds that represent past service that is no longer in effect
static_planned
(string)
URLs for static feeds that represent service planned for upcoming dates. Typically used to represent calendar/service changes that will take effect few weeks or months in the future
realtime_vehicle_positions
(string)
URL for GTFS Realtime VehiclePosition messages
realtime_trip_updates
(string)
URL for GTFS Realtime TripUpdate messages
realtime_alerts
(string)
URL for GTFS Realtime Alert messages
gbfs_auto_discovery
(string)
URL for GBFS auto discovery
mds_provider
(string)
URL for MDS endpoint
license
(object)
License information for this feed, if present
spdx_identifier
(string)
SPDX identifier for a common license. See https://spdx.org/licenses/

ExampleCC-BY-4.0

url
(string)
URL for a custom license

Examplehttp://www.actransit.org/data-terms-and-conditions/

use_without_attribution
(string)
Are feed consumers allowed to use the feed contents without including attribution text in their app or map?
Enumyesnounknown
create_derived_product
(string)
Are feed consumers allowed to create and share derived products from the feed?
Enumyesnounknown
redistribution_allowed
(string)
Are feed consumers allowed to redistribute the feed in its entirety?
Enumyesnounknown
commercial_use_allowed
(string)
Are feed consumers allowed to use the feed for commercial purposes?
Enumyesnounknown
share_alike_optional
(string)
Are feed consumers allowed to keep their modifications of this feed private?
Enumyesnounknown
attribution_text
(string)
Feed consumers must include this particular text when using this feed

Exampledata provided by 511.org

attribution_instructions
(string)
Feed consumers must follow these instructions for how to provide attribution

ExampleYou must acknowledge the source of the provided data...

auth
(object)
Details on how to construct an HTTP request to access a protected resource
type
(string)
Method for inserting authorization secret into request
Enumheaderbasic_authquery_parampath_segment
param_name
(string)
When type=query_param, this specifies the name of the query parameter. When type=header, this specifies the name of the header.
info_url
(string)
Website to visit to sign up for an account
feed_state
(object)
Details on the current state of this feed, such as active version, last fetch time, etc.
last_fetch_error
(string)
Error produced during the last fetch attempt. Empty string if no error.

Example404 error

last_fetched_at
(datetime)
Time of last attempted fetch

Example2019-11-15T00:45:55.409906

last_successful_fetch_at
(datetime)
Time of last successful fetch that returned valid data

Example2019-11-15T00:45:55.409906

feed_version
(object)
The subset of fields of the active feed version. See feed version documentation for full details.
geometry
(object)
Geometry in GeoJSON format
type
(string)
GeoJSON geometry type

ExampleLineString

coordinates
(number array)
An array of coordinates; may be nested arrays if geometry is Polygon or MultiLineString

Example[ [ -122.496, 37.778 ], [ -122.425, 37.786 ] ]


Downloading source GTFS

See also downloading static GTFS feed versions.

GET/api/v2/rest/feeds/{feed_key}/download_latest_feed_versionDownload latest feed version for this feed

Description Download the latest feed version GTFS zip for this feed, if redistribution is allowd by the source feed's license