Snoopon.me API Documentation

Current as of Aug 19, 2010

Snoopon.me allows an application access to the most of its functionality and data through an application programming interface (API). Using Snoopon.me API it is possible to create, for instance, a chat application showing the latest screenshots of participants.

Snoopon.me API is early in the development now and its current version is considered 'beta'. The best effort will be made to keep Snoopon.me API backward-compatible. However, there are no guarantees.

The current version of Snoopon.me API provides read-only access. Future version will allow data updates too.

Snoopon.me API is RESTful and uses JSON as data format. Currently Snoopon.me API is readonly, thus it uses HTTP GET requests only. If required, authorization is provided using HTTP Authorization header.

• User resource
• Snoopees resource
• Snoopers resource
• Screenshot resource
• Pins resource
• Comments resource
• Screen trail resource
• User feed resource
• Global feed resource
• Random resource

User resource

URI: http://api.snoopon.me/1/username

No authorization required

Example of the JSON object returned from http://api.snoopon.me/1/maximk:

{
	"username": "maximk",
	"name": "maximk",
	"created": 1268244138,	// March 10, 2010
	"description": "...",
	"weblink": "snoopon.me",
	"numsnoopees": 170,	// N of people the user snoops on
	"numsnoopers": 4,	// N of people who snoop on the user
	"mstyle": "pc",		// Monitor style: pc, mac or fancy
	"bkgstyle": "bkg3",	// Bkg style: bkg1-bkg8
	"totalcaps": 3015,	// N of screenshots posted
	"lastcaptured": 1282039443,	// Last time screenshot posted
	"maxview": "standard",	// Max viewable resolution:
				// standard - 320px wide
				// medium - 160px wide
				// thumbnail - 80px wide
	"totaltweets": 191,	// N of screenshots tweeted
	"lasttweeted": 1282036168,	// Last time screenshot tweeted
	"photourl": "http://snoopon.me/maximk/photo",	// 80x80 PNG
	"photourl2": "http://snoopo.me/maximk/photo2",	// 48x48 PNG
}

Snoopees resource

URI: http://api.snoopon.me/1/username/snoopees

No authorization required

Returns an array of user objects for all people the user snoops on. See User resource.

Snoopers resource

URI: http://api.snoopon.me/1/username/snoopers

No authorization required

Similar to Snoopees resource.

Screenshot resource

URI: http://api.snoopon.me/1/username/ordinal

No authorization required

Example of the JSON object returned from http://api.snoopon.me/1/maximk/3015:

{
	"username": "maximk",
	"timestamp": 1282039443,	// Tue, 17 Aug 2010
	"ordinal": 3015,	// Screenshot ordinal number
	"numpins": 0,	// N of times the screenshot was pinned down
	"numcomments", 0,	// N of comments
	"monitors":
	[
	    {
		"maxresurl": "http://.../1.png",	// 320px wide PNG
		"medresurl": "http://.../1-mid.png",	// 160px wide PNG
		"thumburl": "http://.../1-thumb.png",	// Thumbnail PNG
		"origwidth": 1280,	// Original width
		"origheight": 1024,	// Original height
		"width": 320,	// Max res image width
		"height": 240	// Max res image height
	    }
	]
}

Pins resource

URI: http://api.snoopon.me/1/username/ordinal/pins

No authorization required

Returns an array of JSON objects for all times people pinned down the screenshot.

Example of the JSON array returned from http://api.snoopon.me/1/maximk/3015/pins:

[
    {
	"timestamp": 1282039543,
	"username":  "somebody"
    }
]

Comments resource

URI: http://api.snoopon.me/1/username/ordinal/comments

No authorization required

Returns an array of JSON objects for all comments attached to the screenshot.

Example of the JSON array returned from http://api.snoopon.me/1/maximk/3015/comments:

[
    {
	"timestamp": 1282039543,
	"username":  "somebody",
	"note": "I never saw people using 4 monitor configuration"
    }
]

Screen trail resource

URI: http://api.snoopon.me/1/username/trail

No authorization required

Returns an array of screenshot objects describing the user's screen trail. The layout of the screenshot objects is the same as in Screenshot resource. The maximum screen trail length is limited at Snoopon.me. Not counting pinned down screenshots, the screen trail is 192 screenshots max. Screenshots are ordered chronologically, the most recent first.

User feed resource

URI: http://api.snoopon.me/1/username/feed

Requires authorization, provide Snoopon.me username and password in HTTP Authorization header

Probably, the central resource of the API. Each Snoopon.me user has a list of snoopees and the user feed resource allows fetching of the most recent screenshots for all snoopees listed.

Returns the array of screenshot objects for all snoopees in chronological order. A parameter 'limit' can be used to set the maximum number of screenshots returned. The default value for the limit is 10, maximum - 50. If the resource is read repeatedly the parameter 'since' can be employed to get only screenshots arrived after the given time stamp.

Example: GET http://api.snoopon.me/1/maximk/feed?limit=25&since=1282039443

Global feed resource

URI: http://api.snoopon.me/1/globalfeed

Requires authorization, provide Snoopon.me username and password in HTTP Authorization header

Returns the array the most recent screenshots received by Snoopon.me. Use 'limit' parameter to set the number of screenshots returned. The limit should be between 1 and 3. Use 'since' parameter to return screenshots captured after the given time stamp.

Random resource

URI: http://api.snoopon.me/1/random

Requires authorization, provide Snoopon.me username and password in HTTP Authorization header

Returns a list of random screenshots. Use 'limit' parameter to set the number of screenshots returned. The limit should be between 1 and 3.