• About
• API Docs

API Documentation

The BorURL service is complete with an XML-based API for developers.

Features

• Generate or get existing short URLs, with sequential or custom keyword
• Get some statistics about your links: top clicked links, least clicked links, newest links
• Output format: JSON, XML, or simple raw text

Synopsis

You need to send parameters to http://borurl.com/api either via GET or POST. These parameters are:

• The requested action: "shorturl" (get short URL for a link), "expand" (get long URL of a shorturl) or "stats" (get stats about your links)
• With action = "shorturl" :
  • the url to shorten
  • optional keyword for custom short URLs
  • output format: either "json", "xml" or "simple"
• With action = "expand" :
  • the shorturl to expand (can be either 'abc' or 'http://domain.com/abc')
  • output format: either "json", "xml" or "simple"
• With action = "stats" :
  • the filter: either "top", "bottom" , "rand" or "last"
  • the limit (maximum number of links to return)
  • output format: either "json" or "xml"

Sample XML Response

<result>
  <url>
    <id>62019439011</id>
    <keyword>shorter</keyword>
    <url>http://somereallylongurlyouneedtoshrink.com/</url>
    <date>2009-06-23 18:08:07</date>
    <ip>127.0.0.1</ip>
  </url>
  <status>success</status>
  <message>http://somereallylongurlyouneedtoshrink.com/ (ID: shorter) added to database</message>
  <shorturl>http://borurl.com/shorter</shorturl>
</result>