REST API Usage

Sign up FREE & get 250 points


The Points2Shop REST API allows you to access data that does not require user permissions. That way you can access data like testimonials, shoutbox, most recent offers, most popular offers etc.

You are required to send the API Key in the HTTP header for all the REST requests you make. The API Key can be found in the details of your application.

Testimonials

Sample response body:

[
{
  "title": "Magic the Gathering: Mirrodin Besieged Booster Pack", 
  "description": "I received this item super fast and even got a Mythic Rare 
      from it worth $11. Love Points 2 Shop!!", 
  "submitted_date": "2011-03-10 19:00:43", 
  "photo_url": "http://www.points2shop.com/testimonials_images/free_magic_the_gathering_mirrodin_besieged_booster_pack_1597901_2_thumb.jpg",
  "photo_url_large": "http://www.points2shop.com/testimonials_images/free_magic_the_gathering_mirrodin_besieged_booster_pack_1597901_2.jpg", 
  "amazon_image_url": "http://ecx.images-amazon.com/images/I/51CVvKDpjcL._SL75_.jpg", 
  "amazon_url": "http://www.points2shop.com/amazon/product/B004K1JUIS", 
  "user_profile_url": "http://www.points2shop.com/members/profile/Freebiaholic", 
  "comments_count": 6, 
  "forum_url": "http://www.points2shop.com/topic/89162/Magic-the-Gathering-Mirrodin-Besieged-Booster-Pack/1", 
  "username": "Freebiaholic", 
  "cash": null, 
  "points": 1
 }, 
{
   "title": "How to Rebuild Your Volkswagen air-Cooled Engine (All models, 1961 and up)", 
   "description": "At first when i came to this site a was a little skepctical, 
     bus i kept earning points and placed my first order. My order arrived and now 
     i believe this is the greatest website in the world and is completely legit.", 
   "submitted_date": "2011-03-10 20:19:30", 
   "photo_url": "http://www.points2shop.com/testimonials_images/free_how_to_rebuild_your_volkswagen_air-ooled_engine_all_models_1961_and_up_1916667_3_thumb.jpg",
   "photo_url_large": "http://www.points2shop.com/testimonials_images/free_how_to_rebuild_your_volkswagen_air-cooled_engine_all_models_1961_and_up_1916667_3.jpg", 
   "amazon_image_url": "http://ecx.images-amazon.com/images/I/51nF7LgpCbL._SL75_.jpg", 
   "amazon_url": "http://www.points2shop.com/amazon/product/0895862255", 
   "user_profile_url": "http://www.points2shop.com/members/profile/Jmallak", 
   "comments_count": 5, 
   "forum_url": "http://www.points2shop.com/topic/89221/Free-How-to-Rebuild-Your-Volkswagen-air-Cooled-Engine-All-models-1961-and-up/1", 
   "username": "Jmallak", 
   "cash": null, 
   "points": 1149
   
}
]

Shoutbox

Sample response body:

[
 {
    "username": "isk8lakai", 
    "honor_level": "Diamond", 
    "country": "US", 
    "shout": "cbjones26, i bet lol", 
    "date": "2011-06-10 13:48:42", 
    "profile_url": "http://www.points2shop.com/members/profile/isk8lakai"
 }, 
 {
    "username": "XSJacobK", 
    "honor_level": "New", 
    "country": "US", 
    "shout": "how can i play a game on this points2shop website", 
    "date": "2011-06-10 13:48:40", 
    "profile_url": "http://www.points2shop.com/members/profile/XSJacobK"
 }, 
 {
    "username": "gemini1870", 
    "honor_level": "New", 
    "country": "US", 
    "shout": "is there any difference b/w the 2?", 
    "date": "2011-06-10 13:48:39", 
    "profile_url": "http://www.points2shop.com/members/profile/gemini1870"
 }
]


Offers

You can also search and sort the results returned.

To sort the collection by most popular offers, append ?sort_by=most_recent to the URL. In other words append the HTTP GET parameter sort_by with the value most_popular. An example URL would be http://www.points2shop.com/webservice/offers?sort_by=most_popular. To sort by most recent offers, append the HTTP GET parameter sort_by with the value most_recent. Thus, if you want to sort by most recent, the URL would be http://www.points2shop.com/webservice/offers?sort_by=most_recent.

