This page is clone of docs.periscopr.uk

(Unofficial) Periscope API Documentation
Authored By: Chris Hogben <chris@periscopr.uk> (@cjhbtn)

Introduction

Periscope is a mobile broadcasting application developed by Twitter. It allows users to broadcast video and audio from their mobile device to users anywhere in the world. Viewers can access the broadcast using the app as well, or by clicking a shared link which takes them to a basic web interface of the broadcast.

There is no public API available for interacting with Periscope, therefore the following documentation has been gathered after careful research of the interactions the application had with the Periscope servers.

As this information is unofficial, there is no guarantee that it is correct. We also can't guarantee that Periscope or Twitter won't ban your accounts due to use or misuse of their system. Access to the Periscope system is governed by their Terms of Service.

Note: For readability purposes, all the JSON payloads in the example requests and responses have been "prettyfied". The actual JSON payloads are sent as single-line strings.

THIS SITE IS IN NO WAY AFFILIATED WITH PERISCOPE OR TWITTER INC. PERISCOPE AND TWITTER ARE REGISTERED TRADEMARKS OF TWITTER INC.

Changelog


  • Version 3.0 - actualization (2016)
    • All changes are here

  • Version 2.0 - 18th June 2015
    • Migrated to custom documentation platform
    • Added 5 new endpoints after additional research
    • In-depth documentation on parameters and response values
    • Examples of actual requests performed against the API

  • Version 1.0 - 1st June 2015
    • Initial Publication on Github Wiki
    • 38 Endpoints with basic documentation

Flowcharts

Login Flow

The flowchart below shows the API calls made by the iOS app upon logging in to the Periscope application.

The entry point in to the API is through the /loginTwitter endpoint, which converts the Twitter OAuth Token and Token Secret into a cookie value for use on all authenticated requests.

After this, the application proceeds to grab a list of the Featured Broadcasts, and Broadcasts from users that are being followed by the current user. These are the calls to /featuredBroadcastFeed and /followingBroadcastFeed.
Finally, the application appears to register the device token against the user, most likely allowing for notifications of broadcasts to be sent to the device. This is on the /registerToken endpoint.

Viewing a Broadcast Flow

When viewing a Broadcast, the Periscope application uses 4 endpoints from the API.

The /accessChannel endpoint is used to initiate the viewing. It enables retrieval of the access details, such as stream locations and PubNub channel and subscriber keys. It is likely that calling this endpoint marks you as a 'viewer' of the Broadcast, and would therefore appear in the Viewer list.

The application then uses the stream URL to playback the associated video with the Broadcast.

At this time, a connection to PubNub is established, which acts as the host of prescence, chat and heart realtime notifications. More details about this will be covered in additional documentation.

Every 30 seconds, the /pingWatching endpoint is called, which relays back to the API details such as the number of hearts given and the number of comments sent since the last call.

When ending the viewing, the /playbackMeta endpoint is called to provide Periscope with some feedback on the quality and experience that was encountered during the playback session.

Finally, /stopWatching ends the viewing session and sends the final tally of hearts and comments sent.

Creating a Broadcast Flow

Creating a Broadcast and streaming video is a little more in-depth than other actions on the Periscope API.

To begin with, the application uploads some padding data to a "signer" resource (located at https://signer.periscope.tv/upload) for two purposes: firstly, to gauge the connection speed for uploading purposes, and secondly to retrieve the AWS region closest to the current location.

A request to /createBroadcast is then made, using the region received from the Signer. This returns details that allow the video to be published to an RTMP server, along with PubNub details for subscribing to presence data, the chat and heart feeds.

Once the details of the broadcast are established, the video starts to be streamed to the RTMP server and a request to /publishBroadcast is made, providing details such as the Broadcast title, if the Broadcast is locked to certain users and whether the chat is locked down.

As with viewing a Broadcast, a ping is sent around every 30 seconds, in this case to /pingBroadcast. This provides an update to the API that the broadcast is still running, along with a debug log of connection details.

When the Broadcast is ending, a call to /broadcastMeta is made with debug information about the connection quality and speed.

Finally, /endBroadcast stops the Broadcast and returns some analytical data on the Broadcast, such as number of viewers and retention data.

Authentication

/loginTwitter - Login to the Periscope API
https://api.periscope.tv/api/v2/loginTwitter

This endpoint converts a Twitter OAuth Token and OAuth Secret into a Periscope cookie for use in future requests to other endpoints on the API. It is also used to feed OAuth Token and OAuth Secrets from Twitter Digits login requests (hence the 'phone_number' parameter).

The Twitter OAuth Token and OAuth Secret are obtained from the Twitter API using the Periscope OAuth Consumer and Consumer Secret. OAuth Tokens from other application contexts will not work.

When using this endpoint with Twitter Digits for the first time, some account creation must take place (namely on the /verifyUsername endpoint). Without this, the user will not have a Periscope username associated with the account.

Parameter Type Optional Description Default Value
session_secret string No Twitter OAuth Token Secret
session_key string No Twitter OAuth Token
user_id string No Twitter User ID (numeric)
user_name string Yes Twitter Username
phone_number string Yes Telephone Number
vendor_id string Yes Vendor ID
bundle_id string Yes Bundle ID com.bountylabs.periscope
Key Type Always Available Description
cookie string Yes Periscope Authentication Cookie
user User Yes A User object representing the logged-in user
suggested_username string Yes Suggested Username
settings UserSettings Yes A UserSettings object for the current user's settings
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/loginTwitter HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 291
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"session_secret" : "[HIDDEN]",
	"user_id" : "[HIDDEN]",
	"phone_number" : "",
	"vendor_id" : "[HIDDEN]",
	"bundle_id" : "com.bountylabs.periscope",
	"session_key" : "[HIDDEN]",
	"user_name" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:52:15 GMT
Expires: Wed, 17 Jun 2015 02:52:15 GMT
Last-Modified: Wed, 17 Jun 2015 02:52:15 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 2102
Connection: close

{
	"cookie" : "[HIDDEN]",
	"user" : {
		"class_name" : "User",
		"id" : "[HIDDEN]",
		"created_at" : "2015-05-27T13:42:24.873530251-07:00",
		"updated_at" : "2015-06-16T12:49:54.550719965-07:00",
		"is_beta_user" : false,
		"is_employee" : false,
		"is_twitter_verified" : false,
		"twitter_screen_name" : "[HIDDEN]",
		"username" : "[HIDDEN]",
		"display_name" : "[HIDDEN]",
		"description" : "[HIDDEN]",
		"profile_image_urls" : [
			{
				"url" : "[HIDDEN]",
				"ssl_url" : "[HIDDEN]",
				"width" : 360,
				"height" : 360
			}, {
				"url" : "[HIDDEN]",
				"ssl_url" : "[HIDDEN]",
				"width" : 256,
				"height" : 256
			}, {
				"url" : "[HIDDEN]",
				"ssl_url" : "[HIDDEN]",
				"width" : 128,
				"height" : 128
			}
		],
		"initials" : "",
		"n_followers" : 0,
		"n_following" : 0
	},
	"suggested_username" : "",
	"settings" : {
		"push_new_follower" : false,
		"auto_save_to_camera" : false
	}
}
/registerToken - Registers the device token
https://api.periscope.tv/api/v2/registerToken

This endpoint is only used by mobile devices only, and appears to register the current device token with the Periscope API, for notification purposes.

When a user logs out (see the /logout endpoint), the device token is sent too, indicating that notifications should no longer be sent to this device.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
token string Yes The Device Token ID
device_type string Yes The type of device being used (e.g. iPhone, iPad)
model string Yes The Apple Device Type (e.g "iPhone3,2", "iPad3,1")
os string Yes The iOS version number being used (e.g. "7.1.1", "8.1.3")
locale string Yes The language locale currently in use (e.g. "en")
build string Yes The full version string of the Periscope application v1.1
bundle_id string No Bundle ID com.bountylabs.periscope
vendor_id string No Vendor ID
install_id string Yes Install ID
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/registerToken HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 323
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"vendor_id" : "[HIDDEN]",
	"os" : "7.1.1",
	"bundle_id" : "com.bountylabs.periscope",
	"build" : "v1.1",
	"cookie" : "[HIDDEN]",
	"token" : "[HIDDEN]",
	"device_type" : "iPhone",
	"locale" : "en",
	"model" : "iPhone3,2"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:52:15 GMT
Expires: Wed, 17 Jun 2015 02:52:15 GMT
Last-Modified: Wed, 17 Jun 2015 02:52:15 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/login - ?? - Unused endpoint
https://api.periscope.tv/api/v2/login

This endpoint does not appear to be used currently in either iOS or Android versions of Periscope.

The parameters of the endpoint seem to suggest that it is used as a login mechanism using Facebook accounts, although no such functionality exists in the Periscope application.

More details will be added if and when the endpoint is utilised.

Parameter Type Optional Description Default Value
facebook_token string No
vendor_id string No Vendor ID
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
/validateUsername - Check username validity during registration
https://api.periscope.tv/api/v2/validateUsername

This endpoint is used to check the validity of a given username during the registration process, usually when logging in through a Phone Number.

A request is made each type a character is entered, and a status is returned indicating whether the entered value is acceptable.

Parameter Type Optional Description Default Value
session_key string Yes Twitter OAuth Token
session_secret string Yes Twitter OAuth Token Secret
username string No Periscope Username
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
errors array of ErrorObject Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter 
POST /api/v2/validateUsername HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 138
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"session_key" : "",
	"session_secret" : "",
	"username" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}

HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sat, 20 Jun 2015 12:48:39 GMT
Expires: Sat, 20 Jun 2015 12:48:39 GMT
Last-Modified: Sat, 20 Jun 2015 12:48:39 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 14
Connection: close

{
	"errors" : []
}
/verifyUsername - Confirm the chosen username
https://api.periscope.tv/api/v2/verifyUsername

This endpoint is used during the registration process, such as after logging in with a Phone Number.

After a user has chosen the username they wish to use with their Periscope account, this endpoint is called with the values to confirm the selection.

Upon success, a Periscope User object is returned listing the new user's details.

Parameter Type Optional Description Default Value
session_key string Yes Twitter OAuth Token
session_secret string Yes Twitter OAuth Token Secret
username string No Periscope Username
display_name string No A display name for the user
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
user User No A User object representing the a Periscope user
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter 
POST /api/v2/verifyUsername HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 173
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"display_name" : "[HIDDEN]",
	"session_key" : "",
	"username" : "[HIDDEN]",
	"session_secret" : "",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sat, 20 Jun 2015 12:49:17 GMT
Expires: Sat, 20 Jun 2015 12:49:17 GMT
Last-Modified: Sat, 20 Jun 2015 12:49:17 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 1048
Connection: close

