Feeds v2 has been superseded by Feeds v3. stream-java is the Feeds v2 client for Java. It is in maintenance mode: it still gets critical fixes and is safe to keep using with an existing v2 app. New projects should start on Feeds v3 with stream-sdk-java (Maven io.getstream:stream-sdk-java).

Moving a v2 app to v3: you start the migration from the Stream Dashboard, and it keeps your v2 and v3 data in sync while you switch your code over. Step by step: Feeds v2 to v3 migration guide. If you use an AI coding agent, Stream's Agent Skills can help: /stream-feeds-migration builds the migration mapping from your own v2 data, and /stream-docs answers Feeds v3 questions while you port your code.

Official Java SDK for Stream Feeds

Official Java API client for Stream Feeds, a web service for building scalable newsfeeds and activity streams.
Explore the docs »

JavaDoc · Report Bug · Request Feature

📝 About Stream

You can sign up for a Stream account at our Get Started page.

You can use this library to access feeds API endpoints server-side.

For the client-side integrations (web and mobile) have a look at the JavaScript, iOS and Android SDK libraries (docs).

💡 Note: this is a library for the Feeds product. The Chat SDKs can be found here.

⚙️ Installation

Releases are published to the Stream Maven repository. Add it next to Maven Central, then add the dependency.

In your pom.xml:

<repositories>
    <repository>
        <id>stream</id>
        <url>https://stream-io-repo.com</url>
    </repository>
</repositories>

<dependency>
    <groupId>io.getstream.client</groupId>
    <artifactId>stream-java</artifactId>
    <version>${stream_version}</version>
</dependency>

or in your build.gradle:

repositories {
    mavenCentral()
    maven { url 'https://stream-io-repo.com' }
}

dependencies {
    implementation 'io.getstream.client:stream-java:$stream_version'
}

In case you want to download the artifact and put it manually into your project, you can download it from here.

Snapshots of the development version are available in Sonatype snapshots repository.

💡This API Client project requires Java SE 7.

🙋 FAQ

1. Is Android supported?

Yes. Use client for your backend and use CloudClient for your mobile application.

2. Cannot construct an instance of io.getstream.core.models.*, a model object in android. What is the problem?

If you're using proguard, ensure having following: -keep class io.getstream.core.models.** { *; }

Additionally, we're using Jackson JSON processor and see their definitions too unless you're already using it.

📚 Full documentation

Documentation for this Java client are available at the Stream website.

For examples have a look here.

Docs are available on GetStream.io.

JavaDoc is available here.

🧪 Building & Testing

Run gradlew test to execute integration tests

✍️ Contributing

We welcome code changes that improve this library or fix a problem, please make sure to follow all best practices and add tests if applicable before submitting a Pull Request on Github. We are very happy to merge your code in the official repository. Make sure to sign our Contributor License Agreement (CLA) first. See our license file for more details.

🧑‍💻 We are hiring!

We've recently closed a $38 million Series B funding round and we keep actively growing. Our APIs are used by more than a billion end-users, and you'll have a chance to make a huge impact on the product within a team of the strongest engineers all over the world.

Check out our current openings and apply via Stream's website.