Skip to main content

Search SDK for Android

Current version:v2.5.0View changelog

  • check
    Add pre-built UI components to your app
  • check
    Search for places by name, category, or coordinate
  • check
    Search for addresses offline
InstallgithubContribute on GitHub
Additional Developer Resources

The Mapbox Search SDK for Android gives you the tools you need to add a search experience to your application. The Search SDK consists of various components that can be used standalone or combined together so you can build something truly custom. It takes only a few minutes to drop a pre-built user interface into your application. Let's learn about the components more!

There are two lines of development: versions 1.x and 2.x. They only differ in the runtime dependencies they have.

Versions 1.x depend on Maps Version 10. Versions 2.x depend on Maps Version 11.

Address Form Fill​

Suppose you need a user to enter a valid home or delivery address. They typically need to do this during the registration or checkout process, where making the entry process as smooth as possible can help you prevent churn. This is where the Address Form Fill will help you to enable users to fill in the address form by entering only a few characters is the most beneficial.


Category search for Android gives you the tools you need to add POI (Points of Interest) search to your application. Whether your users need to search for cafes nearby, parking in another city, or Electric Vehicle (EV) charging stations along their route, this use case will help you to provide the functionality they need with a few lines of code.


Place Autocomplete​

Place Autocomplete returns place suggestions such as addresses, businesses and POIs in response to user text search queries, as well as by supplying numeric coordinate information.


Search Engine and Offline Search Engine​

None of the use cases above covers your needs? Use generic Search Engine that allows you to build something custom. Similarly, you can use Offline Search Engine to add offline search experience to your applications.


Search UI​

The Search UI is built on top of the core functionality discussed above and provides ready-made search UI elements that you can use to add a search experience to your app. You can adjust the style of various elements of the preset UI and customize results.


Why use SDK?​

If your primary use case is targeted to mobile devices (iOS & Android), we strongly encourage you to use our Search SDK. With Search SDK, you get:

Stable SDK API​

By defining our use cases, we aim to support the same interface for longer even if the underlying implementation changes. This means bumping the SDK version fixes all issues you might encounter without requiring you to rework the app or its integration code.

Fewer lines of code​

Developers can get up and running with a few lines of code to start the SDK. See for yourself, it’s readable, maintainable, and error-proof.

Protecting against errors and pitfalls​

Having a ready-made integration example enables you to experiment faster and avoid common pitfalls of using API in a non-preferred way.

Drop-in UI support​

Have no need for custom UI and ready to get started? We have you covered with an easy-to-blend UI that doesn’t require extensive binding to current components and navigation flow.

Requirements​

The Mapbox Search SDK for Android works with:

  • Android 5.0+ (API 21)
  • NDK 21. Other major versions of the NDK are not guaranteed to be compatible
  • Architectures: armeabi-v7a, arm64-v8a, x86, x86_64
  • Kotlin 1.5 or newer
Additional Developer Resources
Was this page helpful?