Stream
Free
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:
-
Login or signup for a Stream account
-
Navigate to your account dashboard to find your ApiKey and ApiSecret
Custom datatypes:
Datatype | Description | Example |
---|---|---|
Datepicker | String which includes date and time | 2016-05-28 00:00:00 |
Map | String which includes latitude and longitude coma separated | 50.37, 26.56 |
List | Simple array | ["123", "sample"] |
Select | String with predefined values | sample |
Array | Array 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
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Type 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' |
feedOwnerId | String | ID of feed in which the activity will be created |
activity | File | JSON 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
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Type of feed which activity will be get |
feedOwnerId | String | Id of feed which activity will be get |
limit | Number | The amount of activities requested from the APIs. Default: 25 |
offset | Number | The offset. Default: 0 |
id_gte | String | Filter the feed on ids greater than or equal to the given value |
id_gt | String | Filter the feed on ids greater than the given value |
id_lte | String | Filter the feed on ids smaller than or equal to the given value |
id_lt | String | Filter the feed on ids smaller than the given value |
Stream.deleteActivity
Remove activity from feed
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Type of feed which activity will be removed |
feedOwnerId | String | Id of feed which activity will be removed |
activityId | String | Activity ID, which will be removed |
Stream.followFeed
Follow feed
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Feed Name |
feedOwnerId | String | Feed ID |
feedTargetType | String | Target feed Name. For which owner will follow |
feedTargetId | String | Target feed ID. For which owner will follow |
Stream.createMultipleFollows
Create multiple follows with one request
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
list | Array | Create many follows. Example [{"sourse": "value1", "target": "value2"}, {}] |
Stream.getFeedFollower
Get feed follower
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Feed Name |
feedOwnerId | String | Feed ID |
Stream.getFeedFollowings
Get feed followings
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Feed Name |
feedOwnerId | String | Feed ID |
Stream.unFollowFeed
Unfollow feed
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedOwnerType | String | Feed Name |
feedOwnerId | String | Feed ID |
feedTargetType | String | Target feed Name |
feedTargetId | String | Target feed ID |
Stream.addActivityToFeeds
Add one activity to many feed
Field | Type | Description |
---|---|---|
apiKey | credentials | User apiKey obtained from getstream.io |
apiSecret | credentials | User apiSecret obtained from getstream.io |
feedList | List | List of feeds. Array of strings |
activity | File | JSON 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 |