{
	"user" : {
		"class_name" : "User",
		"id" : "[HIDDEN]",
		"created_at" : "2015-06-20T12:47:09.773315978-07:00",
		"updated_at" : "2015-06-20T12:49:17.392653068-07:00",
		"is_beta_user" : false,
		"is_employee" : false,
		"is_twitter_verified" : false,
		"twitter_screen_name" : "",
		"username" : "[HIDDEN]",
		"display_name" : "[HIDDEN]",
		"description" : "",
		"profile_image_urls" : [
			{
				"url" : "http://a0.twimg.com/sticky/default_profile_images/default_profile_0_reasonably_small.png",
				"ssl_url" : "https://a0.twimg.com/sticky/default_profile_images/default_profile_0_reasonably_small.png",
				"width" : 128,
				"height" : 128
			}, {
				"url" : "http://a0.twimg.com/sticky/default_profile_images/default_profile_0_200x200.png",
				"ssl_url" : "https://a0.twimg.com/sticky/default_profile_images/default_profile_0_200x200.png",
				"width" : 200,
				"height" : 200
			}, {
				"url" : "http://a0.twimg.com/sticky/default_profile_images/default_profile_0_400x400.png",
				"ssl_url" : "https://a0.twimg.com/sticky/default_profile_images/default_profile_0_400x400.png",
				"width" : 400,
				"height" : 400
			}
		],
		"initials" : "",
		"n_followers" : 0,
		"n_following" : 0
	},
	"success" : true
}
/logout - Logout from Periscope
https://api.periscope.tv/api/v2/logout

This endpoint logs you out from Periscope, and likely terminates the notifications that you would otherwise receive.

On iOS devices, vendor_id is sent along with the request, where as on Android, the install_id parameter is sent.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
vendor_id string Yes
install_id string Yes
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
500 Internal Server Error An Internal Server Error occurred (apparent bug with Android logout) 
POST /api/v2/logout HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 124
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"vendor_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:10:48 GMT
Expires: Wed, 17 Jun 2015 03:10:48 GMT
Last-Modified: Wed, 17 Jun 2015 03:10:48 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}

Broadcast Feeds

/featuredBroadcastFeed - [TODO - To be documented]
https://api.periscope.tv/api/v2/featuredBroadcastFeed

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
[none] array of Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/featuredBroadcastFeed HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 73
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:52:15 GMT
Expires: Wed, 17 Jun 2015 02:52:15 GMT
Last-Modified: Wed, 17 Jun 2015 02:52:15 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 1378
Connection: close

[
	{
		"class_name" : "Broadcast",
		"id" : "24075341",
		"created_at" : "2015-06-16T10:00:17.634505234-07:00",
		"updated_at" : "2015-06-16T13:32:49.353566238-07:00",
		"user_id" : "5243042",
		"user_display_name" : "The White House OSTP",
		"profile_image_url" : "http://pbs.twimg.com/profile_images/650977295/OSTP_reasonably_small.jpg",
		"state" : "ENDED",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-16T10:00:42.671401627-07:00",
		"ping" : "2015-06-16T10:11:12.765217233-07:00",
		"end" : "2015-06-16T10:11:19.699048851-07:00",
		"has_location" : true,
		"city" : "Washington",
		"country" : "",
		"country_state" : "",
		"iso_code" : "",
		"ip_lat" : 38.892,
		"ip_lng" : -77.037,
		"width" : 320,
		"height" : 568,
		"image_url" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live/IrcwEzo-FlecSb6iBgStvcACJMw0Sy8ccOqivUAwnOTnLm3JeLBsfcF_Zarc8rIfuGIJSebscIrke43gwsQWug==.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750093217\u0026Signature=IzFJeIiQZRbLZ0m4zqLPWYGsBWs%3D",
		"image_url_small" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live-thumb/IrcwEzo-FlecSb6iBgStvcACJMw0Sy8ccOqivUAwnOTnLm3JeLBsfcF_Zarc8rIfuGIJSebscIrke43gwsQWug==_thumb_128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750093217\u0026Signature=t8xYx6fbeflxQeewvhS1zwbOWWg%3D",
		"status" : "Come hang out by the @WhiteHouse beehive for pollinator week! 🐝🐝🐝",
		"available_for_replay" : true,
		"featured" : true,
		"sort_score" : 1434474042,
		"is_trusted" : false
	}
]
/followingBroadcastFeed - [TODO - To be documented]
https://api.periscope.tv/api/v2/followingBroadcastFeed

Broadcasts from users that are being followed by the current user.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
[none] array of Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/followingBroadcastFeed HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 73
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:52:15 GMT
Expires: Wed, 17 Jun 2015 02:52:15 GMT
Last-Modified: Wed, 17 Jun 2015 02:52:15 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 2614
Connection: close

[
	{
		"class_name" : "Broadcast",
		"id" : "[HIDDEN]",
		"created_at" : "2015-06-16T12:38:38.785998176-07:00",
		"updated_at" : "2015-06-16T12:39:39.657051618-07:00",
		"user_id" : "[HIDDEN]",
		"user_display_name" : "[HIDDEN]",
		"profile_image_url" : "http://abs.twimg.com/sticky/default_profile_images/default_profile_0_reasonably_small.png",
		"state" : "ENDED",
		"is_locked" : true,
		"friend_chat" : false,
		"start" : "2015-06-16T12:38:59.256337126-07:00",
		"ping" : "2015-06-16T12:39:27.970050544-07:00",
		"end" : "2015-06-16T12:39:39.657051618-07:00",
		"has_location" : false,
		"city" : "",
		"country" : "",
		"country_state" : "",
		"iso_code" : "GB",
		"ip_lat" : 0,
		"ip_lng" : 0,
		"width" : 320,
		"height" : 568,
		"image_url" : "[HIDDEN]",
		"image_url_small" : "[HIDDEN]",
		"status" : "Testing",
		"available_for_replay" : false,
		"featured" : false,
		"sort_score" : 1434483539,
		"is_trusted" : false
	},
	[... truncated]
]
/liveBroadcastFeed - [TODO - To be documented]
https://api.periscope.tv/api/v2/liveBroadcastFeed

[TODO - To be documented]

*NOTE* This endpoint returns a maximum of 51 results. There is no pagination available.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
[none] array of Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/liveBroadcastFeed HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 73
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:58:55 GMT
Expires: Wed, 17 Jun 2015 02:58:55 GMT
Last-Modified: Wed, 17 Jun 2015 02:58:55 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Connection: close
Content-Length: 63572

[
	{
		"class_name" : "Broadcast",
		"id" : "24409161",
		"created_at" : "2015-06-17T02:58:48.463414956-07:00",
		"updated_at" : "2015-06-17T02:58:54.937278003-07:00",
		"user_id" : "1113381",
		"user_display_name" : "Öztaşin Oğlu",
		"profile_image_url" : "http://pbs.twimg.com/profile_images/586624638937075714/ibZ62Lbk_reasonably_small.jpg",
		"state" : "RUNNING",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-17T02:58:54.937278003-07:00",
		"has_location" : true,
		"city" : "",
		"country" : "",
		"country_state" : "",
		"iso_code" : "",
		"ip_lat" : 0,
		"ip_lng" : 0,
		"width" : 320,
		"height" : 568,
		"image_url" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live/S5oFPVq4XwoF7q-QimzQoo9f8kfd1u8GiUnUefI07JRjK4WH9-uGm8duYtK-dZBPDlncfTy0D-yg05JZM4O4LA==.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750154328\u0026Signature=d%2BckV2YZlkRnWvTAkuK502Uy610%3D",
		"image_url_small" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live-thumb/S5oFPVq4XwoF7q-QimzQoo9f8kfd1u8GiUnUefI07JRjK4WH9-uGm8duYtK-dZBPDlncfTy0D-yg05JZM4O4LA==_thumb_128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750154328\u0026Signature=DIUZJi1vcy99h78zKOM8kcTPfWI%3D",
		"status" : "Ä°syan",
		"available_for_replay" : false,
		"featured" : false,
		"sort_score" : 1434535134,
		"is_trusted" : false
	}, 
	[... truncated]
]
/mapBroadcastFeed
https://api.periscope.tv/api/v2/mapBroadcastFeed

Returns list of newest broadcasts (created after defined time)

*NOTE*

Maximal count of returned objects is 250, but for values higher than 230 it returns two less objects.

This endpoint can be used as a stream, as it supports the "since" parameter.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
count integer Yes Count of returned objects 50
since integer Yes POSIX timestamp
Key Type Always Available Description
[none] array of Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/mapBroadcastFeed HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 104
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"count" : 250,
	"cookie" : "[HIDDEN]",
	"since" : 1434535085
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:58:18 GMT
Expires: Wed, 17 Jun 2015 02:58:18 GMT
Last-Modified: Wed, 17 Jun 2015 02:58:18 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Connection: close
Content-Length: 14004

[
	{
		"class_name" : "Broadcast",
		"id" : "24408748",
		"created_at" : "2015-06-17T02:56:44.959401817-07:00",
		"updated_at" : "2015-06-17T02:58:15.317365313-07:00",
		"user_id" : "317158",
		"user_display_name" : "Lindsey Mastis",
		"profile_image_url" : "http://pbs.twimg.com/profile_images/584126571532922880/PiyQVmhc_reasonably_small.jpg",
		"state" : "RUNNING",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-17T02:58:15.317365313-07:00",
		"has_location" : true,
		"city" : "Tampa",
		"country" : "",
		"country_state" : "Florida",
		"iso_code" : "",
		"ip_lat" : 27.945,
		"ip_lng" : -82.46,
		"width" : 320,
		"height" : 568,
		"image_url" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live/xkOSnSBtUbIaihjKmzEhXayEu8715SACajESDK9SlzKed4eUpKaGv2CZpU8BD_EXFMzwCi4anqiZTTtnlMLpAQ==.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750154204\u0026Signature=CfiGsHXwuIoq5TVHs40DRTY%2BdYs%3D",
		"image_url_small" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live-thumb/xkOSnSBtUbIaihjKmzEhXayEu8715SACajESDK9SlzKed4eUpKaGv2CZpU8BD_EXFMzwCi4anqiZTTtnlMLpAQ==_thumb_128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750154204\u0026Signature=cjpBVynaQoRr1NAuTvYZaDOffsQ%3D",
		"status" : "Live in the newsroom!! Talking about rain from Tropical Depression Bill! 💦💦💦",
		"available_for_replay" : false,
		"featured" : false,
		"sort_score" : 1434535095,
		"is_trusted" : false
	},
	[... truncated]
]
/globalBroadcastFeed - DEPRECATED
https://api.periscope.tv/api/v2/globalBroadcastFeed

Deprecated. Always returns empty array.

/rankedBroadcastFeed - [TODO - To be documented]
https://api.periscope.tv/api/v2/rankedBroadcastFeed

