Stickam Data API - Stickam Labs

Home - Stickam Data API

Contents

Introduction

What is the Stickam Data API?

The Stickam Data API enable developers to interact with the Stickam System using a simple URL over HTTP; results are returned in XML format.

Authentication

Currently we require no authentication when using the API. In the future we may require keys for specific functionality or high transaction users.

API Call Interfaces

There is a REST API is very easy.

API References

User Profile

  • URL Format

    http://api.stickam.com/api/user/<username>/profile

  • Path Parameters

    <username>:Stickam username

  • Example Request

    http://api.stickam.com/api/user/stickam/profile

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<user>
  <user_id>170060346</user_id>
  <user_name>stickam</user_name>
  <screen_name>Stickam </screen_name>
  <reg_date>2005-10-21</reg_date>
  <country>USA</country>
  <zipcode>90230</zipcode>
  <gender>M</gender>
  <message>Welcome to Stickam!

  Where would you stick it?


  </message>
  <status>offline</status>
  <last_login>2006-08-25 23:21</last_login>
  <profile_url>http://www.stickam.com/profile/stickam</profile_url>
  <profile_image>http://static.stickam.com/media/image/converted/online/1700/6034/6/da276056s.jpg</profile_image>
  <page_views>266</page_views>
  <photo_count>10</photo_count>
  <video_count>2</video_count>
  <audio_count>0</audio_count>
  <player1><![CDATA[<embed src="http://player.stickam.com/flash/stickam/stickam_player.swf" flashVars="userName=stickam&webID=528BD6BFE95061239676C59F4D51AD9E&userID=170060346&userType=205&skinType=small&userSiteID=1015547&app=stickam_chat_small.swf&langID=en&userIP=127.0.0.1&autoplay=0&hostName=http%3A%2F%2Fwww.stickam.com&skinName=small0&defaultMedia=movie&bgcolor=FFFFFF&photo=http%3A%2F%2Fstatic.stickam.com%2Fmedia%2Fimage%2Fconverted%2Fflash%2F1700%2F6034%2F6%2Fda276056s.jpg&sessionType=115&skinbg=http%3A%2F%2Fstatic.stickam.com%2Fmedia%2Fimage%2Fskin%2F1700%2F6034%2F6%2Fsmall%2Fskin42.jpg&" width="160" height="400" type="application/x-shockwave-flash" allowScriptAccess="always"></embed>]]></player1>
  <player2><![CDATA[<embed src="http://player.stickam.com/flash/stickam/stickam_player.swf" flashVars="userName=stickam&webID=528BD6BFE95061239676C59F4D51AD9E&userID=170060346&userType=205&skinType=medium&userSiteID=1015547&app=stickam_chat_medium.swf&langID=en&userIP=127.0.0.1&autoplay=0&hostName=http%3A%2F%2Fwww.stickam.com&skinName=medium0&defaultMedia=movie&bgcolor=669966&photo=http%3A%2F%2Fstatic.stickam.com%2Fmedia%2Fimage%2Fconverted%2Fflash%2F1700%2F6034%2F6%2Fda276056s.jpg&sessionType=115&" width="480" height="210" type="application/x-shockwave-flash" allowScriptAccess="always"></embed>]]></player2>
  <player3><![CDATA[<embed src="http://player.stickam.com/flash/stickam/stickam_player.swf" flashVars="userName=stickam&webID=528BD6BFE95061239676C59F4D51AD9E&userID=170060346&userType=205&skinType=medium&userSiteID=1015547&app=stickam_chat_medium1.swf&langID=en&userIP=127.0.0.1&autoplay=0&hostName=http%3A%2F%2Fwww.stickam.com&skinName=medium1&defaultMedia=movie&bgcolor=FFFFFF&photo=http%3A%2F%2Fstatic.stickam.com%2Fmedia%2Fimage%2Fconverted%2Fflash%2F1700%2F6034%2F6%2Fda276056s.jpg&sessionType=115&skinbg=http%3A%2F%2Fwww.stickam.com%2Fimages%2Fskins%2Fstickam400%2Ffun%2Fskin20.jpg&" width="400" height="160" type="application/x-shockwave-flash" allowScriptAccess="always"></embed>]]></player3>
  <player4><![CDATA[<embed src="http://player.stickam.com/flash/stickam/stickam_player.swf" flashVars="userName=stickam&webID=528BD6BFE95061239676C59F4D51AD9E&userID=170060346&userType=205&skinType=mini&userSiteID=1015547&app=stickam_chat_mini.swf&langID=en&userIP=127.0.0.1&autoplay=0&hostName=http%3A%2F%2Fwww.stickam.com&skinName=mini0&defaultMedia=movie&bgcolor=222222&photo=http%3A%2F%2Fstatic.stickam.com%2Fmedia%2Fimage%2Fconverted%2Fflash%2F1700%2F6034%2F6%2Fda276056s.jpg&sessionType=115&skinbg=http%3A%2F%2Fwww.stickam.com%2Fimages%2Fskins%2Fmini%2Ftech%2Fskin02.jpg&" width="160" height="160" type="application/x-shockwave-flash" allowScriptAccess="always"></embed>]]></player4>
  <friends_count>1</friends_count>
