Getting Started

Stream has official clients for JS/Node, Ruby, Python, PHP, Go, and Java. There are framework integrations available for Rails, Django, Laravel, Doctrine, Zend, and Node. In addition to the official clients, the community has built clients for .NET and Scala.

Official clients are currently available for a number of languages:

• Golang Feed Client→
• Python Feed Client→
• JS Feed Client→
• Rails Feed Client→
• Laravel Feed Client→
• PHP Feed Client→
• .NET Feed Client→
• Node.JS Feed Client→
• Java Feed Client→

The community also contributed clients for Scala and Elixir:

• Elixir→
• Scala→

If you want to build your own client, head over to the REST API documentation.

Stream makes it a breeze to integrate with a number of popular frameworks. If you're new to Stream we recommend starting out with the lower level clients.

• Django→
• Doctrine→

The community also contributed the following example projects

• CakePHP→

Let's get set up! First, install the client as specified below:

To instantiate the client you need an API key and secret. You can find the key and secret on the dashboard. The examples below already include your key and secret.

If you want to use Stream on your mobile or web application, you need to generate a token server-side that the JS/Swift/Java client can use to authenticate as a user of your application.

This code generates the token for one of your users; a common place to do this is at signup or login. The token is then passed to the frontend.

The quick start below shows you how to build a scalable social network. It highlights the most common API calls:

That was a good deal of information at once. The getting started docs provide a more detailed and interactive explanation.