Returns broadcasts from third tab in the official app, "Top broadcasts"

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
languages array of string Yes Array of lang codes, for example ["en","ru"]
Key Type Always Available Description
[none] array of Broadcast Yes Top broadcasts
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/broadcastSearch - Search broadcasts by title
https://api.periscope.tv/api/v2/broadcastSearch

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
query string Yes ?
search string No Search string
include_replay boolean Yes Whether to include replays to results false
Key Type Always Available Description
[none] array of Broadcast Yes Search results
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found

Viewing Broadcasts

/accessChannel - [TODO - To be documented]
https://api.periscope.tv/api/v2/accessChannel

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
from_push boolean Yes false
uses_sessions boolean Yes true
entry_ticket string Yes
Key Type Always Available Description
subscriber string Yes
publisher string Yes
auth_token string Yes
signer_key string Yes
signer_token string Yes
participant_index integer Yes
channel string Yes
read_only boolean Yes
should_log boolean Yes
should_verify_signature boolean Yes
rtmp_url string Yes
hls_url string Yes
https_hls_url string Yes
type string Yes
broadcast Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found The Broadcast associated with the provided broadcast_id could not be found 
POST /api/v2/accessChannel HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 156
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"from_push" : false,
	"broadcast_id" : "[HIDDEN]",
	"uses_sessions" : true,
	"entry_ticket" : "",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:00:33 GMT
Expires: Wed, 17 Jun 2015 03:00:33 GMT
Last-Modified: Wed, 17 Jun 2015 03:00:33 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 4330
Connection: close

{
	"subscriber" : "sub-c-[HIDDEN]",
	"publisher" : "pub-c-[HIDDEN]",
	"auth_token" : "[HIDDEN]",
	"signer_key" : "[HIDDEN]",
	"signer_token" : "[HIDDEN]",
	"participant_index" : 1148,
	"channel" : "[HIDDEN]",
	"read_only" : false,
	"should_log" : false,
	"should_verify_signature" : false,
	"session" : "[HIDDEN]",
	"rtmp_url" : "rtmp://prod-edge-WowzaSta-6X3TM8RGUQXX-1282566113.us-east-1.elb.amazonaws.com:80/liveedge/[HIDDEN]?t=[HIDDEN]",
	"hls_url" : "http://periscope-prod-us-east-1.global.ssl.fastly.net/i01128ca8/liveorigin/[HIDDEN]/playlist.m3u8?t=[HIDDEN]",
	"https_hls_url" : "https://periscope-prod-us-east-1.global.ssl.fastly.net/i01128ca8/liveorigin/[HIDDEN]/playlist.m3u8?t=[HIDDEN]",
	"type" : "StreamTypeLowLatency",
	"broadcast" : {
		"class_name" : "Broadcast",
		"id" : "24397177",
		"created_at" : "2015-06-17T01:58:41.434051175-07:00",
		"updated_at" : "2015-06-17T03:00:31.983222044-07:00",
		"user_id" : "603096",
		"user_display_name" : "Meredith Anderson",
		"profile_image_url" : "http://pbs.twimg.com/profile_images/468578101559959552/4Fugqhre_reasonably_small.jpeg",
		"state" : "RUNNING",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-17T02:00:02.203657007-07:00",
		"ping" : "2015-06-17T03:00:31.983222044-07:00",
		"has_location" : true,
		"city" : "North Augusta",
		"country" : "",
		"country_state" : "South Carolina",
		"iso_code" : "",
		"ip_lat" : 33.505,
		"ip_lng" : -81.962,
		"width" : 320,
		"height" : 568,
		"image_url" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live/lDcXMGobW1rQEQgRRMY_csTfTLH3QgZT3Plb2bqOLytGlJ5SH8dcPxIMwcUi5E9YNQ5uXHJw36iOd3NirGZpPg==.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750150721\u0026Signature=DQLk%2FG7XK%2FhAxs4jHToXTLMhIwc%3D",
		"image_url_small" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live-thumb/lDcXMGobW1rQEQgRRMY_csTfTLH3QgZT3Plb2bqOLytGlJ5SH8dcPxIMwcUi5E9YNQ5uXHJw36iOd3NirGZpPg==_thumb_128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750150721\u0026Signature=HL3ayoTPUkfaps89Uxg8JVdMDz8%3D",
		"status" : "A live broadcast...of a live broadcast. Hang out on the anchor desk at the CBS in Augusta GA",
		"available_for_replay" : false,
		"featured" : false
	}
}
/getBroadcastViewers - [TODO - To be documented]
https://api.periscope.tv/api/v2/getBroadcastViewers

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
Key Type Always Available Description
live array of User Yes
replay array of User No
n_web_watched integer Yes
n_replay_watched integer Yes
n_watched integer Yes
n_hearts integer Yes
n_replay_hearts integer No
time_watched integer No
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/getBroadcastViewers HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 99
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "24075341",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 02:52:32 GMT
Expires: Wed, 17 Jun 2015 02:52:32 GMT
Last-Modified: Wed, 17 Jun 2015 02:52:32 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Connection: close
Content-Length: 57838

{
	"live" : [
		{
			"class_name" : "User",
			"id" : "249283",
			"created_at" : "2015-03-28T00:31:51.200777475Z",
			"updated_at" : "2015-06-16T18:41:15.358276046-07:00",
			"is_beta_user" : false,
			"is_employee" : false,
			"is_twitter_verified" : false,
			"twitter_screen_name" : "JordanKaufman",
			"username" : "JordanKaufman",
			"display_name" : "Jordan Kaufman",
			"description" : "Avid Steelers, Penguins, Pirates, Penn State, Liverpool FC fan",
			"profile_image_urls" : [{
					"url" : "http://pbs.twimg.com/profile_images/600291809068199936/fT-sxrQl_reasonably_small.jpg",
					"ssl_url" : "https://pbs.twimg.com/profile_images/600291809068199936/fT-sxrQl_reasonably_small.jpg",
					"width" : 128,
					"height" : 128
				}, {
					"url" : "http://pbs.twimg.com/profile_images/600291809068199936/fT-sxrQl_200x200.jpg",
					"ssl_url" : "https://pbs.twimg.com/profile_images/600291809068199936/fT-sxrQl_200x200.jpg",
					"width" : 200,
					"height" : 200
				}, {
					"url" : "http://pbs.twimg.com/profile_images/600291809068199936/fT-sxrQl_400x400.jpg",
					"ssl_url" : "https://pbs.twimg.com/profile_images/600291809068199936/fT-sxrQl_400x400.jpg",
					"width" : 400,
					"height" : 400
				}
			],
			"initials" : "JK",
			"n_followers" : 12,
			"n_following" : 124,
			"participant_index" : 547,
			"n_hearts_given" : 10,
			"start" : "2015-06-16T10:11:06.518313963-07:00"
		},
		[... truncated]
	],
	"replay" : [
		{
			"class_name" : "User",
			"id" : "5220383",
			"created_at" : "2015-06-16T01:05:38.090726270-07:00",
			"updated_at" : "2015-06-16T05:39:49.085088771-07:00",
			"is_beta_user" : false,
			"is_employee" : false,
			"is_twitter_verified" : false,
			"twitter_screen_name" : "tomhashes",
			"username" : "tomhashes",
			"display_name" : "Tom",
			"description" : "I tweet for my own pleasure, so please don't be too bothered by my words.",
			"profile_image_urls" : [{
					"url" : "http://pbs.twimg.com/profile_images/561820119731425281/6bCGsUE6_reasonably_small.jpeg",
					"ssl_url" : "https://pbs.twimg.com/profile_images/561820119731425281/6bCGsUE6_reasonably_small.jpeg",
					"width" : 128,
					"height" : 128
				}, {
					"url" : "http://pbs.twimg.com/profile_images/561820119731425281/6bCGsUE6_200x200.jpeg",
					"ssl_url" : "https://pbs.twimg.com/profile_images/561820119731425281/6bCGsUE6_200x200.jpeg",
					"width" : 200,
					"height" : 200
				}, {
					"url" : "http://pbs.twimg.com/profile_images/561820119731425281/6bCGsUE6_400x400.jpeg",
					"ssl_url" : "https://pbs.twimg.com/profile_images/561820119731425281/6bCGsUE6_400x400.jpeg",
					"width" : 400,
					"height" : 400
				}
			],
			"initials" : "",
			"n_followers" : 0,
			"n_following" : 5,
			"replay_watched_time" : "2015-06-17T02:52:27.333711384-07:00",
			"n_hearts_given" : 0
		}, 
		[... truncated]
	],
	"n_web_watched" : 475,
	"n_replay_watched" : 25375,
	"n_watched" : 559,
	"n_hearts" : 5516,
	"n_replay_hearts" : 155906
}
/getBroadcasts - [TODO - To be documented]
https://api.periscope.tv/api/v2/getBroadcasts

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_ids array of string No A list of Periscope Broadcast IDs
Key Type Always Available Description
[none] array of Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/getBroadcasts HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 102
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_ids" : ["24397177"],
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:00:46 GMT
Expires: Wed, 17 Jun 2015 03:00:46 GMT
Last-Modified: Wed, 17 Jun 2015 03:00:46 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 1379
Connection: close

[
	{
		"class_name" : "Broadcast",
		"id" : "24397177",
		"created_at" : "2015-06-17T01:58:41.434051175-07:00",
		"updated_at" : "2015-06-17T03:00:31.983222044-07:00",
		"user_id" : "603096",
		"user_display_name" : "Meredith Anderson",
		"profile_image_url" : "http://pbs.twimg.com/profile_images/468578101559959552/4Fugqhre_reasonably_small.jpeg",
		"state" : "RUNNING",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-17T02:00:02.203657007-07:00",
		"ping" : "2015-06-17T03:00:31.983222044-07:00",
		"has_location" : true,
		"city" : "North Augusta",
		"country" : "",
		"country_state" : "South Carolina",
		"iso_code" : "",
		"ip_lat" : 33.505,
		"ip_lng" : -81.962,
		"width" : 320,
		"height" : 568,
		"image_url" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live/lDcXMGobW1rQEQgRRMY_csTfTLH3QgZT3Plb2bqOLytGlJ5SH8dcPxIMwcUi5E9YNQ5uXHJw36iOd3NirGZpPg==.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750150721\u0026Signature=DQLk%2FG7XK%2FhAxs4jHToXTLMhIwc%3D",
		"image_url_small" : "https://s3-us-west-2.amazonaws.com/periscope-thumbnail-live-thumb/lDcXMGobW1rQEQgRRMY_csTfTLH3QgZT3Plb2bqOLytGlJ5SH8dcPxIMwcUi5E9YNQ5uXHJw36iOd3NirGZpPg==_thumb_128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1750150721\u0026Signature=HL3ayoTPUkfaps89Uxg8JVdMDz8%3D",
		"status" : "A live broadcast...of a live broadcast. Hang out on the anchor desk at the CBS in Augusta GA",
		"available_for_replay" : false,
		"featured" : false,
		"n_watching" : 48,
		"n_web_watching" : 0
	}
]
/pingWatching - [TODO - To be documented]
https://api.periscope.tv/api/v2/pingWatching

