• Chirpio API Documentation

Chirpio API Documentation


Have a Twitter app or web site? 

Use the Chirpio API to let Twitter users rate each other through your app or web site.  You can also retrieve the current ratings and score of any Twitter user that has been rated on Chirpio.

The Chirpio API is completely free to use and there are currently no quotas or API keys required during our beta phase.  Hopefully we can keep this policy moving forward as well...

back to chirpio.com

METHOD: rate

http://www.chirpio.com/api/rate

Use this method to rate a twitter user as good, bad, or spam on Chirpio.

Request fields

(POST data):

  • username (required) - Twitter username
  • password (required) - Twitter password
  • rating (required) - the rating value (1=good, 2=bad, 4=spam)
  • ratedid (required) - the Twitter userid for the user that is being rated
  • unrate (optional) - set this value to 1 if you are unrating the user (ie, undoing the given rating)

Sample response:

<?xml version="1.0" encoding="UTF-8"?>
<rsp status="ok">
 <ratedid>123456</ratedid>
</rsp>

Sample error response:

<?xml version="1.0" encoding="UTF-8"?>
<rsp status="fail">
 <err code="1001" msg="Invalid twitter username or password" />
</rsp>

Error codes and their descriptions:

1001 - Invalid twitter username or password
1002 - You must follow this user before you can rate them
1003 - Invalid rating
1004 - Invalid twitter userid


METHOD: getScore

http://www.chirpio.com/api/getScore

Use this method to retrieve a user's score and ratings info on Chirpio.
The score field ranges from 0-100 and will be 'n/a' if there are not enough votes.
On average, scores below 50 are considered bad and above 75 are considered good.

Request fields

(GET data):

  • userid (required) - the Twitter userid

Sample response:

<?xml version="1.0" encoding="UTF-8"?>
<rsp status="ok">
 <score>95</score>
 <count_good>25</count_good>
 <count_bad>1</count_bad>
 <count_spam>0</count_spam>
</rsp>

Sample error response:

<?xml version="1.0" encoding="UTF-8"?>
<rsp status="fail">
 <err code="1001" msg="No score was found for this user" />
</rsp>

Error codes and their descriptions:

1001 - No score was found for this user


back to chirpio.com