</user>

  • Example Code

    user-profile.pl

User Image

  • URL Format

    http://api.stickam.com/api/user/<username>/image

  • Path Parameters

    <username>:Stickam username

  • Optional Parameters

    page:Page number
    per_page:Results per page

  • Example Request

    http://api.stickam.com/api/user/stickam/image?per_page=20&page=0

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<media_list>
  <media>
    <media_id>170159586</media_id>
    <user_id>170060346</user_id>
    <media_type></media_type>
    <title>oh so warm</title>
    <description></description>
    <date>2005-12-15 22:02</date>
    <comment_count>1</comment_count>
    <rating_avg>10.0</rating_avg>
    <rating_count>1</rating_count>
    <view_count>23</view_count>
    <thumb>http://static.stickam.com/media/image/converted/thumb/1700/6034/6/da276049s.jpg</thumb>
    <small>http://static.stickam.com/media/image/converted/online/1700/6034/6/da276049s.jpg</small>
    <medium>http://static.stickam.com/media/image/converted/flash/1700/6034/6/da276049s.jpg</medium>
    <original>http://static.stickam.com/media/image/converted/original/1700/6034/6/da276049s.jpg</original>
  </media>
  <media>
    ...
  </media>
  ...
</media_list>

  • Example Code

    user-image.pl

User Video

  • URL Format

    http://api.stickam.com/api/user/<username>/video

  • Path Parameters

    <username>:Stickam username

  • Optional Parameters

    page:Page number
    per_page:Results per page

  • Example Request

    http://api.stickam.com/api/user/stickam/video?per_page=20&page=0

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<media_list>
  <media>
    <media_id>172162286</media_id>
    <user_id>170060346</user_id>
    <media_type></media_type>
    <title>Welcome to Stickam</title>
    <description>Welcome to Stickam</description>
    <date>2006-04-01 00:27</date>
    <comment_count>2</comment_count>
    <rating_avg>7.833333333333333</rating_avg>
    <rating_count>6</rating_count>
    <view_count>2361</view_count>
    <player>&lt;embed src=&quot;http://player.stickam.com/flashVarMediaPlayer/172162286&quot; type=&quot;application/x-shockwave-flash&quot; scale=&quot;noscale&quot; wmode=&quot;transparent&quot; width=&quot;400&quot; height=&quot;300&quot; allowScriptAccess=&quot;always&quot;&gt;&lt;/embed&gt;</player>
    <mini_player>&lt;embed src=&quot;http://player.stickam.com/flashVarMediaPlayer/172162286&quot; type=&quot;application/x-shockwave-flash&quot; scale=&quot;noscale&quot; wmode=&quot;transparent&quot; width=&quot;120&quot; height=&quot;90&quot; allowScriptAccess=&quot;always&quot;&gt;&lt;/embed&gt;</mini_player>
    <thumb>http://static.stickam.com/media/video/converted/1700/6034/6/4f6bd8b2-c116-11da-aa05-bd586f667362.avi.flv.jpg</thumb>
  </media>
  <media>
    ...
  </media>
  ...
</media_list>

  • Example Code

    user-video.pl