[TODO - To be documented]

*NOTE*

This endpoint requires requests of type "multipart/form-data", and not the tranditional JSON payload request.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string Yes Periscope Broadcast ID
session string No "session" field of startWatching response
n_comments integer No Number of comments
n_hearts integer No Number of hearts
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/pingWatching HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 533
Content-Type: multipart/form-data; boundary=Boundary+3182420D22888A97
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

--Boundary+3182420D22888A97
Content-Disposition: form-data; name="broadcast_id"

24397177
--Boundary+3182420D22888A97
Content-Disposition: form-data; name="cookie"

[HIDDEN]
--Boundary+3182420D22888A97
Content-Disposition: form-data; name="n_comments"

0
--Boundary+3182420D22888A97
Content-Disposition: form-data; name="n_hearts"

0
--Boundary+3182420D22888A97
Content-Disposition: form-data; name="session"

[HIDDEN]
--Boundary+3182420D22888A97--
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:03:12 GMT
Expires: Wed, 17 Jun 2015 03:03:12 GMT
Last-Modified: Wed, 17 Jun 2015 03:03:12 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/startWatching - [TODO - To be documented]
https://api.periscope.tv/api/v2/startWatching

Called when user is starting broadcast playback

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
auto_play boolean No
life_cycle_token string No "life_cycle_token" field of accessVideo response
Key Type Always Available Description
session string Yes Session identifier used in pingWatching requests
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/playbackMeta - [TODO - To be documented]
https://api.periscope.tv/api/v2/playbackMeta

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
stats StatsViewing No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/playbackMeta HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 447
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "24397177",
	"cookie" : "[HIDDEN]",
	"stats" : {
		"FrameRate_min" : 0,
		"pn_connect_t" : 0.1447740197181702,
		"FrameRate_max" : 39.65163756685289,
		"FrameRate_mean" : 19.73801039110267,
		"pn_pres_rec" : 270,
		"FrameRate_stddev" : 8.145872785867265,
		"LostConnection_duration" : 6.407410979270935,
		"pn_msg_drop" : 1,
		"pn_disconnect_t" : 0,
		"BatteryDrainPerMinute" : 0,
		"LostConnection_count" : 2,
		"pn_msg_sent" : 0,
		"pn_msg_rec" : 0
	}
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:04:03 GMT
Expires: Wed, 17 Jun 2015 03:04:03 GMT
Last-Modified: Wed, 17 Jun 2015 03:04:03 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/stopWatching - [TODO - To be documented]
https://api.periscope.tv/api/v2/stopWatching

[TODO - To be documented]

*NOTE*

This endpoint requires requests of type "multipart/form-data", and not the tranditional JSON payload request.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
session string No
n_comments integer No
n_hearts integer No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/stopWatching HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 533
Content-Type: multipart/form-data; boundary=Boundary+FFF97DC9700923A8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

--Boundary+FFF97DC9700923A8
Content-Disposition: form-data; name="broadcast_id"

24397177
--Boundary+FFF97DC9700923A8
Content-Disposition: form-data; name="cookie"

[HIDDEN]
--Boundary+FFF97DC9700923A8
Content-Disposition: form-data; name="n_comments"

0
--Boundary+FFF97DC9700923A8
Content-Disposition: form-data; name="n_hearts"

0
--Boundary+FFF97DC9700923A8
Content-Disposition: form-data; name="session"

[HIDDEN]
--Boundary+FFF97DC9700923A8--
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:04:03 GMT
Expires: Wed, 17 Jun 2015 03:04:03 GMT
Last-Modified: Wed, 17 Jun 2015 03:04:03 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/userBroadcasts - [TODO - To be documented]
https://api.periscope.tv/api/v2/userBroadcasts

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
user_id string No Periscope User ID
all boolean Yes
Key Type Always Available Description
[none] array of Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/userBroadcasts HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 104
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"user_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]",
	"all" : true
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:07:30 GMT
Expires: Wed, 17 Jun 2015 03:07:30 GMT
Last-Modified: Wed, 17 Jun 2015 03:07:30 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 14321
Connection: close

[
	{
		"class_name" : "Broadcast",
		"id" : "[HIDDEN]",
		"created_at" : "2015-06-17T03:04:32.563328960-07:00",
		"updated_at" : "2015-06-17T03:06:12.209193637-07:00",
		"user_id" : "[HIDDEN]",
		"user_display_name" : "[HIDDEN]",
		"profile_image_url" : "[HIDDEN]",
		"state" : "ENDED",
		"is_locked" : true,
		"friend_chat" : false,
		"start" : "2015-06-17T03:04:59.527621229-07:00",
		"ping" : "2015-06-17T03:05:58.023499194-07:00",
		"end" : "2015-06-17T03:06:12.209193637-07:00",
		"has_location" : false,
		"city" : "",
		"country" : "",
		"country_state" : "",
		"iso_code" : "GB",
		"ip_lat" : 0,
		"ip_lng" : 0,
		"width" : 320,
		"height" : 568,
		"image_url" : "[HIDDEN]",
		"image_url_small" : "[HIDDEN]",
		"status" : "Testing",
		"available_for_replay" : false,
		"featured" : false,
		"n_watching" : 0,
		"n_web_watching" : 0
	},
	[... truncated]
]
/markAbuse - [TODO - To be documented]
https://api.periscope.tv/api/v2/markAbuse

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/getAccessPublic - [TODO - To be documented]
https://api.periscope.tv/api/v2/getAccessPublic?broadcast_id=[broadcast_id]

Returns information for playing broadcast in browser
*NOTE*

This can be a GET request, with the broadcast_id parameter appearing as a query string parameter, and can be POST request with JSON payload.

Parameter Type Optional Description Default Value
broadcast_id string No
Key Type Always Available Description
subscriber string Yes Key for "subscribe" requests to PubNub
publisher string Yes key for "publish" requests to PubNub
auth_token string Yes
signer_key string Yes
signer_token string Yes Signer token for requests to signer.periscope.tv/sign
participant_index integer Yes Participant index for requests to signer.periscope.tv/sign
channel string Yes
read_only boolean Yes
should_log boolean Yes
should_verify_signature boolean Yes
access_token string Yes
key array of integer No
endpoint string Yes Url of chatman
session string Yes
replay_url string No Link to playlist.m3u8 with replay
cookies array of ReplayCookie No
type string Yes
hls_url string No
https_hls_url string No
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter 
GET /api/v2/getAccessPublic?token=aFsD4TMyOTEzNTZ8MjgxMTY0MDSScfOtIuWl4fJc0OJUtfzpSgt0P-PTzlVtdkxuQj-PuQ%3D%3D HTTP/1.1
Host: api.periscope.tv
Connection: keep-alive
Pragma: no-cache
Cache-Control: no-cache
Accept: text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/43.0.2357.124 Safari/537.36
Accept-Encoding: gzip, deflate, sdch
Accept-Language: en-US,en;q=0.8

HTTP/1.1 200 OK
Access-Control-Allow-Method: GET, OPTIONS
Access-Control-Allow-Origin: *
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 13:15:23 GMT
Expires: Wed, 24 Jun 2015 13:15:23 GMT
Last-Modified: Wed, 24 Jun 2015 13:15:23 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 1848
Connection: keep-alive

{
	"subscriber" : "sub-c-[HIDDEN]",
	"publisher" : "",
	"auth_token" : "[HIDDEN]",
	"signer_key" : "[HIDDEN]",
	"signer_token" : "",
	"participant_index" : 0,
	"channel" : "[hidden]",
	"read_only" : true,
	"should_log" : false,
	"should_verify_signature" : false,
	"access_token" : "",
	"key" : [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
	"endpoint" : "",
	"session" : "[hidden]",
	"hls_url" : "http://periscope-prod-us-east-1.global.ssl.fastly.net/idecbcd0e/liveorigin/[HIDDEN]/playlist.m3u8?t=[HIDDEN]",
	"https_hls_url" : "https://periscope-prod-us-east-1.global.ssl.fastly.net/idecbcd0e/liveorigin/[HIDDEN]/playlist.m3u8?t=[HIDDEN]",
	"type" : "StreamTypeWeb"
}
/accessVideoPublic - [TODO - To be documented]
https://api.periscope.tv/api/v2/accessVideoPublic?broadcast_id=[broadcast_id]

Returns information for playing broadcast in browser
*NOTE*

This can be a GET request, with the broadcast_id parameter appearing as a query string parameter, and can be POST request with JSON payload.

Parameter Type Optional Description Default Value
broadcast_id string No
Key Type Always Available Description
broadcast Broadcast Yes Info about broadcast
chat_token string Yes
cookies array of ReplayCookie No
life_cycle_token string Yes
replay_url string No Link to playlist.m3u8 with replay
session string Yes
type string Yes
hls_url string No
https_hls_url string No
type string Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
/publicReplayThumbnailPlaylist - [TODO - To be documented]
https://api.periscope.tv/api/v2/publicReplayThumbnailPlaylist?broadcast_id=[broadcast_id]

Returns urls of screenshots

Parameter Type Optional Description Default Value
broadcast_id string No
session_id string No
Key Type Always Available Description
chunks array of chunks Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
/getBroadcastPublic - [TODO - To be documented]
https://api.periscope.tv/api/v2/getBroadcastPublic?token=[token]&

[TODO - To be documented]

*NOTE*

This is a GET request, with the token parameter appearing as a query string parameter, and not as a JSON payload.

Parameter Type Optional Description Default Value
token string No
Key Type Always Available Description
user User Yes
broadcast Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
404 Not Found

Creating Broadcasts

/broadcastMeta - [TODO - To be documented]
https://api.periscope.tv/api/v2/broadcastMeta

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
stats StatsBroadcasting No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/broadcastMeta HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 699
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]",
	"stats" : {
		"TransmitOK" : true,
		"pn_pres_rec" : 1,
		"BatteryDrainPerMinute" : 0,
		"UploadRate_stddev" : 0,
		"pn_msg_sent" : 0,
		"pn_msg_rec" : 0,
		"VideoOutputRate_min" : 3.750316451472078,
		"VideoOutputRate_mean" : 122.5657899455187,
		"VideoOutputRate_max" : 187.3704751541802,
		"UploadRate_min" : 138,
		"VideoIndexRatio_mean" : 78.43095688596649,
		"pn_disconnect_t" : 0,
		"VideoIndexRatio_stddev" : 34.23126647573314,
		"VideoIndexRatio_min" : 2.255405496092962,
		"pn_connect_t" : 0.4042350053787231,
		"VideoIndexRatio_max" : 121.232476468357,
		"pn_msg_drop" : 0,
		"VideoOK" : false,
		"UploadRate_mean" : 138,
		"UploadRate_max" : 138,
		"VideoOutputRate_stddev" : 52.27619530109718
	}
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:39:41 GMT
Expires: Sun, 21 Jun 2015 13:39:41 GMT
Last-Modified: Sun, 21 Jun 2015 13:39:41 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/createBroadcast - [TODO - To be documented]
https://api.periscope.tv/api/v2/createBroadcast

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
height integer No
width integer No
region string No eu-central-1
Key Type Always Available Description
subscriber string Yes
publisher string Yes
auth_token string Yes
signer_key string Yes
signer_token string Yes
participant_index integer Yes
channel string Yes
read_only boolean Yes
should_log boolean Yes
should_verify_signature boolean Yes
broadcast Broadcast Yes
protocol string Yes
host string Yes
application string Yes
stream_name string Yes
credential string Yes
private_protocol string Yes
private_port integer Yes
upload_url string Yes
thumbnail_upload_url string Yes
can_share_twitter boolean Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
500 Internal Server Error An Internal Server Error occurred 
POST /api/v2/createBroadcast HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 122
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"height" : 568,
	"width" : 320,
	"region" : "eu-central-1",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:39:02 GMT
