crawlbaseDocs
Se connecter

Screenshots API

Effectuez le rendu de n'importe quelle URL en PNG ou JPEG. Viewport uniquement ou page complète, desktop ou mobile, avec tous les contrôles de rendu JS de l'API principale. Parfait pour les aperçus, le monitoring et les snapshots.

Migrez vers la Crawling API (ou crawl_screenshot via MCP)

Même pipeline de rendu JS, paramètres de capture d'écran ajoutés sur l'endpoint standard. La Screenshots API autonome est fermée aux nouvelles inscriptions depuis le 1er novembre 2024 : les intégrations existantes continuent de fonctionner, aucune fermeture n'est prévue.

Endpoint

GEThttps://api.crawlbase.com/screenshots?token=YOUR_JS_TOKEN&url=ENCODED_URL
# Requires a JavaScript token (rendering happens in headless Chrome).
# Returns the image bytes directly. Content-Type: image/png (default).

Démarrage rapide

# Save the screenshot to disk
curl 'https://api.crawlbase.com/screenshots?token=YOUR_JS_TOKEN' \
  --data-urlencode 'url=https://github.com/anthropic' \
  -o screenshot.png -G
from crawlbase import ScreenshotsAPI

api = ScreenshotsAPI({'token': 'YOUR_JS_TOKEN'})
res = api.get('https://github.com/anthropic')

with open('screenshot.png', 'wb') as f:
    f.write(res['body'])
const { ScreenshotsAPI } = require('crawlbase');
const fs = require('node:fs/promises');

const api = new ScreenshotsAPI({ token: 'YOUR_JS_TOKEN' });
const res = await api.get('https://github.com/anthropic');
await fs.writeFile('screenshot.png', res.body);

Paramètres

Requis

token
stringrequis
Votre token Crawlbase privé.
url
stringrequis
URL de la page cible. Doit commencer par http ou https et être entièrement URL-encodée.

Spécifiques aux captures d'écran

mode
viewport | fullpageviewport
Capturer uniquement la zone visible, ou la totalité de la page défilable.
format
png | jpegpng
PNG pour un texte et une UI nets ; JPEG pour des charges utiles plus légères sur les pages riches en photos.
width
int (px)1280
Largeur du viewport.
height
int (px)800
Hauteur du viewport. Ignorée lorsque mode=fullpage.
device
desktop | mobiledesktop
Utilisez un profil de périphérique prédéfini. Les préréglages mobile imposent width=375, height=812 et un User-Agent de téléphone.
store
booleanfalse
Conservez la capture d'écran dans Cloud Storage. Lorsque true, la réponse inclut un en-tête screenshot_url pointant vers la copie stockée : utile lorsque vous souhaitez une URL stable à intégrer dans des tableaux de bord ou à partager avec des systèmes en aval.

Contrôle du rendu

Hérités du jeu de paramètres de la Crawling API. Les contrôles de rendu les plus utilisés avec les captures d'écran :

user_agent
stringoptionnel
User-Agent personnalisé transmis tel quel au site cible. URL-encodez-le. Si omis, Crawlbase fait tourner un UA réaliste à chaque requête.
css_click_selector
stringoptionnel
Sélecteur CSS d'un élément à cliquer avant la capture de l'écran (#some-button, .some-other-button). URL-encodez la valeur.
scroll
booleanfalse
Défilement automatique de la page avant la capture. Par défaut, défilement de 10 secondes. À combiner avec scroll_interval (10 à 60 s) pour le prolonger. Utile pour le contenu chargé en lazy-loading au-dessus de la ligne de flottaison d'une capture mode=fullpage.
page_wait
integer (ms)optionnel
Attendez ce nombre de millisecondes après le chargement de la page avant la capture : cela laisse le temps aux animations ou aux rendus JS lourds de se stabiliser.
ajax_wait
booleanfalse
Attendre la fin des requêtes AJAX en cours avant la capture.
country
ISO 3166optionnel
Géolocalisez la capture d'écran depuis un pays spécifique (par ex. US, GB, DE). La disponibilité des pays dépend du plan ; la liste complète des pays se trouve dans la référence des paramètres de la Crawling API.

Modèles courants

Capture d'écran mobile en page complète

curl 'https://api.crawlbase.com/screenshots?token=YOUR_JS_TOKEN' \
  --data-urlencode 'url=https://news.ycombinator.com' \
  --data-urlencode 'mode=fullpage' \
  --data-urlencode 'device=mobile' \
  --data-urlencode 'format=jpeg' \
  -o hn-mobile.jpg -G

Capture d'écran après un clic

# Open a "Show details" panel before capturing
curl 'https://api.crawlbase.com/screenshots?token=YOUR_JS_TOKEN' \
  --data-urlencode 'url=https://example.com/product/123' \
  --data-urlencode 'css_click_selector=button.show-details' \
  --data-urlencode 'page_wait=1500' \
  -o detail.png -G

Cas d'usage courants

  • Aperçus de liens : générez des fallbacks Open Graph pour les sites sans balises meta appropriées.
  • Monitoring visuel : capturez un site chaque semaine pour détecter les régressions de mise en page.
  • Archives de conformité : associez à Cloud Storage pour archiver l'apparence d'une page à une date précise.
  • Rapports par e-mail : intégrez des captures d'écran en direct dans des rapports programmés.