You can search offers by countries and tags. To search offers by countries include the HTTP GET parameter countries. The value of the countries parameter should be a comma separate list of two letter country codes. For example, to search offers valid in US, UK and Canada the URL would be http://www.points2shop.com/webservice/offers?countries=US,UK,CA.

Similarly, you can search offers by offer tags. To search offers by tags include the HTTP GET parameter tags. The value of the tags parameter should be a comma separate list of tag. For example, to search offers having the tags free and cashback the URL would be http://www.points2shop.com/webservice/offers?tags=free,cashback.

You can mix and match the search and sort options.


Sample response body:

[
{ 
  "description": "All PTC offers in this section can be done every 24 hours. 
    You must click on one link on the landing pages for each PTC offer you do.", 
  "tags": ["daily click", "free"], 
  "countries": ["CA", "UK", "US"], 
  "value": "0.0100", 
  "name": "[DC] 14719 data network affiliates", 
  "completion_url":   "http://www.points2shop.com/offers/action/redirect_offer?offer_id=13539", 
  "offer_details_url": "http://www.points2shop.com/offers/13539/DC-14719-data-network-affiliates",
  "id": "13539", 
  "approval_rate": "121.16",
  "approval_time": 206508
}, 
{
  "description": "Travel Cash team - FREE tour", 
  "tags": ["free", "manual"], 
  "countries": ["US"], 
  "value": "0.3000", 
  "name": "Travel Cash Team (13873)", 
  "completion_url": "http://www.points2shop.com/offers/action/redirect_offer?offer_id=11500", 
   "offer_details_url": "http://www.points2shop.com/offers/11500/Travel-Cash-Team-13873",
  "id": "11500", 
  "approval_rate": "116.67",
  "approval_time": 82175
}
]


Contests


Sample response body:

[
 {"contest_users": [
    {"username": "hidden", "position": 1, "user_id": "hidden", "scoring": "222.08", "team": ""}, 
    {"username": "julyamy", "position": 2, "user_id": 306, "scoring": "197.00", "team": "Example team"}, 
   ], 
  "name": "Referral Contest #2", "end_date": "2008-10-25 00:00:00", "type": 
  "Referrals", "start_date": "2008-09-25 00:00:00", "description": ""
 }
 {"contest_users": [
   ], 
  "name": "Team merits #3", "end_date": "2009-01-02 00:00:00", "type": 
  "Teams Merits", "start_date": "2008-11-20 00:00:00",  "description": ""
 }
]

The contests are returned in descending order of the start date.

You can choose to have a limited number of resources by passing the limit and offset parameters. If you want only ten contest resources to be returned then pass the GET paramter limit with the value 10 in the request.

The API also supports searching contests based on start and end dates. The API supports the following optional HTTP GET parameters:

  • start_date_from - ISO 8601 format. Example 2010-01-31
  • start_date_to - ISO 8601 format. Example 2010-01-31
  • end_date_from - ISO 8601 format. Example 2010-01-31
  • end_date_to - ISO 8601 format. Example 2010-01-31

For example, if you want to search for contests starting between 2011-01-01 and 2011-01-31, the URL will look like:

http://www.points2shop.com/webservice/contests?start_date_from=2011-01-01&start_date_to=2011-01-31

Current Users


Sample response body:

[
  {  u'username': u'karpata', u'honour_level': u'New', 
        u'profile_url': u'http://www.points2shop.com/members/profile/karpata'}, 
  {  u'username': u'Wako954', u'honour_level': u'Platinum', 
        u'profile_url': u'http://www.points2shop.com/members/profile/Wako954'}, 
  {  u'username': u'Matjong', u'honour_level': u'Legend', 
        u'profile_url': u'http://www.points2shop.com/members/profile/Matjong'}
]

Paging

Some resources return large collections. There is a limit set to the number of items in a collection. You can pass the HTTP GET parameters limit and offset to control the number of items and the offset. For example, to have the server return 5 contests starting from 30, send the HTTP GET parameters limit set to 5 and offset to 30. The sample URL will look like:

http://www.points2shop.com/webservice/contests?limit=5&offset=30


Back to API Introduction

Login with your social network:
Log in with your account:



Shoutbox