Developer Documentation

Welcome to the developer documentation for the Faviconiac API! The Faviconiac API lets you embed (almost) any website's favicon on your webpage without anything but an img HTML tag. The service creates a PNG image based on URL parameters sent through a standard HTTP request and returns the image you can display on your web page.

A quick example

The following example contains the URL of the Google's favicon, which is displayed below:

<img src="http://www.faviconiac.com/favicon/google.com" alt="Google" /> will show: Google

Contents

  1. Audience
  2. Usage limits
  3. Overview
  4. URL Parameters
  5. Terms of use

Audience

This document is intended for developers who want to include website's favicons within a webpage. It provides an introduction to using the API and reference material on the available parameters.

Usage limits

This limit is enforced to prevent abuse and/or repurposing of the Faviconiac API, and this limit may be changed in the future without notice. If you abuse the service the Faviconiac API may stop working for you.

Overview

The Faviconiac API displays a 16x16 PNG image in response to a HTTP request via a URL. For each request, you can specify the domain of the site.

You embed the image within a webpage inside an tag's img attribute. When the webpage is displayed, the browser requests the image from the the Faviconiac server.

This document describes the required format of Faviconiac API URLs and the available parameters.

URL Parameters

A Faviconiac API URL must be of the following form:

http://www.faviconiac.com/favicon/domain/ (i.e. http://www.faviconiac.com/favicon/yahoo.com/)

There is also a special HTTP request to suggest Faviconiac update a favicon.

http://www.faviconiac.com/ping/domain/ (i.e. http://www.faviconiac.com/ping/ask.com/)

Terms of use

Faviconiac API is free for both commercial and non-commercial purposes that don't exceed the restrictions. However Faviconiac reserves the right to charge fees for the use of Faviconiac API for some kind of commercial applications and over certain bandwidth limits.