Plans and credits

A capture costs 1 credit. Some options add more. Send them on the screenshot endpoints as query parameters or JSON, including /v3/screenshot and the earlier /, /screenshot, and /v2/screenshot paths. Leave a field out and that part of the capture stays unchanged.

The prices and monthly allowances are on the pricing page. This page lists which option each plan can use.

OptionWho can use itExtra credits
proxyFree, Essential, Startup, Growth, Business0
classic_proxyEssential, Startup, Growth, Business0
extract_html, extract_text, extract_markdownEssential, Startup, Growth, Business0
get_image_urlsFree, Essential, Startup, Growth, Business0
premium_proxyStartup, Growth, Business4
video, scrolling_screenshot, multiple_scrolling, or a file_type of mp4, webm, or gifStartup, Growth, Business0
solve_captchaGrowth, Business3, when solve_captcha is on and the capture succeeds
gpuGrowth, Business2
stealthFree, Essential, Startup, Growth, Business0

country chooses the exit for a or proxy. Your own proxy ignores it.

Extras add up. Growth or Business with gpu=true and premium_proxy=true is 1 + 2 + 4 = 7 credits.

The Free plan has 100 credits a month and 10 requests a minute. A credit plan spends the monthly allowance first. Startup, Growth, and Business can continue into overage until the cap on the pricing page. Free and Essential stop at the allowance.

Hashtag
Timeout

timeout is the longest the request will wait, in milliseconds. If you leave it out, the request uses your plan's maximum. A higher value is rejected.

  • Free and Essential: 30 seconds
  • Startup: 60 seconds
  • Growth: 90 seconds
  • Business: 100 seconds

Hashtag
Errors

On /v2 and /v3 the body includes error and message. On / and /screenshot the body is { "error": "..." } with the message below.

  • 403 Your plan does not include classic proxies. The same kind of message is used for premium proxies, text and HTML extraction, scrolling video, captcha solving, GPU rendering, and stealth.
  • 403 Your plan allows a timeout up to N seconds.
  • 403 You're out of free screenshots. Please upgrade.
  • 403 You're out of credits for the month.
  • 429 You've reached your rpm, please contact support to raise that limit.

Hashtag
Example

{
  "url": "https://example.com",
  "classic_proxy": true,
  "gpu": true,
  "solve_captcha": true,
  "captcha_image": "#captcha-img",
  "captcha_input": "#captcha-input",
  "captcha_submit": "#captcha-submit"
}