Search APIs
Add Your API
Stream API thumbnail

Stream

4.6 Popularity
0% Service Level
127256ms Latency
0% Test

API Overview

Connect to the Stream Social API to create and customize a social newsfeed/activity newsfeed. Test an API call and export the code snippet into your app.

The Stream API has free and paid tiers as of 03/13/2017: https://getstream.io/pricing/

Create and customize a social newsfeed/activity newsfeed.

Stream Package

Create and customize a social newsfeed/activity newsfeed.

  • Domain: Stream
  • Credentials: apiKey, apiSecret

How to get credentials:

  1. Login or signup for a Stream account

  2. Navigate to your account dashboard to find your ApiKey and ApiSecret

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Stream.createActivity

Create any activity on feed

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringType of feed in which the activity will be created. In your app settings, you can add, remove or edit feed groups. Put there feed Name, not feed type. User has type flat, so you must enter 'user'
feedOwnerIdStringID of feed in which the activity will be created
activityFileJSON file with activity parameters. There may be many fields required for your application. But there are 3 required fields: actor, verb, object. Actor - who (name), verb - what actor do (like, post, tweet etc), object - with what actor do verb. Fox example: actor - Mike, verb - like, object - picture:10 (if in your app exist picture object with id=10). In Object field you get type and ip of object. You may parse field to get type and id. You can also set object = 10, if you has only pictures to like.

Stream.getActivities

Get activities from feed with offset and limit

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringType of feed which activity will be get
feedOwnerIdStringId of feed which activity will be get
limitNumberThe amount of activities requested from the APIs. Default: 25
offsetNumberThe offset. Default: 0
id_gteStringFilter the feed on ids greater than or equal to the given value
id_gtStringFilter the feed on ids greater than the given value
id_lteStringFilter the feed on ids smaller than or equal to the given value
id_ltStringFilter the feed on ids smaller than the given value

Stream.deleteActivity

Remove activity from feed

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringType of feed which activity will be removed
feedOwnerIdStringId of feed which activity will be removed
activityIdStringActivity ID, which will be removed

Stream.followFeed

Follow feed

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringFeed Name
feedOwnerIdStringFeed ID
feedTargetTypeStringTarget feed Name. For which owner will follow
feedTargetIdStringTarget feed ID. For which owner will follow

Stream.createMultipleFollows

Create multiple follows with one request

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
listArrayCreate many follows. Example [{"sourse": "value1", "target": "value2"}, {}]

Stream.getFeedFollower

Get feed follower

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringFeed Name
feedOwnerIdStringFeed ID

Stream.getFeedFollowings

Get feed followings

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringFeed Name
feedOwnerIdStringFeed ID

Stream.unFollowFeed

Unfollow feed

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedOwnerTypeStringFeed Name
feedOwnerIdStringFeed ID
feedTargetTypeStringTarget feed Name
feedTargetIdStringTarget feed ID

Stream.addActivityToFeeds

Add one activity to many feed

FieldTypeDescription
apiKeycredentialsUser apiKey obtained from getstream.io
apiSecretcredentialsUser apiSecret obtained from getstream.io
feedListListList of feeds. Array of strings
activityFileJSON file with activity parameters. There may be many fields required for your application. But there age 3 required fields: actor, verb, object. Actor - who (name), verb - what actor do (like, post, tweet etc), object