Expires: Sun, 21 Jun 2015 13:39:02 GMT
Last-Modified: Sun, 21 Jun 2015 13:39:02 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 4308
Connection: close

{
	"subscriber" : "sub-c-[HIDDEN]",
	"publisher" : "pub-c-[HIDDEN]",
	"auth_token" : "[HIDDEN]",
	"signer_key" : "[HIDDEN]",
	"signer_token" : "[HIDDEN]",
	"participant_index" : 0,
	"channel" : "[HIDDEN]",
	"read_only" : false,
	"should_log" : true,
	"should_verify_signature" : false,
	"broadcast" : {
		"class_name" : "Broadcast",
		"id" : "[HIDDEN]",
		"created_at" : "2015-06-21T13:39:02.638343920-07:00",
		"updated_at" : "2015-06-21T13:39:02.638343920-07:00",
		"user_id" : "[HIDDEN]",
		"user_display_name" : "[HIDDEN]",
		"profile_image_url" : "[HIDDEN]",
		"state" : "NOT_STARTED",
		"is_locked" : false,
		"friend_chat" : false,
		"has_location" : false,
		"city" : "",
		"country" : "United Kingdom",
		"country_state" : "",
		"iso_code" : "GB",
		"ip_lat" : 0.0,
		"ip_lng" : 0.0,
		"width" : 320,
		"height" : 568,
		"image_url" : "[HIDDEN]",
		"image_url_small" : "[HIDDEN]",
		"status" : "",
		"available_for_replay" : false,
		"featured" : false,
		"Host" : "ec2-52-28-12-221.eu-central-1.compute.amazonaws.com",
		"Application" : "liveorigin",
		"OriginId" : "[HIDDEN]",
		"Region" : "eu-central-1",
		"lock" : null,
		"stream_name" : "[HIDDEN]",
		"hidden" : false,
		"replay_saved_by_server" : false,
		"replay_uploaded" : false,
		"replay_deleted" : false
	},
	"protocol" : "RTMP",
	"host" : "ec2-52-28-12-221.eu-central-1.compute.amazonaws.com",
	"port" : 80,
	"application" : "liveorigin",
	"stream_name" : "[HIDDEN]",
	"credential" : "[HIDDEN]",
	"private_protocol" : "RTMPS",
	"private_port" : 443,
	"upload_url" : "[HIDDEN]",
	"thumbnail_upload_url" : "[HIDDEN]",
	"can_share_twitter" : true
}
/endBroadcast - [TODO - To be documented]
https://api.periscope.tv/api/v2/endBroadcast

[TODO - To be documented]

*NOTE*

This endpoint requires requests of type "multipart/form-data", and not the tranditional JSON payload request.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
log string No
Key Type Always Available Description
broadcast Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/endBroadcast HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 24265
Content-Type: multipart/form-data; boundary=Boundary+C114956F18C0ABB8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

--Boundary+C114956F18C0ABB8
Content-Disposition: form-data; name="broadcast_id"

[HIDDEN]
--Boundary+C114956F18C0ABB8
Content-Disposition: form-data; name="cookie"

[HIDDEN]
--Boundary+C114956F18C0ABB8
Content-Disposition: form-data; name="log"; filename="log.txt"
Content-Type: text/plain

2015-06-21 20:38:48 +0000: [HIDDEN LOG ENTRY]
2015-06-21 20:38:48 +0000: [HIDDEN LOG ENTRY]
[... truncated]

--Boundary+C114956F18C0ABB8--
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:39:48 GMT
Expires: Sun, 21 Jun 2015 13:39:48 GMT
Last-Modified: Sun, 21 Jun 2015 13:39:48 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 1974
Connection: close

{
	"broadcast" : {
		"class_name" : "Broadcast",
		"id" : "[HIDDEN]",
		"created_at" : "2015-06-21T13:39:02.638343920-07:00",
		"updated_at" : "2015-06-21T13:39:48.410010242-07:00",
		"user_id" : "[HIDDEN]",
		"user_display_name" : "[HIDDEN]",
		"profile_image_url" : "[HIDDEN]",
		"state" : "ENDED",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-21T13:39:39.904612974-07:00",
		"end" : "2015-06-21T13:39:48.410010242-07:00",
		"has_location" : false,
		"city" : "",
		"country" : "",
		"country_state" : "",
		"iso_code" : "GB",
		"ip_lat" : 0,
		"ip_lng" : 0,
		"width" : 320,
		"height" : 568,
		"image_url" : "[HIDDEN]",
		"image_url_small" : "[HIDDEN]",
		"status" : "Testing",
		"available_for_replay" : true,
		"featured" : false,
		"Host" : "ec2-52-28-12-221.eu-central-1.compute.amazonaws.com",
		"Application" : "liveorigin",
		"OriginId" : "[HIDDEN]",
		"Region" : "eu-central-1",
		"lock" : null,
		"stream_name" : "[HIDDEN]",
		"hidden" : false,
		"replay_saved_by_server" : true,
		"replay_uploaded" : false,
		"replay_deleted" : false,
		"n_watching" : 1,
		"n_watching_web" : 0,
		"n_web_watched" : 0,
		"n_replay_watched" : 0,
		"n_watched" : 1,
		"lost_before_end" : 0,
		"watched_time" : 7,
		"n_hearts" : 0,
		"n_replay_hearts" : 0,
		"n_comments" : 0,
		"watched_time_calculated" : 0,
		"watched_time_implied" : 7,
		"join_time_average" : 1.434919181e+09,
		"join_time_count" : 1
	}
}
/pingBroadcast - [TODO - To be documented]
https://api.periscope.tv/api/v2/pingBroadcast

[TODO - To be documented]

*NOTE*

This endpoint requires requests of type "multipart/form-data", and not the tranditional JSON payload request.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
log string No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/pingBroadcast HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 25173
Content-Type: multipart/form-data; boundary=Boundary+F904998EC265EDBE
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

--Boundary+F904998EC265EDBE
Content-Disposition: form-data; name="broadcast_id"

[HIDDEN]
--Boundary+F904998EC265EDBE
Content-Disposition: form-data; name="cookie"

[HIDDEN]
--Boundary+F904998EC265EDBE
Content-Disposition: form-data; name="log"; filename="log.txt"
Content-Type: text/plain

2015-06-22 13:40:25 +0000: [HIDDEN LOG ENTRY]
2015-06-22 13:40:25 +0000: [HIDDEN LOG ENTRY]
[... truncated]

--Boundary+F904998EC265EDBE--
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Mon, 22 Jun 2015 06:42:54 GMT
Expires: Mon, 22 Jun 2015 06:42:54 GMT
Last-Modified: Mon, 22 Jun 2015 06:42:54 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/publishBroadcast - [TODO - To be documented]
https://api.periscope.tv/api/v2/publishBroadcast

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
session_key string No
session_secret string No
friend_chat boolean No
lock array of string No
status string No
has_location boolean No
lat float No
lng float No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/publishBroadcast HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 326
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"session_secret" : "[HIDDEN]",
	"has_location" : false,
	"lat" : 0,
	"lng" : 0,
	"friend_chat" : false,
	"cookie" : "[HIDDEN]",
	"session_key" : "[HIDDEN]",
	"status" : "Testing",
	"lock" : false,
	"broadcast_id" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Mon, 22 Jun 2015 06:42:24 GMT
Expires: Mon, 22 Jun 2015 06:42:24 GMT
Last-Modified: Mon, 22 Jun 2015 06:42:24 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/deleteBroadcast - [TODO - To be documented]
https://api.periscope.tv/api/v2/deleteBroadcast

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/deleteBroadcast HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 99
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:40:17 GMT
Expires: Sun, 21 Jun 2015 13:40:17 GMT
Last-Modified: Sun, 21 Jun 2015 13:40:17 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/broadcastSummary - [TODO - To be documented]
https://api.periscope.tv/api/v2/broadcastSummary

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
Key Type Always Available Description
meta StatsMeta Yes
broadcast Broadcast Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/broadcastSummary HTTP/1.1
Host: api.periscope.tv
Content-Type: application/json
Accept: */*
Accept-Encoding: gzip, deflate
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)
Cache-Control: no-cache
Content-Length: 111

{
    "cookie": "[HIDDEN]",
    "broadcast_id": "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 08:42:13 GMT
Expires: Wed, 24 Jun 2015 08:42:13 GMT
Last-Modified: Wed, 24 Jun 2015 08:42:13 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 2023
Connection: keep-alive

{
	"broadcast" : {
		"class_name" : "Broadcast",
		"id" : "[HIDDEN]",
		"created_at" : "2015-06-24T08:04:53.580458455-07:00",
		"updated_at" : "2015-06-24T08:15:03.608674477-07:00",
		"user_id" : "[HIDDEN]",
		"user_display_name" : "[HIDDEN]",
		"profile_image_url" : "[HIDDEN]",
		"state" : "ENDED",
		"is_locked" : false,
		"friend_chat" : false,
		"start" : "2015-06-24T08:05:28.583979254-07:00",
		"ping" : "2015-06-24T08:14:51.858146778-07:00",
		"end" : "2015-06-24T08:15:03.608674477-07:00",
		"has_location" : false,
		"city" : "",
		"country" : "",
		"country_state" : "",
		"iso_code" : "GB",
		"ip_lat" : 0,
		"ip_lng" : 0,
		"width" : 320,
		"height" : 568,
		"image_url" : "[HIDDEN]",
		"image_url_small" : "[HIDDEN]",
		"status" : "Testing",
		"available_for_replay" : true,
		"featured" : false,
		"Host" : "ec2-52-28-102-229.eu-central-1.compute.amazonaws.com",
		"Application" : "liveorigin",
		"OriginId" : "[HIDDEN]",
		"Region" : "eu-central-1",
		"lock" : false,
		"stream_name" : "[HIDDEN]",
		"hidden" : false,
		"replay_saved_by_server" : true,
		"replay_uploaded" : false,
		"replay_deleted" : false
	},
	"meta" : {
		"n_watching" : 0,
		"n_watching_web" : 0,
		"n_web_watched" : 0,
		"n_replay_watched" : 0,
		"n_watched" : 0,
		"lost_before_end" : 0,
		"watched_time" : 0,
		"n_hearts" : 0,
		"n_replay_hearts" : 0,
		"n_comments" : 0,
		"watched_time_calculated" : 0,
		"watched_time_implied" : 0,
		"join_time_average" : 0,
		"join_time_count" : 0
	}
}

Sharing Broadcasts

/getBroadcastIdForShareToken - [TODO - To be documented]
https://api.periscope.tv/api/v2/getBroadcastIdForShareToken

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
token string No
Key Type Always Available Description
broadcast_id string Yes Periscope Broadcast ID
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/getBroadcastIdForShareToken HTTP/1.1
Host: api.periscope.tv
Content-Type: application/json
Accept: */*
Accept-Encoding: gzip, deflate
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)
Cache-Control: no-cache
Content-Length: 168

