Skip To Content

Install and set up

In this topic

You can get started developing apps with ArcGIS Runtime SDK for Android (ArcGIS Android SDK) using:

Make sure your development computer meets the system requirements, including the requirement for Google's Android SDK. Make sure you have successfully set up your Android development environment in Android Studio. For details on setting up the Google SDK, see installing the Android SDK.


We recommend installing with Gradle. This will install the needed dependencies and the SDK binaries from Bintray Esri repostiory.

  1. Use the following code example to add the maven repository's URL and the ArcGIS Runtime SDK for Android dependency to your project. Esri's repository is not open source, so you must specify a URL.

    repositories {
        // Add the following ArcGIS repository
        maven {
           url ''

  2. In the app module build.gradle file, within the dependencies block, add a directive to include the ArcGIS Runtime SDK for Android dependency to your app.

    App module build.gradle file

    dependencies {
        // Add ArcGIS Runtime SDK for Android dependency
        compile ''

  3. Again in the app module build.gradle file, within the android block, use the following code example to add a packaging options directive. This excludes duplicate files from the Android Package (APK) file created when you build your app, preventing build errors.

    App module build.gradle file, within android block

    packagingOptions { 
        exclude 'META-INF/LGPL2.1' 
        exclude 'META-INF/LICENSE' 
        exclude 'META-INF/NOTICE' 

  4. Depending on what ArcGIS functionality you use in your app, you may need to add permissions to your manifest, as described in the following section.
  5. If you want to use analysis capabilities (in beta), localization resources, and/or advanced symbology, download and install the SDK so that the resources are available to you, then follow the instructions for setting them up, as follows:
  6. You're ready to start programming with the ArcGIS Android API! From here you may want to try the hello-world-like tutorial, Add a map to your app, review design considerations, or dive right in to samples or the API Reference. This guide provides a "Fundamentals" section for developers new to ArcGIS Runtime and the ArcGIS Platform.

Required permissions and features

Android is a permissions-separated operating system. Depending on what ArcGIS capabilities you use in your app, you may need to add permissions to your manifest, as follows. Be sure not to include permissions for capabilities not included in your app.

ArcGIS capabilities that require permissions:

  • Access to the Internet (most apps will require this)
  • Access to files on disk (some apps will require this)
  • Access to the device's GPS will require fine location permissions
  • Apps that use MapView will require using OpenGL 2.x.

The following code example (for the AndroidManifest.xml file) includes permissions for all capabilities. Note that OpenGL is included as a feature.

<uses-feature android:glEsVersion="0x00020000" android:required="true" />

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" />

Add native libraries for analysis features (BETA)

  1. Create a /src/main/jniLibs/ folder in your app module.
  2. From the root of your SDK download directory, copy the /libs/[platform]/ folder into the jniLibs folder created in the previous step.
  3. Two native libs are added to your project, and under the /src/main/jniLibs/[platform] folder, where [platform] represents the platform architecture your device is running, such as armeabi-v7a. So, for example, the full path could be /src/main/jniLibs/armeabi-v7a/.
  4. Add the following to the defaultConfig directive in your app module build.gradle file:
    renderscriptTargetApi 19
    renderscriptSupportModeEnabled true
    For details on offline analysis, see the OfflineAnalysis sample.

The SDK download

The SDK download includes everything you get with Gradle installation plus native libraries for analysis capabilities (in beta), localization resources, and files for advanced symbology. Instructions for how to obtain these resources and include them in your project are provided in step 5 in the Gradle section above.

Download, install, and set up the local SDK

  1. Sign in to ArcGIS for Developers.
  2. Click the Downloads icon at the top right of the page and download the ArcGIS Runtime SDK for Android. Unzip the downloaded archive file to a location on your development machine.

Contents of the SDK download

The ArcGIS Android SDK download contains everything you need to develop ArcGIS Android SDK apps. The folders in the SDK are described below:

  • doc: API reference doc for arcgis android and arcgis android app toolkit APIs.
  • legal: Licensing documentation
  • libs: API jar libraries for arcgis-android and arcgis-android-app-toolkit, arcgis-android core native libraries, and third-party dependency jar libraries.
  • lib-project: Local Android Library Project in AAR format.
  • res: Localization files for localizing UI Popups.
  • resources: Advanced symbology symbol resource files
  • samples: Local sample projects in Android Gradle structure for importing into Android Studio.