Request Options

Request options and parameters can be in any order.

Manditory request options and parameters:

uri

Target web page address. A URI target with a query string should be encoded to prevent the API from accidentally parsing it.

apikey

Your account identifier, sign up to get one.

token

The security token md5 hash. md5( secret + uri + size ).

Optional parameters:

size

Width x Height (pixels). '336x336' will return a perfect cropped square screenshot image. We always maintain proportions when we scale. Use 'original' to request the raw uncropped image.

delay

Wait an amount of time in milliseconds after the DOM Loaded event before taking the screenshot. Default delay is 1200.

Some webpages use long loading Javascript or Flash elements which occur well after the DOM loaded event. In order to take a proper screenshot of these pages, we needed to introduce a delay. Delay slows the whole process down so only use it as a last resort.

viewport

Set a custom viewport size in pixels. For example use 400 for a mobile device resolution. Default viewport is 1024.

Example: viewport and screenshots

ttl

Time-to-live in seconds of the cached screenshot. Default ttl is 86400 or one day.

  https://linkpeek.com/api/v1?uri=[target]&apikey=[your key]&token=[md5(secret+uri+size)]&size=[Width x Height]
  

  https://linkpeek.com/api/v1?uri=https%3A//westworld2.com&apikey=9fhvyH9KP&token=fdc78c722fae1f12eb1c90c04e474871&size=300x150