Ferrostar¶
Ferrostar is a new SDK for building turn-by-turn navigation applications. Just like our powerful routing APIs, we designed Ferrostar for customizability from the start, so you can build the navigation experience your users deserve.
- Customizable core behaviors - You can change the off route detection logic, swap out your own location provider, and more.
- Composable UI - Unlike most SDKs, the UI is built from reusable components in SwiftUI and Jetpack Compose, so you reuse or customize parts of the UI much easier than with traditional solutions.
- Consistent design - Idiomatic platform SDKs, consistent API designs, and structural cohesion across all platforms speed up development if you're targeting multiple platforms.
- Built for the future - Our UI layer comes with the latest goodies from MapLibre like Metal rendering, and the core is memory safe and portable by design.
Getting Started¶
To use Ferrostar with basemaps or routing from Stadia Maps, you'll need an API key.
- Sign in to the client dashboard. (If you don't have an account yet, sign up for free; no credit card required!)
- Click "Manage Properties."
- If you have more than one property (ex: for several websites or apps), make sure you have selected the correct property from the dropdown at the top of the page.
- Under "Authentication Configuration," you can generate, view or revoke your API key.
Video: How to generate your API key¶
Once you have your API key, head over to Ferrostar's dedicated documentation site for tutorials and in-depth customization guides.
Getting Support¶
GitHub issues and discussions
are the best way to submit feature requests and bug reports.
If you have a general question, the #ferrostar channel on the OSM US Slack
is the place to chat!
We also offer commercial support with response time guarantees and expert advice on your integration. Contact sales for details.
Source Code¶
Ferrostar is completely open source and available under a BSD license! You can find the source code on GitHub.