{
    "cookie": "[HIDDEN]",
    "token": "aFqyFzEyMDg2MjB8Mjc5NTU3NDjmLtJ2KkUl6IWrtXzwSR1AJnLcrFckRRFssUEDAypBKw=="
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 08:52:11 GMT
Expires: Wed, 24 Jun 2015 08:52:11 GMT
Last-Modified: Wed, 24 Jun 2015 08:52:11 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 28
Connection: keep-alive

{
	"broadcast_id" : "27955748"
}
/getBroadcastShareURL - [TODO - To be documented]
https://api.periscope.tv/api/v2/getBroadcastShareURL

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
Key Type Always Available Description
url string Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/getBroadcastShareURL HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 99
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:46:14 GMT
Expires: Sun, 21 Jun 2015 13:46:14 GMT
Last-Modified: Sun, 21 Jun 2015 13:46:14 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 110
Connection: close

{
	"url" : "https://www.periscope.tv/w/[HIDDEN]"
}
/shareBroadcast - [TODO - To be documented]
https://api.periscope.tv/api/v2/shareBroadcast

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
users array of string No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/shareBroadcast HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 119
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]",
	"users" : ["[HIDDEN]"]
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:55:40 GMT
Expires: Sun, 21 Jun 2015 13:55:40 GMT
Last-Modified: Sun, 21 Jun 2015 13:55:40 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}

Replays

/replayUploaded - LEGACY - Notify the API when the Replay is uploaded
https://api.periscope.tv/api/v2/replayUploaded

This endpoint is a legacy endpoint which got notified when the application had uploaded the replay.

Recently, all replays are stored automatically on the servers and therefore no notification is required.

/replayViewed - [TODO - To be documented]
https://api.periscope.tv/api/v2/replayViewed

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
session string No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/replayViewed HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 112
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "27647345",
	"cookie" : "[HIDDEN]",
	"session" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Connection: keep-alive
Content-Length: 17
Content-Type: application/json
Date: Wed, 24 Jun 2015 10:12:31 GMT
Expires:  Wed, 24 Jun 2015 10:12:31 GMT
Last-Modified: Wed, 24 Jun 2015 10:12:31 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload

{
	"success" : true
}
/deleteReplay - [TODO - To be documented]
https://api.periscope.tv/api/v2/deleteReplay

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/deleteReplay HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 99
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"broadcast_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 13:40:17 GMT
Expires: Sun, 21 Jun 2015 13:40:17 GMT
Last-Modified: Sun, 21 Jun 2015 13:40:17 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/endReplayViewed - [TODO - To be documented]
https://api.periscope.tv/api/v2/endReplayViewed

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Periscope Broadcast ID
session string No
duration float No
completion integer No
n_hearts integer No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/endReplayViewed HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 172
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"n_hearts" : 0,
	"broadcast_id" : "[HIDDEN]",
	"duration" : 0,
	"session" : "[HIDDEN]",
	"completion" : 0,
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 10:01:33 GMT
Expires: Wed, 24 Jun 2015 10:01:33 GMT
Last-Modified: Wed, 24 Jun 2015 10:01:33 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/replayThumbnailPlaylist - Get list of periodical screenshots
https://api.periscope.tv/api/v2/replayThumbnailPlaylist

[TODO - To be documented]

Parameter Type Optional Description Default Value
broadcast_id string No Periscope Broadcast ID
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
chunks Array of Chunks Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found

User Profile

/getSettings - [TODO - To be documented]
https://api.periscope.tv/api/v2/getSettings

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
[none] UserSettings Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/getSettings HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 73
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Sun, 21 Jun 2015 09:03:56 GMT
Expires: Sun, 21 Jun 2015 09:03:56 GMT
Last-Modified: Sun, 21 Jun 2015 09:03:56 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 55
Connection: close

{
	"push_new_follower" : true,
	"auto_save_to_camera" : false
}
/setSettings - [TODO - To be documented]
https://api.periscope.tv/api/v2/setSettings

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
settings UserSettings No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/setSettings HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 111
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"settings" : {
		"push_new_follower" : true,
		"auto_save_to_camera" : false
	},
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 10:25:38 GMT
Expires: Wed, 24 Jun 2015 10:25:38 GMT
Last-Modified: Wed, 24 Jun 2015 10:25:38 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/updateDescription - [TODO - To be documented]
https://api.periscope.tv/api/v2/updateDescription

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
description string No
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/updateDescription HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 250
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]",
	"description" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 10:28:54 GMT
Expires: Wed, 24 Jun 2015 10:28:54 GMT
Last-Modified: Wed, 24 Jun 2015 10:28:54 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/uploadProfileImage - [TODO - To be documented]
https://api.periscope.tv/api/v2/uploadProfileImage

[TODO - To be documented]

*NOTE*

This endpoint requires requests of type "multipart/form-data", and not the tranditional JSON payload request.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
image binary / raw (file) No
Key Type Always Available Description
[none] array of ProfileImageUrls Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/uploadProfileImage HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 108809
Content-Type: multipart/form-data; boundary=Boundary+F5CE6D8096478514
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

--Boundary+F5CE6D8096478514
Content-Disposition: form-data; name="cookie"

[HIDDEN]
--Boundary+F5CE6D8096478514
Content-Disposition: form-data; name="image"; filename="image.jpeg"
Content-Type: image/jpeg

‰PNG
[... truncated]
--Boundary+F5CE6D8096478514--
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 10:29:51 GMT
Expires: Wed, 24 Jun 2015 10:29:51 GMT
Last-Modified: Wed, 24 Jun 2015 10:29:51 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 1381
Connection: close

[
	{
		"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/[HIDDEN]",
		"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/[HIDDEN]",
		"width" : 360,
		"height" : 360
	}, {
		"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/[HIDDEN]",
		"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/[HIDDEN]",
		"width" : 256,
		"height" : 256
	}, {
		"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/[HIDDEN]",
		"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/[HIDDEN]",
		"width" : 128,
		"height" : 128
	}
]
/updateDisplayName - [TODO - To be documented]
https://api.periscope.tv/api/v2/updateDisplayName

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No
display_name string No
Key Type Always Available Description
success boolean Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid

User Discovery

/suggestedPeople - [TODO - To be documented]
https://api.periscope.tv/api/v2/suggestedPeople

List of users, which Periscope suggests you to follow.

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
twitter_consumer string Yes Twitter OAuth Token
twitter_secret string Yes Twitter OAuth Token Secret
languages array of string Yes Array of lang codes, for example ["en","ru"] If defined, "popular" field returns, else "hearted" field returns.
Key Type Always Available Description
featured array of User Yes Users, featured by Periscope
popular array of User No Available only if "languages" parameter was passed
hearted array of User No Available only if "languages" parameter was omitted
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/suggestedPeople HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 210
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"twitter_secret" : "[HIDDEN]",
	"cookie" : "[HIDDEN]",
	"twitter_consumer" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Fri, 19 Jun 2015 07:57:00 GMT
Expires: Fri, 19 Jun 2015 07:57:00 GMT
Last-Modified: Fri, 19 Jun 2015 07:57:00 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Connection: close
Content-Length: 70516

{
	"featured" : [
		{
			"class_name" : "User",
			"id" : "9",
			"created_at" : "2015-03-17T08:08:57.847620054Z",
			"updated_at" : "2015-06-19T07:56:59.642910966-07:00",
			"is_beta_user" : true,
			"is_employee" : false,
			"is_twitter_verified" : true,
			"twitter_screen_name" : "periscopeco",
			"username" : "periscopeco",
			"display_name" : "Periscope",
			"description" : "Explore the world in real time through someone else's eyes",
			"profile_image_urls" : [{
					"url" : "http://pbs.twimg.com/profile_images/576529332580982785/pfta069p_reasonably_small.png",
					"ssl_url" : "https://pbs.twimg.com/profile_images/576529332580982785/pfta069p_reasonably_small.png",
					"width" : 128,
					"height" : 128
				}, {
					"url" : "http://pbs.twimg.com/profile_images/576529332580982785/pfta069p_200x200.png",
					"ssl_url" : "https://pbs.twimg.com/profile_images/576529332580982785/pfta069p_200x200.png",
					"width" : 200,
					"height" : 200
				}, {
					"url" : "http://pbs.twimg.com/profile_images/576529332580982785/pfta069p_400x400.png",
					"ssl_url" : "https://pbs.twimg.com/profile_images/576529332580982785/pfta069p_400x400.png",
					"width" : 400,
					"height" : 400
				}
			],
			"initials" : "PE",
			"n_followers" : 3576900,
			"n_following" : 11,
			"is_facebook_friend" : false,
			"is_twitter_friend" : false,
			"is_following" : false
		}
	],
	"twitter" : [
		{
			"class_name" : "User",
			"id" : "[HIDDEN]",
			"created_at" : "2015-05-30T08:40:44.396979946-07:00",
			"updated_at" : "2015-06-16T12:41:17.867083306-07:00",
			"is_beta_user" : false,
			"is_employee" : false,
			"is_twitter_verified" : false,
			"twitter_screen_name" : "[HIDDEN]",
			"username" : "[HIDDEN]",
			"display_name" : "[HIDDEN]",
			"description" : "[HIDDEN]",
			"profile_image_urls" : [{
					"url" : "[HIDDEN]",
					"ssl_url" : "[HIDDEN]",
					"width" : 128,
					"height" : 128
				}, {
					"url" : "[HIDDEN]",
					"ssl_url" : "[HIDDEN]",
					"width" : 200,
					"height" : 200
				}, {
					"url" : "[HIDDEN]",
					"ssl_url" : "[HIDDEN]",
					"width" : 400,
					"height" : 400
				}
			],
			"initials" : "",
			"n_followers" : 0,
			"n_following" : 0,
			"is_facebook_friend" : false,
			"is_twitter_friend" : true,
			"is_following" : false
		},
		[... truncated]
	],
	"hearted" : [
		{
			"class_name" : "User",
			"id" : "122151",
			"created_at" : "2015-03-27T03:09:58.737812393Z",
			"updated_at" : "2015-06-17T03:05:32.627362168-07:00",
			"is_beta_user" : false,
			"is_employee" : false,
			"is_twitter_verified" : false,
			"twitter_screen_name" : "1AlexKhan",
			"username" : "1AlexKhan",
			"display_name" : "Alexander Khan",
			"description" : "Most Loved Daily Broadcast about Periscope Tips\u0026Tricks📲|Happiness😃|Personal Growth🚀|Success💰| 🇺🇸🇩🇪from Germany | 1alexkhan.com |#ScopeForGood",
			"profile_image_urls" : [{
					"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-1024.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727685\u0026Signature=hMYa6dVOIXGPDkMLtR27M%2Fic2IQ%3D",
					"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-1024.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727685\u0026Signature=hMYa6dVOIXGPDkMLtR27M%2Fic2IQ%3D",
					"width" : 1024,
					"height" : 1024
				}, {
					"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-512.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727685\u0026Signature=nxdtrHO43bXOLdT9X41A3dUJpoU%3D",
					"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-512.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727685\u0026Signature=nxdtrHO43bXOLdT9X41A3dUJpoU%3D",
					"width" : 512,
					"height" : 512
				}, {
					"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-256.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727685\u0026Signature=B2K1pn8sxgpE5AtDkaoKUs0Lkjg%3D",
					"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-256.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727685\u0026Signature=B2K1pn8sxgpE5AtDkaoKUs0Lkjg%3D",
					"width" : 256,
					"height" : 256
				}, {
					"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727686\u0026Signature=DcddCp8spUuuDFoTjkRYjq8sMLk%3D",
					"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/4803c87daba3d45b20b45a3c7738ac81-128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1747727686\u0026Signature=DcddCp8spUuuDFoTjkRYjq8sMLk%3D",
					"width" : 128,
					"height" : 128
				}
			],
			"initials" : "AK",
			"n_followers" : 54208,
			"n_following" : 114,
			"is_facebook_friend" : false,
			"is_twitter_friend" : false,
			"is_following" : false,
			"n_hearts" : 25482332
		},
		[... truncated]
	]
}
/user - [TODO - To be documented]
https://api.periscope.tv/api/v2/user

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
user_id string Yes Search by user id instead of name
username string Yes Search by exact user name instead of id
Key Type Always Available Description
user User Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/user HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 87
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"user_id" : "7",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 24 Jun 2015 09:55:38 GMT
Expires: Wed, 24 Jun 2015 09:55:38 GMT
Last-Modified: Wed, 24 Jun 2015 09:55:38 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 2356
Connection: close

