{"componentChunkName":"component---src-templates-developers-js","path":"/en/developers/apis/1-routing-api/routes/","result":{"data":{"childPages":{"edges":[{"node":{"fields":{"slug":"/en/developers/"},"frontmatter":{"title":"For developers","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/"},"frontmatter":{"title":"System architecture","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/api-registration/"},"frontmatter":{"title":"API portal and registration","order":-12,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/changes/"},"frontmatter":{"title":"Changes","order":-10,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/user-interfaces/"},"frontmatter":{"title":"User interfaces","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/deprecations/"},"frontmatter":{"title":"Deprecations","order":-11,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/docker-guide/"},"frontmatter":{"title":"Docker guide","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/"},"frontmatter":{"title":"APIs","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/"},"frontmatter":{"title":"Routing API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/2-routing-data-api/"},"frontmatter":{"title":"Routing data API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/4-map-api/"},"frontmatter":{"title":"Map API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/"},"frontmatter":{"title":"API architecture","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/6-api-faq/"},"frontmatter":{"title":"FAQ","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/"},"frontmatter":{"title":"Realtime APIs","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/3-geocoding-api/"},"frontmatter":{"title":"Geocoding API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/7-terms-of-use/"},"frontmatter":{"title":"Terms of use","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/user-interfaces/1-digitransit-ui/"},"frontmatter":{"title":"Digitransit-ui","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/0-graphql/"},"frontmatter":{"title":"GraphQL","order":10,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/3-realtime-information/"},"frontmatter":{"title":"Real-time information","order":40,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/2-glossary/"},"frontmatter":{"title":"Glossary","order":30,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/canceled-trips/"},"frontmatter":{"title":"Canceled trips","order":80,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/disruption-info/"},"frontmatter":{"title":"Disruption info","order":70,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/4-translations/"},"frontmatter":{"title":"Translation","order":50,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/routes/"},"frontmatter":{"title":"Routes","order":100,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/stops/"},"frontmatter":{"title":"Stops","order":110,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/bicycles-scooters-cars/"},"frontmatter":{"title":"Bicycles, cars and e-scooters","order":60,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/itinerary-planning/"},"frontmatter":{"title":"Itinerary planning","order":90,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/1-routing-api/"},"frontmatter":{"title":"Routing API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/2-routing-data-api/"},"frontmatter":{"title":"Routing Data","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/4-map-api/"},"frontmatter":{"title":"Map API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/5-realtime-api/"},"frontmatter":{"title":"Real-time APIs","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/3-geocoding-api/"},"frontmatter":{"title":"Geocoding API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/1-routing-api/1-graphiql/"},"frontmatter":{"title":"GraphiQL","order":20,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/4-map-api/background-map/"},"frontmatter":{"title":"Background map","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/1-getting-started/"},"frontmatter":{"title":"Getting started","order":10,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/3-geocoding-api/address-search/"},"frontmatter":{"title":"Address search","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/3-geocoding-api/autocomplete/"},"frontmatter":{"title":"Autocomplete","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/trip-updates/"},"frontmatter":{"title":"Trip updates","order":30,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/service-alerts/"},"frontmatter":{"title":"Service alerts","order":20,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/3-geocoding-api/address-lookup/"},"frontmatter":{"title":"Address lookup","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/4-map-api/pois/"},"frontmatter":{"title":"Points of interest","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/vehicle-positions/"},"frontmatter":{"title":"Vehicle positions","order":40,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/3-geocoding-api/data-container/"},"frontmatter":{"title":"Data builder and container","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/architecture/x-apis/3-geocoding-api/api/"},"frontmatter":{"title":"API","order":null,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/vehicle-positions/high-frequency-positioning/"},"frontmatter":{"title":"High-frequency positioning","order":20,"redirect":null}}},{"node":{"fields":{"slug":"/en/developers/apis/5-realtime-api/vehicle-positions/digitransit-mqtt/"},"frontmatter":{"title":"Digitransit MQTT broker","order":10,"redirect":null}}}]},"markdownRemark":{"fields":{"slug":"/en/developers/apis/1-routing-api/routes/"},"frontmatter":{"title":"Routes","redirect":null,"toc":null,"description":null,"assets":null,"technologies":null,"docker":null},"html":"

If you are not yet familiar with GraphQL and GraphiQL it is highly recommended to review those pages at first.

\n

Glossary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TermExplanation
RouteA public transport service shown to customers under a single name, usually from point A to B and back. For example: trams 1 and 1A, buses 18 and 102T, or train A.
Commonly used synonym: line
PatternA sequence of stops as used by a specific direction (i.e. inbound or outbound journey) and variant of a route.
For example, a variant of a route could be a tram entering service from the depot and joining at the middle of the route or a route might have a short term diversion without changing the route name (longer diversions are usually marked as different routes).
TripA specific occurance of a pattern, usually identified by the route and exact departure time from the first stop.
For example: tram 15 leaving from Keilaniemi on 2024-12-18 at 13:13, or more generally leaving from Keilaniemi at 13:13 on specified days.
\n

Query examples

\n

Note: For more details about the query types routes and pattern and their parameters you can use the Documentation Explorer provided in GraphiQL.

\n

Note: If the examples provided with an id or other parameter do not return what is expected then the value in question may not be in use any more and you should try again with an existing value.

\n

Query all routes where name starts with \"10\"

\n
    \n
  1. Click this link to run the query below in GraphiQL.
    2. \n
\n
{\n  routes(name: \"10\") {\n    gtfsId\n    shortName\n    longName\n    mode\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Query all bus routes where name starts with \"58\"

\n
    \n
  1. Click this link to run the query below in GraphiQL.
    2. \n
\n
{\n  routes(name: \"58\", transportModes: BUS) {\n    gtfsId\n    shortName\n    longName\n    mode\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Query all tram routes where name starts with \"1\"

\n
    \n
  1. Click this link to run the query below in GraphiQL.
    2. \n
\n
{\n  routes(name: \"1\", transportModes: TRAM) {\n    gtfsId\n    shortName\n    longName\n    mode\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Query patterns of a route

\n
    \n
  1. Click this link to run the query below in GraphiQL.
    2. \n
\n
{\n  routes(name: \"59\", transportModes: BUS) {\n    shortName\n    longName\n    patterns {\n      code\n      directionId\n      name\n      headsign\n    }\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Example response:

\n
{\n  \"data\": {\n    \"routes\": [\n      {\n        \"shortName\": \"59\",\n        \"longName\": \"Sompasaari-Kalasatama(M)-Pasila-Pajamäki\",\n        \"patterns\": [\n          {\n            \"code\": \"HSL:1059:0:01\",\n            \"directionId\": 0,\n            \"name\": \"59 to Pajamäki (HSL:1461110)\",\n            \"headsign\": \"Pajamäki\"\n          },\n          {\n            \"code\": \"HSL:1059:1:01\",\n            \"directionId\": 1,\n            \"name\": \"59 to Polariksenkatu (HSL:1100128)\",\n            \"headsign\": \"Sompasaari\"\n          }\n        ]\n      }\n    ]\n  }\n}
\n

Query stop names by pattern ID

\n\n
{\n  pattern(id: \"HSL:1059:0:01\") {\n    name\n    stops {\n      name\n    }\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Query trips of a specific pattern

\n
    \n
  1. Click this link to run the query below in GraphiQL.
    2. \n
\n
{\n  pattern(id: \"HSL:1059:0:01\") {\n    code\n    directionId\n    name\n    headsign\n    trips {\n      gtfsId\n      tripHeadsign\n      routeShortName\n      directionId\n    }\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Query trip with id

\n
    \n
  1. Click this link to run the query below in GraphiQL.
    2. \n
\n
{\n  trip(id: \"HSL:1020_20240314_Pe_1_0933\") {\n    tripHeadsign\n    occupancy {\n      occupancyStatus\n    }\n  }\n}
\n
    \n
  1. Press play in GraphiQL to execute the query.
    2. \n
\n

Example response:

\n
{\n  \"data\": {\n    \"trip\": {\n      \"tripHeadsign\": \"Munkkivuori\",\n      \"occupancy\": {\n        \"occupancyStatus\": \"FEW_SEATS_AVAILABLE\"\n      }\n    }\n  }\n}
","tableOfContents":"","excerpt":"If you are not yet familiar with GraphQL and GraphiQL it is highly recommended to review those pages at first. Glossary Term Explanation Route A public transport service shown to customers under a…"}},"pageContext":{"slug":"/en/developers/apis/1-routing-api/routes/"}},"staticQueryHashes":["3675773199","4050193485"]}