Pull API \ Retrieve live Streams
Pull API Resources
Resource/URI | GET |
---|---|
Facebook · Retrieve a user's likes
/pull/identities/<identity_token>/facebook/likes.json
|
Retrieve Likes |
Facebook · Retrieve a user's posts
/pull/identities/<identity_token>/facebook/posts.json
|
Retrieve Posts |
Facebook · Retrieve a user's groups
/pull/identities/<identity_token>/facebook/groups.json
|
Retrieve Groups |
Facebook · Retrieve a user's group posts
/pull/identities/<identity_token>/facebook/group/<pageid>/posts.json
|
Retrieve Group Posts |
Facebook · Retrieve a user's pages
/pull/identities/<identity_token>/facebook/pages.json
|
Retrieve Pages |
Facebook · Retrieve a user's page posts
/pull/identities/<identity_token>/facebook/page/<pageid>/posts.json
|
Retrieve Page Posts |
Facebook · Retrieve a user's page post reactions
/pull/identities/<identity_token>/facebook/page/<pageid>/posts.json
|
Retrieve Page Post Reactions |
LinkedIn · Retrieve a user's posts
/pull/identities/<identity_token>/linkedin/user/posts.json
|
Retrieve User Posts |
LinkedIn · Retrieve a user's companies
/pull/identities/<identity_token>/linkedin/companies.json
|
Retrieve Companies |
LinkedIn · Retrieve a user's company posts
/pull/identities/<identity_token>/linkedin/company/<companyid>/posts.json
|
Retrieve Company Posts |
LinkedIn · Retrieve a post
/pull/identities/<identity_token>/linkedin/post.json
|
Retrieve Post |
LinkedIn · Retrieve post comments
/pull/identities/<identity_token>/linkedin/post/comments.json
|
Retrieve Post Comments |
Pinterest · Retrieve a user's boards
/pull/identities/<identity_token>/pinterest/boards.json
|
Retrieve Boards |
Pinterest · Retrieve a user's board pins
/pull/identities/<identity_token>/pinterest/board/<boardid>/pins.json
|
Retrieve Board Pins |
Steam · Retrieve a user's games
/pull/identities/<identity_token>/steam/games.json
|
Retrieve Games |
TikTok · Retrieve videos information
/pull/identities/<identity_token>/tiktok/videos.json
|
Retrieve Videos |
Twitch · Retrieve all broadcaster's subscriptions
/pull/identities/<identity_token>/twitch/broadcaster/subscriptions.json
|
Retrieve Broadcaster's subscriptions |
Twitch · Retrieve channels information
/pull/identities/<identity_token>/twitch/channels.json
|
Retrieve Channels |
Twitch · Retrieve clips information
/pull/identities/<identity_token>/twitch/clips.json
|
Retrieve Clips |
Twitch · Retrieve games information
/pull/identities/<identity_token>/twitch/games.json
|
Retrieve Games |
Twitch · Retrieve most viewed games
/pull/identities/<identity_token>/twitch/games/top.json
|
Retrieve Top Games |
Twitch · Retrieve live streams
/pull/identities/<identity_token>/twitch/streams.json
|
Retrieve Streams |
Twitch · Retrieve users information
/pull/identities/<identity_token>/twitch/users.json
|
Retrieve Users |
Twitch · Retrieve follow relationships between two users
/pull/identities/<identity_token>/twitch/users/follow.json
|
Retrieve Users Follows |
Twitch · Retrieve videos information
/pull/identities/<identity_token>/twitch/videos.json
|
Retrieve Videos |
Twitter · Retrieve a user's followers
/pull/identities/<identity_token>/twitter/followers.json
|
Retrieve Followers |
Twitter · Retrieve a user's followings
/pull/identities/<identity_token>/twitter/followings.json
|
Retrieve Followings |
Twitter · Retrieve a user's tweets
/pull/identities/<identity_token>/twitter/tweets.json
|
Retrieve Tweets |
Twitter · Retrieve a user
/pull/identities/<identity_token>/twitter/user.json
|
Retrieve User |
YouTube · Retrieve a user's channels
/pull/identities/<identity_token>/youtube/channels.json
|
Retrieve Channels |
YouTube · Retrieve a user's playlists
/pull/identities/<identity_token>/youtube/playlists.json
|
Retrieve Playlists |
YouTube · Retrieve a user's playlist videos
/pull/identities/<identity_token>/youtube/playlist/<playlistid>/videos.json
|
Retrieve Playlist Videos |
YouTube · Retrieve a user's channel sections
/pull/identities/<identity_token>/youtube/channel/sections.json
|
Retrieve Channel Sections |
Workflow
Request: the code to send to the API
Send an API request to this endpoint in order to get live streams information:
GET
/pull/identities/<identity_token>/twitch/streams.json
The <identity_token>
is obtained whenever one of your users connects using Twitch.
The following URL parameters can optionally be used with this endpoint:
URL Parameter | Description |
---|---|
user_idstring
|
User's ID who is streaming. |
user_loginstring
|
User's name who is streaming. |
after_cursorstring
|
Cursor for forward pagination: tells the server where to start fetching the next set of results
Example: abCdEfghijkLCJhIjoiIn0 |
before_cursorstring
|
Cursor for backward pagination: tells the server where to start fetching the next set of results Example: abCdEfghijkLCJhIjoiIn0 |
num_streamsstring
|
Indicates how many streams should be included in the resultset. Default: 25 |
Result: the code returned by the API
Response Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 | { "response" : { "request" : { "date" : "Wed, 28 Sep 2020 15:55:13 +0100" , "resource" : "/pull/identities/95681432-e02d-4a0b-ac6a-5c59d0e1fdfd/twitch/streams.json?name=loserfruit" , "status" : { "flag" : "success" , "code" : 200 , "info" : "Your request has been processed successfully" } }, "result" : { "data" : { "count" : 2 , "cursor" : "MjY=" , "entries" : [ { "id" : "1234567897262908" , "user_id" : "123456" , "user_name" : "lestream" , "game_id" : "123" , "type" : "live" , "title" : "Live Test 1" , "viewer_count" : 7711 , "started_at" : "2020-09-29T04:49:56Z" , "language" : "fr" , "thumbnail_url" : "https://static-cdn.jtvnw.net/previews-ttv/live_user_live1-x.jpg" , { "id" : "1234567897648300" , "user_id" : "987654" , "user_name" : "Shaunz" , "game_id" : "987" , "type" : "live" , "title" : "Live Test 2" , "viewer_count" : 5235 , "started_at" : "2020-09-29T08:16:33Z" , "language" : "fr" , "thumbnail_url" : "https://static-cdn.jtvnw.net/previews-ttv/live_user_live2-x.jpg" |