Website Screenshot API

GET

https://api.apifreaks.com/v1.0/screenshot

urlStringrequired
The URL of the website to screenshot.
Options

Sample Responses

400
406
408
LANGUAGE
Python
PHP
Java
Node
Ruby
$ pip install requests
RESPONSE

Click Test it to start the request and see the response here!


API Response

FieldTypeRequirementDescription
screenshotStringMandatory
Specifies the file type for the output.
urlStringMandatory
The original URL that was captured.
created_atStringMandatory
Timestamp when the screenshot was created (ISO 8601 format).
formatStringMandatory
Response format type.
ttlStringMandatory
Time until the screenshot expires (ISO 8601 format).
file_typeStringOptional
The file type of the output.
url.extracted_htmlStringOptional
URL of the extracted HTML from the webpage
omit_backgroundBooleanOptional
Whether background was removed (true/false).
destroy_screenshotBooleanOptional
Whether the screenshot was destroyed after generation (true/false).
fail_on_errorBooleanOptional
Whether the request failed on error (true/false).
longitudeNumberOptional
The longitude value used for geolocation.
latitudeNumberOptional
The latitude value used for geolocation.
proxyStringOptional
The proxy configuration used for the request.
no_cookie_bannersBooleanOptional
Whether cookie banners were blocked (true/false).
block_adsBooleanOptional
Whether ads were blocked (true/false).
headersStringOptional
The custom headers that were included in the request.
cookiesStringOptional
The cookies that were included in the request.
scroll_to_elementStringOptional
The element that was scrolled to before rendering.
selectorStringOptional
The element that was selected for rendering.
blur_selectorStringOptional
The elements that were blurred in the output.
remove_selectorStringOptional
The elements that were removed from the output.
cssStringOptional
The custom CSS that was injected into the page.
css_urlStringOptional
The external CSS URL that was loaded.
jsStringOptional
The custom JavaScript that was injected.
js_urlStringOptional
The external JavaScript URL that was loaded.
ttlNumberOptional
The cache duration that was set in seconds.
user_agentStringOptional
The User-Agent string that was used.
accept_languagesStringOptional
The Accept-Language header that was used.
delayNumberOptional
The delay duration that was applied in milliseconds.
thumbnail_widthNumberOptional
The thumbnail width that was used in pixels.
outputStringOptional
The output type that was used.
freshBooleanOptional
Whether a fresh render was performed (true/false).
enable_cachingBooleanOptional
Whether caching was enabled (true/false).
lazy_loadBooleanOptional
Whether lazy loading was triggered (true/false).
full_pageBooleanOptional
Whether full page capture was used (true/false).
retinaBooleanOptional
Whether retina capture was used (true/false).
heightNumberOptional
The viewport height that was used in pixels.
widthNumberOptional
The viewport width that was used in pixels.
custom_htmlStringOptional
The custom HTML content that was rendered.
block_chat_widgetsBooleanOptional
Whether chat widgets were blocked (true/false).
block_jsBooleanOptional
Whether JavaScript was blocked (true/false).
block_stylesheetsBooleanOptional
Whether stylesheets were blocked (true/false).
block_imagesBooleanOptional
Whether images were blocked (true/false).
block_mediaBooleanOptional
Whether media files were blocked (true/false).
block_fontsBooleanOptional
Whether fonts were blocked (true/false).
block_text_trackBooleanOptional
Whether text tracks were blocked (true/false).
block_xhrBooleanOptional
Whether XHR requests were blocked (true/false).
block_fetchBooleanOptional
Whether Fetch API requests were blocked (true/false).
block_event_sourceBooleanOptional
Whether EventSource connections were blocked (true/false).
block_web_socketBooleanOptional
Whether WebSocket connections were blocked (true/false).
block_manifestBooleanOptional
Whether manifest files were blocked (true/false).
block_specific_requestsStringOptional
The specific requests that were blocked.
adjust_topNumberOptional
The vertical position that was scrolled to in pixels.
image_qualityNumberOptional
The image quality level that was applied.
extract_htmlBooleanOptional
Whether HTML content was extracted (true/false).
extract_textBooleanOptional
Whether text content was extracted (true/false).
dark_modeBooleanOptional
Whether dark mode was enabled (true/false).
block_trackingBooleanOptional
Whether tracking scripts were blocked (true/false).
wait_for_eventStringOptional
The event that triggered the rendering to start.
grayscaleNumberOptional
The grayscale level that was applied (0-100).
clipobjectOptional
The dimensions of the clipped area that was captured.
result_file_nameStringOptional
The final filename used for the output file.
incognito_modeBooleanOptional
Whether incognito mode was enabled (true/false).
timeoutNumberOptional
The actual timeout duration that was applied in milliseconds.
scrolling_screenshotBooleanOptional
Whether scrolling screenshot mode was enabled (true/false).
multiple_scrollingBooleanOptional
Whether multiple scrolling captures were performed (true/false).
sizesArrayOptional
The dimensions used for each capture in the array.
scroll_speedStringOptional
The scroll speed that was applied during capture.
durationNumberOptional
The actual duration of the scrolling capture in seconds.
scroll_backBooleanOptional
Whether the scroll back feature was enabled (true/false).
start_immediatelyBooleanOptional
Whether immediate recording was enabled (true/false).