Installation

Requirements

Before adding the SDK to your project, make sure your build configuration meets the following minimums:

These are the versions the SDK is built and tested with. Older minSdk or compileSdk values will fail to compile; older Kotlin or AGP versions may fail to consume the artifacts.

Repositories

All Stream Android libraries are available from MavenCentral, with some of their transitive dependencies hosted on Jitpack.

Before you add Stream dependencies, update your repositories in the settings.gradle file to include these two repositories:

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        google()
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}

Or if you're using an older project setup, add these repositories in your project level build.gradle file:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url "https://jitpack.io" }
    }
}

Check the Releases page for the latest version and the changelog:

Available Artifacts

Client

To add the low-level Chat client library to your app, open your module's build.gradle script and add the following:

dependencies {
    implementation "io.getstream:stream-chat-android-client:$stream_version"
}

The client library includes built-in offline support and state management. No additional dependencies are needed.

UI Components

To use the UI Components in your application, add the following dependency:

dependencies {
    implementation "io.getstream:stream-chat-android-ui-components:$stream_version"
}

Adding the UI Components library as a dependency will automatically include the client library as well.

Compose UI Components

To use the Compose UI Components instead, add the following dependency:

dependencies {
    implementation "io.getstream:stream-chat-android-compose:$stream_version"
}

Adding the Compose UI Components library as a dependency will automatically include the client library as well.

Markdown support

We ship an additional artifact for Markdown support which can be used together with the UI Components library:

dependencies {
    implementation "io.getstream:stream-chat-android-markdown-transformer:$stream_version"
}

For more information see UI Components Configuration guide.

Push Notifications

We ship multiple artifacts to easily integrate Stream Chat with third party push notification providers. See the Push Notification page for more details.