API usage

Technical information to embed our thumbnails

ThumbSniper's thumbnails can easily be integrated into any website by using a special image URL. The request accepts some options that configure different variants to fit your needs.

Basic URL

This is the base URL. This target is used universally for all requested images:

http://api.thumbsniper.com/v3/thumbnail/{width}/{effect}/?url={URL}

SSL is supported, too:

https://api.thumbsniper.com/v3/thumbnail/{width}/{effect}/?url={URL}

Options

The following options are mandatory and need to be set within the base URL (as shown above):

  • {width}

    Choose the desired with of the requested thumbnail and replace this string with the numeric value. Have a look at the examples page for valid widths.

  • {effect}

    ThumbSniper provides plain miniature thumbnails as well as more advanced styling variants. Have a look at the examples page for available effects.

  • url={URL}

    The URL needs to be the full-qualified address of the target website that you’d like to get as a thumbnail, e.g. "url=http://wordpress.org". The URL parameter should be THE LAST parameter of your request to avoid problems with other optional parameters.

  • waitimg={URL}

    This optional parameter should point to a URL for a custom temporary thumbnail image which is shown instead of the default status image while ThumbSniper processes the thumbnail request.

Example

A simple request looks like this:

http://api.thumbsniper.com/v3/thumbnail/300/plain/?url=https://thumbsniper.com

You may find this complete code snippet even more useful:

<img src="http://api.thumbsniper.com/v3/thumbnail/300/plain/?url=https://thumbsniper.com" alt="ThumbSniper.com" title="ThumbSniper.com" />

This snippet produces a plain image with a width of 300 pixels like this:

ThumbSniper.com

Have a look at the examples section for more effects and sizes!