Lib.rs

› Web programming
#api #routing #openapi #version #was #api-client #motis

motis-openapi-sdk

This is the MOTIS routing API

Owned by Schmiddiii.

1 stable release

1.0.0 Jan 30, 2025

#1135 in Web programming

Download history 141/week @ 2025-01-28 36/week @ 2025-02-04

177 downloads per month
Used in 2 crates (via railway-provider-motis)

MIT license

98KB
1.5K SLoC

Rust API client for motis-openapi-sdk

This is the MOTIS routing API.

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

  • API version: v1
  • Package version: v1
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.RustClientCodegen

Installation

Put the package under your project folder in a directory named motis-openapi-sdk and add the following to Cargo.toml under [dependencies]:

motis-openapi-sdk = { path = "./motis-openapi-sdk" }

Documentation for API Endpoints

All URIs are relative to https://europe.motis-project.de

Class Method HTTP request Description
DebugApi footpaths GET /api/debug/footpaths Prints all footpaths of a timetable location (track, bus stop, etc.)
GeocodeApi geocode GET /api/v1/geocode Autocompletion & geocoding that resolves user input addresses including coordinates
GeocodeApi one_to_many GET /api/v1/one-to-many Street routing from one to many places or many to one. The order in the response array corresponds to the order of coordinates of the \many\\ parameter in the query.
GeocodeApi reverse_geocode GET /api/v1/reverse-geocode Translate coordinates to the closest address(es)/places/stops.
MapApi initial GET /api/v1/map/initial initial location to view the map at after loading based on where public transport should be visible
MapApi levels GET /api/v1/map/levels Get all available levels for a map section
MapApi stops GET /api/v1/map/stops Get all stops for a map section
MapApi trips GET /api/v1/map/trips Given a area frame (box defined by top right and bottom left corner) and a time frame, it returns all trips and their respective shapes that operate in this area + time frame. Trips are filtered by zoom level. On low zoom levels, only long distance trains will be shown while on high zoom levels, also metros, buses and trams will be returned.
RoutingApi plan GET /api/v1/plan Computes optimal connections from one place to another.
TimetableApi stoptimes GET /api/v1/stoptimes Get the next N departures or arrivals of a stop sorted by time
TimetableApi trip GET /api/v1/trip Get a trip as itinerary

Documentation For Models

To get access to the crate's generated documentation, use:

cargo doc --open

Author

felix@triptix.tech

Dependencies

~5–16MB
~204K SLoC