Public Transit API Developer's Guide

Transit Alerts

Use the resource alerts/nearby to request transit alerts near a location.

.../v3/alerts/nearby.{format}?<parameter>=<value>...
      
Table 1. Mandatory Parameters
Parameter Data Type Description
app_id String

A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application.
You must include an app_id and app_code with every request. To get an app_code assigned to you, please see Acquiring Credentials.

app_code String

A 20 bytes Base64 URL-safe encoded string used for the authentication of the client application.
You must include an app_id and app_code with every request. To get an app_code assigned to you, please see Acquiring Credentials.

center Double,Double Specifies the latitude and the longitude of the center point of your search separated by a comma. Where the latitude is in WGS 84-compliant degrees between -90 and 90 and the longitude in WGS 84-compliant degrees between -180 and 180.
Table 2. Optional Parameters
Parameter Data Type Description
lines String Specifies the list of line names the response should include. Separate the names by a comma. If you use this parameter, only the response only contains the listed lines.
max Integer Specifies the maximum number of alerts in the response. Default is 40 and 100 is maximum allowed number.
modes String

Specifies the transit type filter used to determine which types of transit to include in the response.
By default the parameter is omitted, meaning all supported transit types are permitted.
See Transit Modes page for more information.

validOn Double Specifies the time from which the alerts in the response need to be valid in yyyy-MM-ddThh:mm:ss format. The default is from the time the request is received.
filter String Specifies what alerts will be returned in the response. The following values are possible:
  • all: All alerts
  • matched: Alerts that were able to match with the transit data
  • unmatched: Alerts that were fail to match with the transit data

Default value: matched

Note: The Alerts are sourced from transit agencies' API feeds and/or Twitter accounts (where available). If the alerts' origin is from Twitter, you are required to follow Twitter's general principles for presenting alerts correctly. We do not provide any data for Twitter's logos and links for Twitter's actions. The full guidance on the display requirements can be found on Twitter Display Requirements page.