StyleFeeder API 1.0
Last Updated:
March 28, 2008
Introduction
The StyleFeeder API is a set of RESTful/XML-over-HTTP web services, which developers can use to leverage our unique capabilities. These services can be used to build applications for the desktop or mobile environments, platform-based applications such as Facebook, Friendster, and OpenSocial. Other uses include AJAX or Flash widgets, search and bookmark plugins, and other uses that haven't even been invented yet.
Get Involved
Acceptable Usage and Privacy
The StyleFeeder API is governed by the same terms as the StyleFeeder website.
Authorization
Authorization is currently done via HTTP cookies. The cookie may be set by invoking the authorize method (see below) or a user may sign in on the website (www.stylefeeder.com) to become authorized. Note: Feedback on alternate authorization methods is welcome.
Glossary
- Bookmark
- A bookmark is a many-to-many association between an Item and an Account.
- Account
- An account is a registered user of the website/service.
- Item
- An item is a product and/or webpage.
- Link
- A link is a URL to an Item. An Item may have zero or more links.
Authorize
URL: http://api.stylefeeder.com/sfws/authorize
Authorization Not Required
Parameters
- username (required) - The username of the account to be authorized.
- password (required) - The password of the account to be authorized.
Comments
This method will set an HTTP cookie upon successful login.
Rate a Bookmark
URL: http://api.stylefeeder.com/sfws/bookmark/rate
Authorization Required
Parameters
- bookmark (required) - The ID of the bookmark to be rated.
- score (required) - The score of the rating, must be integer between -1 and 5
Comments
This method will save a rating for a bookmark, typically called via a "rating stars" widget. Items can be rated more than once per account.
Get a Random bookmark
URL: http://api.stylefeeder.com/sfws/bookmark/random
Authorization Not Required
Parameters
- count (optional, default:1) - The number of bookmarks requested, must be integer between 1 and 100.
- unrated (optional, default:false) - If true, only unrated bookmarks will be returned. This parameter is only used with authorization.
- thumbSize (optional, default:100) - The size of thumbnails desired, must be integer between 10 and 200.
Comments
This method will return a random bookmark. Useful when there isn't enough information for other methods.
Copy a Bookmark
URL: http://api.stylefeeder.com/sfws/bookmark/copy
Authorization Required
Parameters
- bookmark (required) - The ID of the bookmark to be copied.
Comments
This method will copy a bookmark to a account's StyleFeed.
Get Similar Items
URL: http://api.stylefeeder.com/sfws/bookmark/similar
Authorization Not Required
Parameters
- bookmark (required) - The ID of the bookmark to be compared.
- count (optional, default:1) - The number of bookmarks requested, must be integer between 1 and 100.
- thumbSize (optional, default:100) - The size of thumbnails desired, must be integer between 10 and 200.
Comments
This method will return items similar to the bookmark supplied.
Get Related Items
URL: http://api.stylefeeder.com/sfws/bookmark/related
Authorization Not Required
Parameters
- bookmark (required) - The ID of the bookmark to be related.
- count (optional, default:1) - The number of bookmarks requested, must be integer between 1 and 100.
- thumbSize (optional, default:100) - The size of thumbnails desired, must be integer between 10 and 200.
Comments
This method will return items popular with people who liked the bookmark supplied.
Get Recommendations
URL: http://api.stylefeeder.com/sfws/bookmark/recommmend
Authorization Required
Parameters
- count (optional, default:10) - The number of bookmarks requested, must be integer between 1 and 100.
- page (optional, default:0) - The page of results requested, must be integer between 0 and 99.
- thumbSize (optional, default:100) - The size of smaller thumbnails desired, must be integer between 10 and 200.
- detailImageSize (optional, default:200) - The size of large thumbnails desired, must be integer between 10 and 200.
Comments
This method will return items StyleFeeder's engine thinks they will like.
Get Watchlist
URL: http://api.stylefeeder.com/sfws/account/watchlist
Authorization Not Required
Parameters
- username (required, optional with authorization) - The account whose watchlist is requested. If authorized and not supplied, will use authorized account.
Comments
This method will return the other accounts that a account is watching.
Get StyleFeed
URL: http://api.stylefeeder.com/sfws/account/stylefeed
Authorization Not Required
Parameters
- username (required, optional with authorization) - The account whose watchlist is requested. If authorized and not supplied, will use authorized account.
- count (optional, default:10) - The number of bookmarks requested, must be integer between 1 and 100.
- page (optional, default:0) - The page of results requested, must be integer between 0 and 99.
- thumbSize (optional, default:100) - The size of smaller thumbnails desired, must be integer between 10 and 200.
- detailImageSize (optional, default:200) - The size of large thumbnails desired, must be integer between 10 and 200.
Comments
This method will return items the account has added to their StyleFeed.
Get StyleTwins
Get Watchlist
URL: http://api.stylefeeder.com/sfws/account/styletwin
Authorization Not Required
Parameters
- username (required, optional with authorization) - The account whose watchlist is requested. If authorized and not supplied, will use authorized account.
Comments
This method will return the other accounts that StyleFeeder thinks have similar style to the supplied account.
Search Bookmarks
URL: http://api.stylefeeder.com/sfws/bookmark/search
Authorization Not Required
Parameters
- q (required) - The query which to search on.
- count (optional, default:10) - The number of bookmarks requested, must be integer between 1 and 100.
- page (optional, default:0) - The page of results requested, must be integer between 0 and 99.
- thumbSize (optional, default:100) - The size of smaller thumbnails desired, must be integer between 10 and 200.
- detailImageSize (optional, default:200) - The size of large thumbnails desired, must be integer between 10 and 200.
Comments
This method will return search bookmarks on StyleFeeder. With authorization, results will be personalized.