The BlogCatalog REST (REpresentational State Transfer) API allows the retrieval of public user and blog data based on a set of input parameters. This page outlines the various types of requests that can be executed and provides example requests and responses.
User Information
The getinfo query provides information about a BlogCatalog user.
Input Parameters:
Name |
Data Type |
Required / Optional |
Description |
bcwsid |
string |
Required |
Your BlogCatalog API key. |
username |
string |
Required |
The BlogCatalog user name you are searching for. |
Sample Request:
http://api.blogcatalog.com/getinfo?bcwsid=[apikey]&username=[username]
View Sample Response
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE bcapi PUBLIC "-//BlogCatalog//DTD BCAPI 0.01//EN" "http://api.blogcatalog.com/dtd/bcapi-001.xml">
<bcapi version="1.0">
<result>
<user id="56848">BlogCatalog</user>
<realname>Blog Catalog</realname>
<avatar>http://www.blogcatalog.com/images/default.gif</avatar>
<about/>
<last_login>2007-08-11 12:54:10</last_login>
<weblogs>
<weblog id="4286052">
<name>The BlogCatalog Blog</name>
<url>http://blog.blogcatalog.com</url>
<rssurl>http://feeds.feedburner.com/theblogcatalogblog</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/the-blogcatalog-blog.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/13/4286052.jpg</thumbnailpicture>
<hits>27</hits>
<views>149</views>
<rank>45.667</rank>
<language>English</language>
<country>United States</country>
</weblog>
</weblogs>
<friends>
<user id="56401">AngeldaVinci</user>
<user id="59515">jphillips</user>
<user id="57064">NINE</user>
<user id="13309">SiteProPlus</user>
<user id="50995">thegoodknife</user>
</friends>
<neighborhoods>
<weblog id="4261199">
<name>Andy Beard - Niche Marketing</name>
<url>http://andybeard.eu</url>
<user id="51738">AndyBeard</user>
<rssurl>http://andybeard.eu/feed</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/andy-beard-niche-marketing.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/15/4261199.jpg</thumbnailpicture>
</weblog>
<weblog id="4270001">
<name>Cell Rater</name>
<url>http://www.cellrater.com</url>
<user id="57064">NINE</user>
<rssurl>http://www.cellrater.com/feed/</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/cell-rater.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/12/4270001.jpg</thumbnailpicture>
</weblog>
<weblog id="4296657">
<name>Freelance Folder</name>
<url>http://www.freelancefolder.com</url>
<user id="59515">jphillips</user>
<rssurl>http://freelancefolder.com/feed/</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/freelance-folder.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/13/4296657.jpg</thumbnailpicture>
</weblog>
<weblog id="4284064">
<name>Jonathan Phillips</name>
<url>http://www.jonathan-phillips.com/</url>
<user id="59515">jphillips</user>
<rssurl>http://www.jonathan-phillips.com/feed/</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/jonathan-phillips.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/5/4284064.jpg</thumbnailpicture>
</weblog>
<weblog id="4271463">
<name>Smart Wealthy Rich</name>
<url>http://smartwealthyrich.com/</url>
<user id="59515">jphillips</user>
<rssurl>http://smartwealthyrich.com/feed/</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/smart-wealthy-rich.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/4/4271463.jpg</thumbnailpicture>
</weblog>
</neighborhoods>
</result>
</bcapi>
Blog Information
The bloginfo query provides any data available for a given URL.
Input Parameters:
Name |
Data Type |
Required / Optional |
Description |
bcwsid |
string |
Required |
Your BlogCatalog API key. |
url |
string |
Required |
The BlogCatalog target URL you are searching for. |
Sample Request:
http://api.blogcatalog.com/bloginfo?bcwsid=[apikey]&url=[blog url]
View Sample Response
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE bcapi PUBLIC "-//BlogCatalog//DTD BCAPI 0.01//EN" "http://api.blogcatalog.com/dtd/bcapi-001.xml">
<bcapi version="1.0">
<result>
<weblog id="4286052">
<name>The BlogCatalog Blog</name>
<url>http://blog.blogcatalog.com</url>
<user id="56848">BlogCatalog</user>
<rssurl>http://feeds.feedburner.com/theblogcatalogblog</rssurl>
<bcurl>http://www.blogcatalog.com/blogs/the-blogcatalog-blog.html</bcurl>
<thumbnailpicture>http://www.blogcatalog.com/images/thumbshots/large/13/4286052.jpg</thumbnailpicture>
<categories>
<category>Blog Resources</category>
<category>Blogging</category>
</categories>
<tags>
<tag>annoucements</tag>
<tag>blogcatalog</tag>
<tag>news</tag>
</tags>
<hits>28</hits>
<views>150</views>
<rank>45.667</rank>
<added_on>2007-06-15 08:04:36</added_on>
<last_update/>
<language>English</language>
<country>United States</country>
<review_count>1</review_count>
<reviews>
<review id="78005">
<bcurl>http://www.blogcatalog.com/blogs/the-blogcatalog-blog.html#comment_78005</bcurl>
<rating>10</rating>
<realname>Jonathan-C. Phillips</realname>
<user id="59515">jphillips</user>
<rating_date>2007-06-17 19:01:38</rating_date>
<text_excerpt>It's so cool you guyz now have a blog! Looking forward to reading more posts :)</text_excerpt>
</review>
</reviews>
<neighborhood>
<user id="73556">adtracker</user>
<user id="67647">BlazingZeroDestiny</user>
<user id="61168">ccheesley</user>
<user id="9895">DaneMorgan</user>
<user id="78572">GlobalTravel</user>
<user id="59515">jphillips</user>
<user id="75086">mshepp</user>
<user id="57064">NINE</user>
<user id="73447">plaincook</user>
<user id="65301">rookiebot</user>
<user id="64877">taylorblue</user>
<user id="50995">thegoodknife</user>
<user id="72584">vertito</user>
<user id="55202">WonderWoman</user>
<user id="60186">zublizainordin</user>
</neighborhood>
<recent_viewers>
<user id="71211" last_viewed="2007-08-17 15:01:23">Shinade</user>
<user id="80009" last_viewed="2007-08-17 13:12:47">Gadgeteer</user>
<user id="3367" last_viewed="2007-08-17 13:02:35">lsavant</user>
<user id="75473" last_viewed="2007-08-17 11:09:32">kml</user>
<user id="76382" last_viewed="2007-08-17 10:28:34">onthedivine</user>
<user id="73513" last_viewed="2007-08-17 10:04:20">Joethegamer</user>
<user id="63097" last_viewed="2007-08-17 08:49:51">johnmcowen</user>
<user id="67164" last_viewed="2007-08-17 08:43:22">zigulyte</user>
<user id="81686" last_viewed="2007-08-17 08:19:18">phate13</user>
<user id="72233" last_viewed="2007-08-17 04:09:23">budiwiharto</user>
<user id="64906" last_viewed="2007-08-17 02:52:04">iankennedy</user>
<user id="50995" last_viewed="2007-08-17 01:55:51">thegoodknife</user>
<user id="59515" last_viewed="2007-08-17 00:28:27">jphillips</user>
<user id="68496" last_viewed="2007-08-16 23:03:31">Stinkypaw</user>
</recent_viewers>
</weblog>
</result>
</bcapi>
Response Codes
This section outlines the response codes that can be expected from an API request.
Response Code |
Response Message |
Description |
0 |
OK |
The request completed without errors. |
1 |
Internal Error |
The request could not be proccessed due to an internal system error. |
2 |
Invalid BCWSID |
The request could not be proccessed due to an invalid API key. |
3 |
Exceed daily API limit |
The number of requests executed for a particular API key on a particular day exceeded the specified limit. |
4 |
Invalid Query |
An invalid API request was sent. |
200 |
Invalid username |
The username you requested was not found in our database. |
300 |
Invalid URL |
The URL you requested was not found in our database. |