User Audio

  • URL Format

    http://api.stickam.com/api/user/<username>/audio

  • Path Parameters

    <username>:Stickam username

  • Optional Parameters

    page:Page number
    per_page:Results per page

  • Example Request

    http://api.stickam.com/api/user/stickam_jp/audio?per_page=20&page=0

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<media_list>
  <media>
    <media_id>173592135</media_id>
    <user_id>170059356</user_id>
    <media_type></media_type>
    <file_name>CE4A96D4-E14F-11DA-AD70-F4A7242849F0.mp3</file_name>
    <file_size>3629557</file_size>
    <title>test</title>
    <description></description>
    <date>2006-05-12 00:39</date>
    <comment_count>0</comment_count>
    <rating_avg>0.0</rating_avg>
    <rating_count>0</rating_count>
    <view_count>141</view_count>
    <duration>226</duration>
    <artist>test</artist>
  </media>
  <media>
    ...
  </media>
  ...
</media_list>

  • Example Code

    user-audio.pl

Media Information

Fetching information about media requires the media ID. One way to obtain media IDs is from user's media.

  • URL Format

    http://stickam.com/api/media/<media_id>

  • Path Parameters

    <media_id>:Stickam media ID

  • Example Request

    http://api.stickam.com/api/media/170159586

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<media>
  <media_id>170159586</media_id>
  <user_id>170060346</user_id>
  <user_name>stickam</user_name>
  <screen_name>Stickam </screen_name>
  <media_type>image</media_type>
  <title>oh so warm</title>
  <description></description>
  <date>2005-12-15 22:02</date>
  <comment_count>1</comment_count>
  <rating_avg>10.0</rating_avg>
  <rating_count>1</rating_count>
  <view_count>23</view_count>
</media>

  • Example Code

    media-information.pl

User Search

  • URL Format

    http://api.stickam.com/api/search/user?...

  • Optional Parameters

    name:Stickam username or screenname(partial match)
    gender:M for man, F for female
    lowerAge:Min age
    upperAge:Max age
    zip:Zip code
    country:3 Character Country Code
    online:Users logged in (1 or 0)
    live:Users broadcasting (1 or 0)
    chat:Users chatting (1 or 0)
    image:Users with 1+ images (1 or 0)
    video:Users with 1+ videos (1 or 0)
    audio:Users with 1+ audio file (1 or 0)
    per_page:Number of results. It defaults to 10/page and the max number is 50.
    page:The page of results

  • Example Request

    http://api.stickam.com/api/search/user?name=stickam

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<user_list>
  <user>
    <user_id>173684791</user_id>
    <user_name>stickam__blank</user_name>
    <screen_name>!!SaTaN!!</screen_name>
    <reg_date>2006-09-10</reg_date>
    <country>USA</country>
    <zipcode>90210</zipcode>
    <gender>F</gender>
    <status>offline</status>
    <last_login>2006-10-05 03:33</last_login>
    <profile_url>http://www.stickam.com/profile/stickam__blank</profile_url>
    <image></image>
    <photo_count>0</photo_count>
    <video_count>0</video_count>
    <audio_count>0</audio_count>
  </user>
  <user>
    ...
  </user>
  ...
</user_list>

  • Example Code

    user-search.pl

Media Search

  • URL Format

    http://api.stickam.com/api/search/media?...

  • Optional Parameters

    type:image/video/audio
    text:substring match title, description, and tag
    sort:"view" to sort by views, otherwise by date created
    per_page:Number of results. It defaults to 10/page and the max number is 50.
    page:The page of results

  • Example Request

    http://api.stickam.com/api/search/media?type=video&text=Welcome+to+Stickam

  • Example Response

    <?xml version="1.0" encoding="UTF-8" ?>
<media_list>
  <num_results>2</num_results>
  <media>
    <media_id>172162286</media_id>
    <user_id>170060346</user_id>
    <user_name>stickam</user_name>
    <screen_name>Stickam </screen_name>
    <media_type>video</media_type>
    <title>Welcome to Stickam</title>
    <description>Welcome to Stickam</description>
    <date>2006-04-01 00:27</date>
    <comment_count>2</comment_count>
    <rating_avg>7.833333333333333</rating_avg>
    <rating_count>6</rating_count>
    <view_count>2361</view_count>
    <thumb>http://static.stickam.com/media/video/converted/1700/6034/6/4f6bd8b2-c116-11da-aa05-bd586f667362.avi.flv.jpg</thumb>
    <duration>41</duration>
  </media>
  <media>
    ...
  </media>
  ...
</media_list>

  • Example Code

    media-search.pl