Docs menu
Screenshot API

thumbs_ready.php

Tells you whether a capture exists, as JSON. If it doesn't, it starts the render, just as thumbs.php does.

GEThttps://api.pagepeeker.com/v2/thumbs_ready.php?size=size&url=url&code=code

Parameters

ParameterDescription
urlrequired

The page, as you send it to thumbs.php.

sizerequired

t 90 x 68, s 120 x 90, m 200 x 150, l 400 x 300 or x 480 x 360. Premium accounts can have other sizes.

coderequired

Your API key. Keep it on your server: anyone who sees it can spend your API calls. How accounts are identified covers the one case that goes without it.

Response

FieldMeaning
IsReady1 if a capture can be downloaded, otherwise 0.
Error1 if the capture failed or the request was refused, otherwise 0.
ErrorMessageWhy the request was refused. Only on refused requests; the same text is in the X-PP-Error-Message header.
Response
// Still rendering
{"IsReady":0,"Error":0}

// Ready to download
{"IsReady":1,"Error":0}

// The page could not be captured
{"IsReady":0,"Error":1}

// The request was refused
{"IsReady":0,"Error":1,"ErrorMessage":"Unknown code"}
NoteIsReady is 1 for any capture on file, including an expired one that is being rendered again. To know a new capture has arrived, read Getting a fresh capture.

Each check counts as one API call, so leave a few seconds between them.