{
	"user" : {
		"class_name" : "User",
		"id" : "7",
		"created_at" : "2015-03-17T07:39:20.381901493Z",
		"updated_at" : "2015-06-24T09:55:34.531483307-07:00",
		"is_beta_user" : true,
		"is_employee" : true,
		"is_twitter_verified" : false,
		"twitter_screen_name" : "couch",
		"username" : "couch",
		"display_name" : "Bill Couch",
		"description" : "Photographer, designer, cyclist. Product engineer at Twitter and Periscope.",
		"profile_image_urls" : [
			{
				"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-750.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=sMvxwf0BhsupC8jggSGdCASbLco%3D",
				"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-750.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=sMvxwf0BhsupC8jggSGdCASbLco%3D",
				"width" : 750,
				"height" : 750
			}, {
				"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-512.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=O%2BhWj0ZAjzUV2OhA%2Bu%2FAgQDBFII%3D",
				"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-512.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=O%2BhWj0ZAjzUV2OhA%2Bu%2FAgQDBFII%3D",
				"width" : 512,
				"height" : 512
			}, {
				"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-256.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=P3CUjd8DbNVme3v5aCFnnUYRrDo%3D",
				"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-256.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=P3CUjd8DbNVme3v5aCFnnUYRrDo%3D",
				"width" : 256,
				"height" : 256
			}, {
				"url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=%2Bsoxf%2FAL2RTX8HHKRqul60W8vg4%3D",
				"ssl_url" : "https://s3-us-west-2.amazonaws.com/prod-periscope-profile/029b70c02a2de310fef05e59ca5ec0be-128.jpg?AWSAccessKeyId=AKIAI34LQJZZSVNMNOFQ\u0026Expires=1746240304\u0026Signature=%2Bsoxf%2FAL2RTX8HHKRqul60W8vg4%3D",
				"width" : 128,
				"height" : 128
			}
		],
		"initials" : "BC",
		"n_followers" : 2238,
		"n_following" : 242,
		"is_following" : false,
		"n_hearts" : 304601,
		"n_replay_hearts" : 0
	}
}
/userSearch - [TODO - To be documented]
https://api.periscope.tv/api/v2/userSearch

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
search string No
Key Type Always Available Description
[none] array of User Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/userSearch HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 94
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3395 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]",
	"search" : "Periscope"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Fri, 19 Jun 2015 06:41:06 GMT
Expires: Fri, 19 Jun 2015 06:41:06 GMT
Last-Modified: Fri, 19 Jun 2015 06:41:06 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 21227
Connection: close

[
	{
		"class_name" : "User",
		"id" : "9",
		"created_at" : "2015-03-17T08:08:57.847620054Z",
		"updated_at" : "2015-06-19T06:41:05.543370505-07:00",
		"is_beta_user" : true,
		"is_employee" : false,
		"is_twitter_verified" : true,
		"twitter_screen_name" : "periscopeco",
		"username" : "periscopeco",
		"display_name" : "Periscope",
		"description" : "Explore the world in real time through someone else's eyes",
		"profile_image_urls" : [{
				"url" : "http://pbs.twimg.com/profile_images/576529332580982785/pfta069p_reasonably_small.png",
				"ssl_url" : "https://pbs.twimg.com/profile_images/576529332580982785/pfta069p_reasonably_small.png",
				"width" : 128,
				"height" : 128
			}, {
				"url" : "http://pbs.twimg.com/profile_images/576529332580982785/pfta069p_200x200.png",
				"ssl_url" : "https://pbs.twimg.com/profile_images/576529332580982785/pfta069p_200x200.png",
				"width" : 200,
				"height" : 200
			}, {
				"url" : "http://pbs.twimg.com/profile_images/576529332580982785/pfta069p_400x400.png",
				"ssl_url" : "https://pbs.twimg.com/profile_images/576529332580982785/pfta069p_400x400.png",
				"width" : 400,
				"height" : 400
			}
		],
		"initials" : "PE",
		"n_followers" : 3573800,
		"n_following" : 11,
		"is_following" : true,
		"time" : "0001-01-01T00:00:00Z"
	},
	[... truncated]
]
/getUserPublic - [TODO - To be documented]
https://api.periscope.tv/api/v2/getUserPublic?user_id=[user_id]

[TODO - To be documented]

*NOTE*

This is a GET request, with the token parameter appearing as a query string parameter, and not as a JSON payload.

Parameter Type Optional Description Default Value
user_id string No
Key Type Always Available Description
user User Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
404 Not Found

User Follow

/follow - [TODO - To be documented]
https://api.periscope.tv/api/v2/follow

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
user_id string No Periscope User ID
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/follow HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 93
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"user_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:07:14 GMT
Expires: Wed, 17 Jun 2015 03:07:14 GMT
Last-Modified: Wed, 17 Jun 2015 03:07:14 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/followers - [TODO - To be documented]
https://api.periscope.tv/api/v2/followers

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
user_id string No Periscope User ID
Key Type Always Available Description
[none] array of User Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/followers HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 93
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"user_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:04:32 GMT
Expires: Wed, 17 Jun 2015 03:04:32 GMT
Last-Modified: Wed, 17 Jun 2015 03:04:32 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 4665
Connection: close

[
	{
		"class_name" : "User",
		"id" : "5177766",
		"created_at" : "2015-06-15T12:42:19.635315065-07:00",
		"updated_at" : "2015-06-16T12:28:59.641434716-07:00",
		"is_beta_user" : false,
		"is_employee" : false,
		"is_twitter_verified" : false,
		"twitter_screen_name" : "Photos_by_Dove",
		"username" : "Photos_by_Dove",
		"display_name" : "Dove Photography",
		"description" : "Dove photography studio is n Blackpool. Wedding, New Baby \u0026 Portrait photographer. From baby bump to granny's 90th we are excited to photograph your family.",
		"profile_image_urls" : [{
				"url" : "http://pbs.twimg.com/profile_images/465154942802460672/RxhFaLK9_reasonably_small.jpeg",
				"ssl_url" : "https://pbs.twimg.com/profile_images/465154942802460672/RxhFaLK9_reasonably_small.jpeg",
				"width" : 128,
				"height" : 128
			}, {
				"url" : "http://pbs.twimg.com/profile_images/465154942802460672/RxhFaLK9_200x200.jpeg",
				"ssl_url" : "https://pbs.twimg.com/profile_images/465154942802460672/RxhFaLK9_200x200.jpeg",
				"width" : 200,
				"height" : 200
			}, {
				"url" : "http://pbs.twimg.com/profile_images/465154942802460672/RxhFaLK9_400x400.jpeg",
				"ssl_url" : "https://pbs.twimg.com/profile_images/465154942802460672/RxhFaLK9_400x400.jpeg",
				"width" : 400,
				"height" : 400
			}
		],
		"initials" : "",
		"n_followers" : 5,
		"n_following" : 23,
		"is_following" : false,
		"time" : "2015-06-15T12:46:22-07:00"
	},
	[... truncated]
]
/following - [TODO - To be documented]
https://api.periscope.tv/api/v2/following

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
user_id string No Periscope User ID
Key Type Always Available Description
[none] array of User Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/following HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 93
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"user_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:07:44 GMT
Expires: Wed, 17 Jun 2015 03:07:44 GMT
Last-Modified: Wed, 17 Jun 2015 03:07:44 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 3319
Connection: close

[
	{
		"class_name" : "User",
		"id" : "610802",
		"created_at" : "2015-03-31T15:01:35.867252129Z",
		"updated_at" : "2015-06-17T02:50:45.690937141-07:00",
		"is_beta_user" : false,
		"is_employee" : false,
		"is_twitter_verified" : true,
		"twitter_screen_name" : "E3",
		"username" : "E3",
		"display_name" : "E3",
		"description" : "The Official Electronic Entertainment Expo Twitter. Follow @RichatESA for more E3 news and announcements.",
		"profile_image_urls" : [{
				"url" : "http://pbs.twimg.com/profile_images/2429467626/nrw9w1si9ge9fvfcb3ra_reasonably_small.png",
				"ssl_url" : "https://pbs.twimg.com/profile_images/2429467626/nrw9w1si9ge9fvfcb3ra_reasonably_small.png",
				"width" : 128,
				"height" : 128
			}, {
				"url" : "http://pbs.twimg.com/profile_images/2429467626/nrw9w1si9ge9fvfcb3ra_200x200.png",
				"ssl_url" : "https://pbs.twimg.com/profile_images/2429467626/nrw9w1si9ge9fvfcb3ra_200x200.png",
				"width" : 200,
				"height" : 200
			}, {
				"url" : "http://pbs.twimg.com/profile_images/2429467626/nrw9w1si9ge9fvfcb3ra_400x400.png",
				"ssl_url" : "https://pbs.twimg.com/profile_images/2429467626/nrw9w1si9ge9fvfcb3ra_400x400.png",
				"width" : 400,
				"height" : 400
			}
		],
		"initials" : "E3",
		"n_followers" : 13917,
		"n_following" : 158,
		"is_following" : true,
		"time" : "2015-06-16T12:49:54-07:00"
	},
	[... truncated]
]
/unfollow - [TODO - To be documented]
https://api.periscope.tv/api/v2/unfollow

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
user_id string No Periscope User ID
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/unfollow HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 93
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"user_id" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:07:24 GMT
Expires: Wed, 17 Jun 2015 03:07:24 GMT
Last-Modified: Wed, 17 Jun 2015 03:07:24 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}

User Blocking

/block/add - [TODO - To be documented]
https://api.periscope.tv/api/v2/block/add

Block user

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
to string No Periscope User ID (alphanumeric)
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/block/add HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 88
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"to" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:09:01 GMT
Expires: Wed, 17 Jun 2015 03:09:01 GMT
Last-Modified: Wed, 17 Jun 2015 03:09:01 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/block/remove - [TODO - To be documented]
https://api.periscope.tv/api/v2/block/remove

Unblock user

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
to string No Periscope User ID (alphanumeric)
Key Type Always Available Description
success boolean Yes Flag indicating whether the request was successful or not
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found 
POST /api/v2/block/remove HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 88
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"to" : "[HIDDEN]",
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:09:35 GMT
Expires: Wed, 17 Jun 2015 03:09:35 GMT
Last-Modified: Wed, 17 Jun 2015 03:09:35 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 17
Connection: close

{
	"success" : true
}
/block/users - [TODO - To be documented]
https://api.periscope.tv/api/v2/block/users

Get the list of blocked users

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
[none] array of User Yes
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid 
POST /api/v2/block/users HTTP/1.1
Host: api.periscope.tv
Accept: */*
Accept-Encoding: gzip, deflate
Content-Length: 73
Content-Type: application/json; charset=utf-8
Accept-Language: en-GB;q=1, en;q=0.9, fr;q=0.8, de;q=0.7, ja;q=0.6, nl;q=0.5
Connection: keep-alive
User-Agent: Periscope/3313 (iPhone; iOS 7.1.1; Scale/2.00)

{
	"cookie" : "[HIDDEN]"
}
HTTP/1.1 200 OK
Cache-Control: max-age=0, s-max-age=0, no-cache, no-store, private
Content-Type: application/json
Date: Wed, 17 Jun 2015 03:07:55 GMT
Expires: Wed, 17 Jun 2015 03:07:55 GMT
Last-Modified: Wed, 17 Jun 2015 03:07:55 GMT
Pragma: no-cache
Strict-Transport-Security: max-age=31536000; preload
Content-Length: 2
Connection: close

[]

Ranking

/adjustBroadcastRank - [TODO - To be documented]
https://api.periscope.tv/api/v2/adjustBroadcastRank

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/broadcastRank - [TODO - To be documented]
https://api.periscope.tv/api/v2/broadcastRank

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/getBroadcastsRankParameters - [TODO - To be documented]
https://api.periscope.tv/api/v2/getBroadcastsRankParameters

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/setBroadcastsRankParameters - [TODO - To be documented]
https://api.periscope.tv/api/v2/setBroadcastsRankParameters

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found

Other

/mutualFollows - [TODO - To be documented]
https://api.periscope.tv/api/v2/mutualFollows

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/supportedLanguages - [TODO - To be documented]
https://api.periscope.tv/api/v2/supportedLanguages

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/unban - [TODO - To be documented]
https://api.periscope.tv/api/v2/unban

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/mute - [TODO - To be documented]
https://api.periscope.tv/api/v2/mute

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/unmute - [TODO - To be documented]
https://api.periscope.tv/api/v2/unmute

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/accessChat - [TODO - To be documented]
https://api.periscope.tv/api/v2/accessChat

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
Key Type Always Available Description
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found
/accessVideo - [TODO - To be documented]
https://api.periscope.tv/api/v2/accessVideo

[TODO - To be documented]

Parameter Type Optional Description Default Value
cookie string No Periscope Authentication Cookie
broadcast_id string No Broadcast identifier
Key Type Always Available Description
session string Yes Empty string
replay_url string No URL of replay, HLS format
type string Yes Empty string
chat_token string Yes
life_cycle_token string Yes Token used in startWatching request
broadcast Broadcast Yes
share_url string Yes Link to broadcast on the periscope.tv site
Status Code Error Text Description
400 Bad Request Request did not meet requirements - potentially missing parameter
401 Unauthorized This endpoint requires authentication and no cookie value was provided, or is invalid
404 Not Found

Data Objects

User

A User object returns profile information about a Periscope user.

Values in this object can vary depending on where it was accessed from, so be aware of the 'Always Available' flags below.

Key Type Always Available Description Default Value
class_name string Yes The type name of this object User
created_at datestring Yes
description string Yes
display_name string Yes First and last name
id string Yes Unique identifier of the user
initials string Yes
is_beta_user boolean Yes false
is_employee boolean Yes false
is_following boolean No Returns only from private methods false
is_muted boolean No Returns only from private methods false
is_twitter_friend boolean Yes false
is_twitter_verified boolean Yes false
n_followers integer Yes
n_following integer Yes
n_hearts_given integer No Count of hearts given in current chat 0
n_replay_hearts integer No Returns only from private methods 0
participant_index integer No Index of user in chat 0
profile_image_urls array of ProfileImageUrls Yes
start datestring No User join time in current chat (ATOM format)
start time in ATOM format No User join time in current chat
twitter_screen_name string Yes
updated_at datestring No
username string Yes Periscope Username
UserSettings

A UserSettings object defines behaviour settings for a user.

Key Type Always Available Description Default Value
push_new_follower boolean Yes false
auto_save_to_camera boolean Yes false
disable_stabilization boolean Yes false
disable_broadcast_persistence boolean Yes false
disable_viewer_moderation boolean Yes false
disable_broadcast_moderation boolean Yes false
disable_find_by_digits_id boolean Yes false
show_me_chat_messages_in_other_languages boolean Yes false
disable_receive_share_notifications boolean Yes false
disable_followed_live_notifications boolean Yes false
disable_suggested_first_notifications boolean Yes false
hide_follow_recommendations boolean Yes false
disable_recommendation_notifications boolean Yes false
disable_ping_notifications boolean Yes false
ProfileImageUrls

ProfileImageUrls provide information about a specific size of profile picture for a user.

Values in this object can vary depending on where it was accessed from, so be aware of the 'Always Available' flags below.

Key Type Always Available Description Default Value
url string Yes
ssl_url string Yes
width integer Yes
height integer Yes
Broadcast

A Broadcast object provides information about a specific Periscope broadcast given by a user.

Values in this object can vary depending on where it was accessed from, so be aware of the 'Always Available' flags below.

Key Type Always Available Description Default Value
available_for_replay boolean Yes false
city string Yes
class_name string Yes The type name of this object Broadcast
country string Yes
country_state string Yes
created_at datestring Yes Creation time in ATOM date format
expiration integer No Number of hours replay will available 24
featured boolean Yes
friend_chat boolean Yes false
has_location boolean Yes false
heart_theme array of string No Possible pictures of "hearts" (fridge, snowflake, etc...)
height integer Yes 568
highlight_available boolean No Only for public broadcasts true
id string Yes Broadcast identifier
image_url string Yes 320x568 image url
image_url_small string Yes 72x128 image url
ip_lat float No Latitude
ip_lng float No Longitude
is_locked boolean Yes Is broadcast private or public false
is_trusted boolean Yes false
iso_code string Yes 2-letter country code (lower case)
language string Yes 2-letter language code (lower case)
n_watching integer Yes Watching count 0
n_web_watching integer Yes Count of watching using browser 0
n_total_watching integer Yes Total watching count
n_total_watched integer No (For replays) Total watched count
ping datestring Yes Ping time in ATOM date format
profile_image_url string Yes
share_display_names ? No
share_user_ids ? No
sort_score integer Yes Defines how high in "Top" section will broadcast be. 0
start datestring Yes Start time in ATOM date format
state string Yes RUNNING, ENDED or TIMED_OUT
status string Yes Broadcast description
timedout string No If state is TIMED_OUT, there is time in ATOM date format
twitter_username string No
updated_at datestring Yes Update time in ATOM date format
user_display_name string Yes
user_id string Yes Periscope User ID (alphanumeric)
username string Yes Periscope username
width integer Yes 320
ErrorObject

An ErrorObject provides feedback on error conditions that happened during validation.

Key Type Always Available Description Default Value
code integer Yes The error code
message string Yes The error message
StatsViewing

This object provides details of Playback information from a user after watching a Broadcast

Key Type Always Available Description Default Value
FrameRate_min float Yes
FrameRate_max float Yes
FrameRate_mean float Yes
FrameRate_stddev float Yes
pn_connect_t float Yes
pn_pres_res integer Yes
pn_msg_drop integer Yes
pn_disconnect_t float Yes
pn_msg_sent integer Yes
pn_msg_rec integer Yes
BatteryDrainPerMinute float Yes
LostConnection_count integer Yes
StatsBroadcasting

This object provides details of Broadcast information from a user after creating and streaming a Broadcast

Key Type Always Available Description Default Value
StatsMeta

[TODO - To be documented]

Key Type Always Available Description Default Value
n_watching integer Yes
n_watching_web integer Yes
n_web_watched integer Yes
n_replay_watched integer Yes
n_watched integer Yes
lost_before_end integer Yes
watched_time float Yes
n_hearts integer Yes
n_replay_hearts integer Yes
n_comments integer Yes
watched_time_calculated float Yes
watched_time_implied float Yes
join_time_average float Yes
join_time_count integer Yes
ReplayCookie

[TODO - To be documented]

Key Type Always Available Description Default Value
Name string Yes
Value string Yes
Path string Yes
Domain string Yes
Expires string Yes
RawExpires string Yes
MaxAge integer Yes
Secure boolean Yes
HttpOnly boolean Yes
Raw string Yes
Unparsed string Yes [null]
Chunk

One part of video

Key Type Always Available Description Default Value
chunk integer No Number of chunk. Only even numbers. -1
time float No Time offset, usually every 8 seconds 0
tn string Yes URL of .jpg image